{ "info": { "_postman_id": "8185c140-7903-4a8d-8b42-50bd242460f0", "name": "Square ApplePay Loyalty API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:04:02.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "lastUpdatedBy": "35240", "uid": "35240-8185c140-7903-4a8d-8b42-50bd242460f0" }, "item": [ { "name": "v2", "item": [ { "name": "loyalty", "item": [ { "name": "accounts", "item": [ { "name": "search", "item": [ { "name": "Square Search Loyalty Accounts", "id": "814f4049-c9e3-4124-94d7-a0e9edb8bf56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"mappings\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n }\n ],\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", "search" ] }, "description": "Searches for loyalty accounts in a loyalty program.\n\nYou can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely.\n\nSearch results are sorted by `created_at` in ascending order." }, "response": [ { "id": "f6b4a949-30a1-431f-8860-b5bb8dcc3cec", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"mappings\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n }\n ],\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"UNSUPPORTED_CARD_BRAND\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"PLAID_ERROR\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_accounts\": [\n {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n },\n {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-f6b4a949-30a1-431f-8860-b5bb8dcc3cec" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-814f4049-c9e3-4124-94d7-a0e9edb8bf56" } ], "id": "0b6393d8-dd1d-4d63-88af-2cecda34cdd2", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-0b6393d8-dd1d-4d63-88af-2cecda34cdd2" }, { "name": "{account_id}", "item": [ { "name": "accumulate", "item": [ { "name": "Square Accumulate Loyalty Points", "id": "204a4e8d-c344-4834-a66b-16e39c4ae8a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"idempotency_key\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id/accumulate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id", "accumulate" ], "variable": [ { "id": "4b029749-52f5-4ecf-9a0a-4e26dddb31c1", "key": "account_id", "value": "", "description": "(Required) The ID of the target [loyalty account](entity:LoyaltyAccount)." } ] }, "description": "Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points)." }, "response": [ { "id": "32bc963c-742d-4014-a0e3-9e7daf158faf", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"idempotency_key\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id/accumulate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id", "accumulate" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CARD_TOKEN_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"VOICE_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"event\": {\n \"id\": \"\",\n \"type\": \"ADJUST_POINTS\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n },\n \"events\": [\n {\n \"id\": \"\",\n \"type\": \"CREATE_REWARD\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"LOYALTY_API\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"DELETE_REWARD\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-32bc963c-742d-4014-a0e3-9e7daf158faf" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-204a4e8d-c344-4834-a66b-16e39c4ae8a8" } ], "id": "14a9d6eb-ed39-4519-b067-25f3dd6abd00", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-14a9d6eb-ed39-4519-b067-25f3dd6abd00" }, { "name": "adjust", "item": [ { "name": "Square Adjust Loyalty Points", "id": "b044d548-18ce-4628-b1d2-5ece5cbf0a6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"allow_negative_balance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id/adjust", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id", "adjust" ], "variable": [ { "id": "181cfc13-aa31-4d07-a775-f6a817ac6548", "key": "account_id", "value": "", "description": "(Required) The ID of the target [loyalty account](entity:LoyaltyAccount)." } ] }, "description": "Adds points to or subtracts points from a buyer's account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)\nto add points when a buyer pays for the purchase." }, "response": [ { "id": "9ea5f1c4-fb3b-4901-92b3-3e38fdbcd344", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"allow_negative_balance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id/adjust", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id", "adjust" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"APPLE_TTP_PIN_TOKEN\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"event\": {\n \"id\": \"\",\n \"type\": \"DELETE_REWARD\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-9ea5f1c4-fb3b-4901-92b3-3e38fdbcd344" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-b044d548-18ce-4628-b1d2-5ece5cbf0a6c" } ], "id": "09430ad1-2663-44f0-8784-576d30648420", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-09430ad1-2663-44f0-8784-576d30648420" }, { "name": "Square Retrieve Loyalty Account", "id": "5f872846-3803-42c3-b34c-a871b7909f84", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id" ], "variable": [ { "id": "07ea4600-7e2e-43c4-8f4b-7b7576d96213", "key": "account_id", "value": "", "description": "(Required) The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve." } ] }, "description": "Retrieves a loyalty account." }, "response": [ { "id": "d691e2b6-7c79-4150-8a94-cbff96df8413", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"CARD_PROCESSING_NOT_ENABLED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"V1_APPLICATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_account\": {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-d691e2b6-7c79-4150-8a94-cbff96df8413" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-5f872846-3803-42c3-b34c-a871b7909f84" } ], "id": "9249b7d0-c42c-4202-9030-36bac845dcc5", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-9249b7d0-c42c-4202-9030-36bac845dcc5" }, { "name": "Square Create Loyalty Account", "id": "5eb3e51c-a2e0-42a6-93d4-fdd1d5d7d96d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_account\": {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts" ] }, "description": "Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer." }, "response": [ { "id": "6e366188-5f50-4f93-8d62-1dd6c71bd9a5", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_account\": {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"PLAID_ERROR\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"ADDRESS_VERIFICATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_account\": {\n \"program_id\": \"\",\n \"id\": \"\",\n \"balance\": \"\",\n \"lifetime_points\": \"\",\n \"customer_id\": \"\",\n \"enrolled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"mapping\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"phone_number\": \"\"\n },\n \"expiring_point_deadlines\": [\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"points\": \"\",\n \"expires_at\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-6e366188-5f50-4f93-8d62-1dd6c71bd9a5" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-5eb3e51c-a2e0-42a6-93d4-fdd1d5d7d96d" } ], "id": "07d47d68-5f84-465f-966d-6407774fe4c0", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-07d47d68-5f84-465f-966d-6407774fe4c0" }, { "name": "events", "item": [ { "name": "search", "item": [ { "name": "Square Search Loyalty Events", "id": "c670a6e8-4984-4d35-a63a-ef4b620ba20c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"filter\": {\n \"loyalty_account_filter\": {\n \"loyalty_account_id\": \"\"\n },\n \"type_filter\": {\n \"types\": [\n \"DELETE_REWARD\",\n \"REDEEM_REWARD\"\n ]\n },\n \"date_time_filter\": {\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n },\n \"location_filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ]\n },\n \"order_filter\": {\n \"order_id\": \"\"\n }\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/events/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "events", "search" ] }, "description": "Searches for loyalty events.\n\nA Square loyalty program maintains a ledger of events that occur during the lifetime of a\nbuyer's loyalty account. Each change in the point balance\n(for example, points earned, points redeemed, and points expired) is\nrecorded in the ledger. Using this endpoint, you can search the ledger for events.\n\nSearch results are sorted by `created_at` in descending order." }, "response": [ { "id": "635795a5-b24d-4ec3-89f3-ed692f5bdd91", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"filter\": {\n \"loyalty_account_filter\": {\n \"loyalty_account_id\": \"\"\n },\n \"type_filter\": {\n \"types\": [\n \"DELETE_REWARD\",\n \"REDEEM_REWARD\"\n ]\n },\n \"date_time_filter\": {\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n },\n \"location_filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ]\n },\n \"order_filter\": {\n \"order_id\": \"\"\n }\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/events/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "events", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CARD_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"INSUFFICIENT_PERMISSIONS_FOR_REFUND\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"events\": [\n {\n \"id\": \"\",\n \"type\": \"OTHER\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"ADJUST_POINTS\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-635795a5-b24d-4ec3-89f3-ed692f5bdd91" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-c670a6e8-4984-4d35-a63a-ef4b620ba20c" } ], "id": "019d6dfb-53a8-4353-9d5d-f8cb7bc57e40", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-019d6dfb-53a8-4353-9d5d-f8cb7bc57e40" } ], "id": "6eff3622-b4cd-4f3e-a624-fc9882f729ab", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-6eff3622-b4cd-4f3e-a624-fc9882f729ab" }, { "name": "programs", "item": [ { "name": "{program_id}", "item": [ { "name": "calculate", "item": [ { "name": "Square Calculate Loyalty Points", "id": "db07a59b-afab-4865-aa17-5a4b85124416", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"order_id\": \"\",\n \"transaction_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BMD\"\n },\n \"loyalty_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/calculate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "calculate" ], "variable": [ { "id": "d20b6318-675f-441d-832c-39fc0053a535", "key": "program_id", "value": "", "description": "(Required) The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points." } ] }, "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points)." }, "response": [ { "id": "26fc5060-eb8e-4b6c-8a4a-6446cdb2fa14", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"order_id\": \"\",\n \"transaction_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BMD\"\n },\n \"loyalty_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/calculate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "calculate" ], "variable": [ { "key": "program_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"ACCOUNT_UNUSABLE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_EMAIL_ADDRESS\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"points\": \"\",\n \"promotion_points\": \"\"\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-26fc5060-eb8e-4b6c-8a4a-6446cdb2fa14" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-db07a59b-afab-4865-aa17-5a4b85124416" } ], "id": "958970b5-5e05-4b3c-8c8d-4fd83115a997", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-958970b5-5e05-4b3c-8c8d-4fd83115a997" }, { "name": "promotions", "item": [ { "name": "{promotion_id}", "item": [ { "name": "cancel", "item": [ { "name": "Square Cancel Loyalty Promotion", "id": "e610ecea-bf51-41f9-ba80-66e0121cdfac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions/:promotion_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions", ":promotion_id", "cancel" ], "variable": [ { "id": "cc5582b4-6bf0-483a-bf65-4209474cd854", "key": "program_id", "value": "", "description": "(Required) The ID of the base [loyalty program](entity:LoyaltyProgram)." }, { "id": "b24aa940-fd3f-46d5-a6c3-8f589613e8e8", "key": "promotion_id", "value": "", "description": "(Required) The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status." } ] }, "description": "Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the\nend date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion.\nBecause updating a promotion is not supported, you can also use this endpoint to cancel a promotion before\nyou create a new one.\n\nThis endpoint sets the loyalty promotion to the `CANCELED` state" }, "response": [ { "id": "ac220293-c4af-40c0-9eca-ffc6e6e8686e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions/:promotion_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions", ":promotion_id", "cancel" ], "variable": [ { "key": "program_id" }, { "key": "promotion_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"UNKNOWN_QUERY_PARAMETER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_promotion\": {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_ADDITION\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"DAY\"\n },\n \"status\": \"SCHEDULED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"ZAR\"\n },\n \"qualifying_item_variation_ids\": [\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-ac220293-c4af-40c0-9eca-ffc6e6e8686e" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-e610ecea-bf51-41f9-ba80-66e0121cdfac" } ], "id": "1d06c22f-0ff8-4c32-b6b2-18b884690cfc", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-1d06c22f-0ff8-4c32-b6b2-18b884690cfc" }, { "name": "Square Retrieve Loyalty Promotion", "id": "f720e4ab-f537-495d-bb02-1a92485fc141", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions/:promotion_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions", ":promotion_id" ], "variable": [ { "id": "aa0813e7-4868-48dd-894c-c1705de4b6cb", "key": "program_id", "value": "", "description": "(Required) The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword." }, { "id": "9c69ce69-e634-4df8-9ca8-864ed4eddb80", "key": "promotion_id", "value": "", "description": "(Required) The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve." } ] }, "description": "Retrieves a loyalty promotion." }, "response": [ { "id": "d9068e8f-3378-4ad7-ba72-31a1e42649fa", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions/:promotion_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions", ":promotion_id" ], "variable": [ { "key": "program_id" }, { "key": "promotion_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_DATE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_promotion\": {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_ADDITION\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"ALL_TIME\"\n },\n \"status\": \"SCHEDULED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BTN\"\n },\n \"qualifying_item_variation_ids\": [\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-d9068e8f-3378-4ad7-ba72-31a1e42649fa" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-f720e4ab-f537-495d-bb02-1a92485fc141" } ], "id": "4f66724c-9aa6-4d53-bd11-d4fb7d06407d", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-4f66724c-9aa6-4d53-bd11-d4fb7d06407d" }, { "name": "Square List Loyalty Promotions", "id": "6a5b3b91-1b4f-4bf3-b3d2-c41161901bce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions?status=ENDED&cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions" ], "query": [ { "description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned.", "key": "status", "value": "ENDED" }, { "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "limit", "value": "" } ], "variable": [ { "id": "9184bb6f-5da8-4912-9b6d-b310d1692334", "key": "program_id", "value": "", "description": "(Required) The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword." } ] }, "description": "Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest)." }, "response": [ { "id": "69d424ce-0f7e-459d-ad87-1ce73a98bc8a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions?status=ENDED&cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions" ], "query": [ { "description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned.", "key": "status", "value": "ENDED" }, { "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "limit", "value": "" } ], "variable": [ { "key": "program_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"CARD_DECLINED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_promotions\": [\n {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_MULTIPLIER\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"DAY\"\n },\n \"status\": \"CANCELED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"HNL\"\n },\n \"qualifying_item_variation_ids\": [\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\"\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-69d424ce-0f7e-459d-ad87-1ce73a98bc8a" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-6a5b3b91-1b4f-4bf3-b3d2-c41161901bce" }, { "name": "Square Create Loyalty Promotion", "id": "37ac497f-a7af-4eb0-8912-d58f831d4db4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_promotion\": {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_ADDITION\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"DAY\"\n },\n \"status\": \"CANCELED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"COP\"\n },\n \"qualifying_item_variation_ids\": [\n \"\",\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\",\n \"\"\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions" ], "variable": [ { "id": "3e5c02de-4100-4294-b960-cab870f32611", "key": "program_id", "value": "", "description": "(Required) The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)\nusing the `main` keyword." } ] }, "description": "Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status." }, "response": [ { "id": "52f63a81-5747-46c6-9a78-3f3d7ec71e19", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_promotion\": {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_ADDITION\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"DAY\"\n },\n \"status\": \"CANCELED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"COP\"\n },\n \"qualifying_item_variation_ids\": [\n \"\",\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\",\n \"\"\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id/promotions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id", "promotions" ], "variable": [ { "key": "program_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"PLAID_ERROR_ITEM_LOGIN_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"loyalty_promotion\": {\n \"name\": \"\",\n \"incentive\": {\n \"type\": \"POINTS_ADDITION\",\n \"points_multiplier_data\": {\n \"points_multiplier\": \"\",\n \"multiplier\": \"\"\n },\n \"points_addition_data\": {\n \"points_addition\": \"\"\n }\n },\n \"available_time\": {\n \"time_periods\": [\n \"\"\n ],\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"id\": \"\",\n \"trigger_limit\": {\n \"times\": \"\",\n \"interval\": \"DAY\"\n },\n \"status\": \"SCHEDULED\",\n \"created_at\": \"\",\n \"canceled_at\": \"\",\n \"updated_at\": \"\",\n \"loyalty_program_id\": \"\",\n \"minimum_spend_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GIP\"\n },\n \"qualifying_item_variation_ids\": [\n \"\"\n ],\n \"qualifying_category_ids\": [\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-52f63a81-5747-46c6-9a78-3f3d7ec71e19" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-37ac497f-a7af-4eb0-8912-d58f831d4db4" } ], "id": "0ce1c212-1adf-4c40-b086-4194078331cd", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-0ce1c212-1adf-4c40-b086-4194078331cd" }, { "name": "Square Retrieve Loyalty Program", "id": "905052eb-699e-4f24-879c-e95116c52ed3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id" ], "variable": [ { "id": "1ddff02e-921a-4d6b-8c93-18e182d1f100", "key": "program_id", "value": "", "description": "(Required) The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller." } ] }, "description": "Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.\n\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview)." }, "response": [ { "id": "2e0ae7aa-7eeb-48e9-bce8-c5efd512f12c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs/:program_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs", ":program_id" ], "variable": [ { "key": "program_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"API_VERSION_INCOMPATIBLE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"program\": {\n \"id\": \"\",\n \"status\": \"INACTIVE\",\n \"reward_tiers\": [\n {\n \"points\": \"\",\n \"pricing_rule_reference\": {\n \"object_id\": \"\",\n \"catalog_version\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"definition\": {\n \"scope\": \"CATEGORY\",\n \"discount_type\": \"FIXED_PERCENTAGE\",\n \"percentage_discount\": \"\",\n \"catalog_object_ids\": [\n \"\"\n ],\n \"fixed_discount_money\": {\n \"amount\": \"\",\n \"currency\": \"LRD\"\n },\n \"max_discount_money\": {\n \"amount\": \"\",\n \"currency\": \"PAB\"\n }\n },\n \"created_at\": \"\"\n }\n ],\n \"expiration_policy\": {\n \"expiration_duration\": \"\"\n },\n \"terminology\": {\n \"one\": \"\",\n \"other\": \"\"\n },\n \"location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accrual_rules\": [\n {\n \"accrual_type\": \"VISIT\",\n \"points\": \"\",\n \"visit_data\": {\n \"tax_mode\": \"BEFORE_TAX\",\n \"minimum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"VND\"\n }\n },\n \"spend_data\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XOF\"\n },\n \"tax_mode\": \"BEFORE_TAX\",\n \"excluded_category_ids\": [\n \"\"\n ],\n \"excluded_item_variation_ids\": [\n \"\"\n ]\n },\n \"item_variation_data\": {\n \"item_variation_id\": \"\"\n },\n \"category_data\": {\n \"category_id\": \"\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-2e0ae7aa-7eeb-48e9-bce8-c5efd512f12c" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-905052eb-699e-4f24-879c-e95116c52ed3" } ], "id": "6705059a-a89b-448b-b88b-378fc1ee3de1", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-6705059a-a89b-448b-b88b-378fc1ee3de1" }, { "name": "Square List Loyalty Programs", "id": "3b7262f1-08bb-4a2b-971c-7e2b6d74fede", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs" ] }, "description": "Returns a list of loyalty programs in the seller's account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`." }, "response": [ { "id": "e02ee346-6787-47ac-a107-82bb81697705", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/programs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "programs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"TEMPORARY_ERROR\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"programs\": [\n {\n \"id\": \"\",\n \"status\": \"ACTIVE\",\n \"reward_tiers\": [\n {\n \"points\": \"\",\n \"pricing_rule_reference\": {\n \"object_id\": \"\",\n \"catalog_version\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"definition\": {\n \"scope\": \"CATEGORY\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage_discount\": \"\",\n \"catalog_object_ids\": [\n \"\"\n ],\n \"fixed_discount_money\": {\n \"amount\": \"\",\n \"currency\": \"KZT\"\n },\n \"max_discount_money\": {\n \"amount\": \"\",\n \"currency\": \"HRK\"\n }\n },\n \"created_at\": \"\"\n }\n ],\n \"expiration_policy\": {\n \"expiration_duration\": \"\"\n },\n \"terminology\": {\n \"one\": \"\",\n \"other\": \"\"\n },\n \"location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accrual_rules\": [\n {\n \"accrual_type\": \"SPEND\",\n \"points\": \"\",\n \"visit_data\": {\n \"tax_mode\": \"AFTER_TAX\",\n \"minimum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"DJF\"\n }\n },\n \"spend_data\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"LVL\"\n },\n \"tax_mode\": \"BEFORE_TAX\",\n \"excluded_category_ids\": [\n \"\"\n ],\n \"excluded_item_variation_ids\": [\n \"\"\n ]\n },\n \"item_variation_data\": {\n \"item_variation_id\": \"\"\n },\n \"category_data\": {\n \"category_id\": \"\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-e02ee346-6787-47ac-a107-82bb81697705" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-3b7262f1-08bb-4a2b-971c-7e2b6d74fede" } ], "id": "0876019f-2e36-462f-b21c-98d2d5a3780c", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-0876019f-2e36-462f-b21c-98d2d5a3780c" }, { "name": "rewards", "item": [ { "name": "search", "item": [ { "name": "Square Search Loyalty Rewards", "id": "6c8cfc31-2e7d-44fb-804f-ac0b6dfd1771", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"loyalty_account_id\": \"\",\n \"status\": \"DELETED\"\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", "search" ] }, "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order." }, "response": [ { "id": "d0ddff1a-0d54-492f-ae20-0f2954dc2d9f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"loyalty_account_id\": \"\",\n \"status\": \"DELETED\"\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"INVALID_EXPIRATION\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"EXPECTED_BASE64_ENCODED_BYTE_ARRAY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"rewards\": [\n {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"REDEEMED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n },\n {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"ISSUED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-d0ddff1a-0d54-492f-ae20-0f2954dc2d9f" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-6c8cfc31-2e7d-44fb-804f-ac0b6dfd1771" } ], "id": "154d6616-643d-4030-9379-1e1214cf706d", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-154d6616-643d-4030-9379-1e1214cf706d" }, { "name": "{reward_id}", "item": [ { "name": "redeem", "item": [ { "name": "Square Redeem Loyalty Reward", "id": "b96327b8-524c-4b0c-ae18-464ae25d69ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id", "redeem" ], "variable": [ { "id": "917c4e12-f87d-4f1e-9c0e-85eb661ff205", "key": "reward_id", "value": "", "description": "(Required) The ID of the [loyalty reward](entity:LoyaltyReward) to redeem." } ] }, "description": "Redeems a loyalty reward.\n\nThe endpoint sets the reward to the `REDEEMED` terminal state.\n\nIf you are using your own order processing system (not using the\nOrders API), you call this endpoint after the buyer paid for the\npurchase.\n\nAfter the reward reaches the terminal state, it cannot be deleted.\nIn other words, points used for the reward cannot be returned\nto the account." }, "response": [ { "id": "748d0f4a-b711-456a-988f-909de2210b4a", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"location_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id", "redeem" ], "variable": [ { "key": "reward_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"EXPECTED_BASE64_ENCODED_BYTE_ARRAY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_CURSOR\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"event\": {\n \"id\": \"\",\n \"type\": \"DELETE_REWARD\",\n \"created_at\": \"\",\n \"loyalty_account_id\": \"\",\n \"source\": \"SQUARE\",\n \"accumulate_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"order_id\": \"\"\n },\n \"create_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"redeem_reward\": {\n \"loyalty_program_id\": \"\",\n \"reward_id\": \"\",\n \"order_id\": \"\"\n },\n \"delete_reward\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\",\n \"reward_id\": \"\"\n },\n \"adjust_points\": {\n \"points\": \"\",\n \"loyalty_program_id\": \"\",\n \"reason\": \"\"\n },\n \"location_id\": \"\",\n \"expire_points\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"other_event\": {\n \"loyalty_program_id\": \"\",\n \"points\": \"\"\n },\n \"accumulate_promotion_points\": {\n \"points\": \"\",\n \"order_id\": \"\",\n \"loyalty_program_id\": \"\",\n \"loyalty_promotion_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-748d0f4a-b711-456a-988f-909de2210b4a" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-b96327b8-524c-4b0c-ae18-464ae25d69ee" } ], "id": "c5aa56f5-feb8-418b-93fd-072ec8349144", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-c5aa56f5-feb8-418b-93fd-072ec8349144" }, { "name": "Square Delete Loyalty Reward", "id": "75ad1d3b-6955-4c5b-a51c-5825e8416ddf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id" ], "variable": [ { "id": "37007c69-8548-4583-babc-14f0ed3e5a32", "key": "reward_id", "value": "", "description": "(Required) The ID of the [loyalty reward](entity:LoyaltyReward) to delete." } ] }, "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED)." }, "response": [ { "id": "a9a8aeb3-5b20-4d1b-ba01-ef5cbde83f0e", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id" ], "variable": [ { "key": "reward_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"UNSUPPORTED_COUNTRY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"REQUEST_TIMEOUT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-a9a8aeb3-5b20-4d1b-ba01-ef5cbde83f0e" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-75ad1d3b-6955-4c5b-a51c-5825e8416ddf" }, { "name": "Square Retrieve Loyalty Reward", "id": "d52c07c9-8e36-42e5-ba5c-c480b2c009b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id" ], "variable": [ { "id": "8b7cf4e8-3f3b-4a22-96e1-56f7b678d6ef", "key": "reward_id", "value": "", "description": "(Required) The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve." } ] }, "description": "Retrieves a loyalty reward." }, "response": [ { "id": "ba6da982-cf27-42c4-b4c7-e6de9aa16e1b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards/:reward_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards", ":reward_id" ], "variable": [ { "key": "reward_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"UNKNOWN_QUERY_PARAMETER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"reward\": {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"DELETED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-ba6da982-cf27-42c4-b4c7-e6de9aa16e1b" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-d52c07c9-8e36-42e5-ba5c-c480b2c009b1" } ], "id": "ac65f84f-d86f-488c-9360-4a375c8eb6da", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-ac65f84f-d86f-488c-9360-4a375c8eb6da" }, { "name": "Square Create Loyalty Reward", "id": "88433f71-fd27-4fb8-9787-7aeb8c7eee42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reward\": {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"REDEEMED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards" ] }, "description": "Creates a loyalty reward. In the process, the endpoint does following:\n\n- Uses the `reward_tier_id` in the request to determine the number of points\nto lock for this reward.\n- If the request includes `order_id`, it adds the reward and related discount to the order.\n\nAfter a reward is created, the points are locked and\nnot available for the buyer to redeem another reward." }, "response": [ { "id": "373bee67-913d-47e3-970e-e233b43c7ab7", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"reward\": {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"REDEEMED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/loyalty/rewards", "host": [ "{{baseUrl}}" ], "path": [ "v2", "loyalty", "rewards" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"NOT_FOUND\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"BAD_EXPIRATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"reward\": {\n \"loyalty_account_id\": \"\",\n \"reward_tier_id\": \"\",\n \"id\": \"\",\n \"status\": \"DELETED\",\n \"points\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"redeemed_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-373bee67-913d-47e3-970e-e233b43c7ab7" } ], "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-88433f71-fd27-4fb8-9787-7aeb8c7eee42" } ], "id": "4845e3c7-5430-4458-8c12-257c259f69f4", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-4845e3c7-5430-4458-8c12-257c259f69f4" } ], "id": "049b7d79-e127-4377-a3dd-dbf95f049591", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-049b7d79-e127-4377-a3dd-dbf95f049591" } ], "id": "0108d8a9-6635-4038-826a-dfbf7a563b45", "createdAt": "2026-07-28T03:04:03.000Z", "updatedAt": "2026-07-28T03:04:03.000Z", "uid": "35240-0108d8a9-6635-4038-826a-dfbf7a563b45" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }