{ "info": { "_postman_id": "2caf3055-f4af-499f-9ac6-c916c194e2b2", "name": "Square ApplePay Terminal 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:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-2caf3055-f4af-499f-9ac6-c916c194e2b2" }, "item": [ { "name": "v2", "item": [ { "name": "terminals", "item": [ { "name": "actions", "item": [ { "name": "search", "item": [ { "name": "Square Search Terminal Actions", "id": "0cfbf140-b4dc-400e-a74a-e63d99e3dc57", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\",\n \"type\": \"CONFIRMATION\"\n },\n \"sort\": {\n \"sort_order\": \"ASC\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/actions/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", "search" ] }, "description": "Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days." }, "response": [ { "id": "f873d699-88f9-4418-8002-e02b6f7a4de3", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\",\n \"type\": \"CONFIRMATION\"\n },\n \"sort\": {\n \"sort_order\": \"ASC\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/actions/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", "search" ] } }, "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\": \"PAN_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"UNPROCESSABLE_ENTITY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"action\": [\n {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"RECEIPT\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"PHONE_NUMBER\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n },\n {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"SIGNATURE\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"PHONE_NUMBER\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-f873d699-88f9-4418-8002-e02b6f7a4de3" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-0cfbf140-b4dc-400e-a74a-e63d99e3dc57" } ], "id": "d0cd439e-204c-49de-85d0-fe851c72400c", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-d0cd439e-204c-49de-85d0-fe851c72400c" }, { "name": "{action_id}", "item": [ { "name": "cancel", "item": [ { "name": "Square Cancel Terminal Action", "id": "b79ee340-04e0-4ad2-928b-07ab37e11816", "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/terminals/actions/:action_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id", "cancel" ], "variable": [ { "id": "57d210ea-ff11-492f-8253-ac03799dfc18", "key": "action_id", "value": "", "description": "(Required) Unique ID for the desired `TerminalAction`." } ] }, "description": "Cancels a Terminal action request if the status of the request permits it." }, "response": [ { "id": "c5ad9fb7-4b4b-45c7-a8a4-53708db2f9fd", "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/terminals/actions/:action_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id", "cancel" ], "variable": [ { "key": "action_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"V1_ACCESS_TOKEN\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"TRANSACTION_LIMIT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"RECEIPT\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"PHONE_NUMBER\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-c5ad9fb7-4b4b-45c7-a8a4-53708db2f9fd" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-b79ee340-04e0-4ad2-928b-07ab37e11816" } ], "id": "a3496f24-ee71-4899-b8bb-83cb4ac176fa", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-a3496f24-ee71-4899-b8bb-83cb4ac176fa" }, { "name": "dismiss", "item": [ { "name": "Square Dismiss Terminal Action", "id": "85aedc4a-1056-4d1a-a570-e838ed3e123b", "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/terminals/actions/:action_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id", "dismiss" ], "variable": [ { "id": "7cf74cae-9709-43f5-ab89-23052be5e410", "key": "action_id", "value": "", "description": "(Required) Unique ID for the `TerminalAction` associated with the action to be dismissed." } ] }, "description": "Dismisses a Terminal action request if the status and type of the request permits it.\n\nSee [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details." }, "response": [ { "id": "361ba8cf-e808-43e8-b3a7-7ad5c73a051e", "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/terminals/actions/:action_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id", "dismiss" ], "variable": [ { "key": "action_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\": \"MISSING_ACCOUNT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"ALLOWABLE_PIN_TRIES_EXCEEDED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"SIGNATURE\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"EMAIL\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-361ba8cf-e808-43e8-b3a7-7ad5c73a051e" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-85aedc4a-1056-4d1a-a570-e838ed3e123b" } ], "id": "0ad9afe3-b0a2-4468-9491-638c8cc842e5", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-0ad9afe3-b0a2-4468-9491-638c8cc842e5" }, { "name": "Square Get Terminal Action", "id": "ddb6e329-78d6-45f1-bfe7-442e9ec50293", "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/terminals/actions/:action_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id" ], "variable": [ { "id": "fac9af68-c7ad-471f-890f-f54bc8023e59", "key": "action_id", "value": "", "description": "(Required) Unique ID for the desired `TerminalAction`." } ] }, "description": "Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days." }, "response": [ { "id": "8c310adc-4960-49ca-b9fd-bdcc368a1323", "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/terminals/actions/:action_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions", ":action_id" ], "variable": [ { "key": "action_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\": \"EXPECTED_MAP\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"EXPECTED_OBJECT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"SAVE_CARD\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"EMAIL\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-8c310adc-4960-49ca-b9fd-bdcc368a1323" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-ddb6e329-78d6-45f1-bfe7-442e9ec50293" } ], "id": "bbb998e4-5618-401d-ba43-40b144e9713f", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-bbb998e4-5618-401d-ba43-40b144e9713f" }, { "name": "Square Create Terminal Action", "id": "ea65d6f1-9da2-452c-aef6-4d584077bbdb", "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 \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"SAVE_CARD\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"EMAIL\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/actions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions" ] }, "description": "Creates a Terminal action request and sends it to the specified device." }, "response": [ { "id": "dc4dae96-2c51-45b9-8443-f906f1b8a829", "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 \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"SAVE_CARD\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"EMAIL\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/actions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "actions" ] } }, "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\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"UNKNOWN_BODY_PARAMETER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"action\": {\n \"id\": \"\",\n \"device_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"type\": \"DATA_COLLECTION\",\n \"qr_code_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"barcode_contents\": \"\"\n },\n \"save_card_options\": {\n \"customer_id\": \"\",\n \"card_id\": \"\",\n \"reference_id\": \"\"\n },\n \"signature_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"signature\": [\n {\n \"image_type\": \"\",\n \"data\": \"\"\n },\n {\n \"image_type\": \"\",\n \"data\": \"\"\n }\n ]\n },\n \"confirmation_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"agree_button_text\": \"\",\n \"disagree_button_text\": \"\",\n \"decision\": {\n \"has_agreed\": \"\"\n }\n },\n \"receipt_options\": {\n \"payment_id\": \"\",\n \"print_only\": \"\",\n \"is_duplicate\": \"\"\n },\n \"data_collection_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"input_type\": \"EMAIL\",\n \"collected_data\": {\n \"input_text\": \"\"\n }\n },\n \"select_options\": {\n \"title\": \"\",\n \"body\": \"\",\n \"options\": [\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n },\n {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n ],\n \"selected_option\": {\n \"reference_id\": \"\",\n \"title\": \"\"\n }\n },\n \"device_metadata\": {\n \"battery_percentage\": \"\",\n \"charging_state\": \"\",\n \"location_id\": \"\",\n \"merchant_id\": \"\",\n \"network_connection_type\": \"\",\n \"payment_region\": \"\",\n \"serial_number\": \"\",\n \"os_version\": \"\",\n \"app_version\": \"\",\n \"wifi_network_name\": \"\",\n \"wifi_network_strength\": \"\",\n \"ip_address\": \"\"\n },\n \"await_next_action\": \"\",\n \"await_next_action_duration\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-dc4dae96-2c51-45b9-8443-f906f1b8a829" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-ea65d6f1-9da2-452c-aef6-4d584077bbdb" } ], "id": "c2a267dd-d48b-4388-a873-dc9195fd4dd4", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-c2a267dd-d48b-4388-a873-dc9195fd4dd4" }, { "name": "checkouts", "item": [ { "name": "search", "item": [ { "name": "Square Search Terminal Checkouts", "id": "c54868a0-63f0-4f73-bc54-69666dccd966", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\"\n },\n \"sort\": {\n \"sort_order\": \"DESC\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/checkouts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", "search" ] }, "description": "Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days." }, "response": [ { "id": "5d7ed5e9-6314-4008-8404-aca9d296f7f1", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\"\n },\n \"sort\": {\n \"sort_order\": \"DESC\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/checkouts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", "search" ] } }, "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\": \"EXPECTED_STRING\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"checkouts\": [\n {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"AWG\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"COMPLETE\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"payment_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"MANUAL_CARD_ENTRY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"FJD\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"MMK\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-5d7ed5e9-6314-4008-8404-aca9d296f7f1" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-c54868a0-63f0-4f73-bc54-69666dccd966" } ], "id": "ada63ab6-9ef3-4951-b3e6-8cac25ea2a0e", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-ada63ab6-9ef3-4951-b3e6-8cac25ea2a0e" }, { "name": "{checkout_id}", "item": [ { "name": "cancel", "item": [ { "name": "Square Cancel Terminal Checkout", "id": "dd74494a-897b-4df5-ac2f-2cc030870b5e", "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/terminals/checkouts/:checkout_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id", "cancel" ], "variable": [ { "id": "85d3df12-8b37-4a96-90aa-97aab54012c6", "key": "checkout_id", "value": "", "description": "(Required) The unique ID for the desired `TerminalCheckout`." } ] }, "description": "Cancels a Terminal checkout request if the status of the request permits it." }, "response": [ { "id": "3740bc87-21a5-4831-8325-83be4dcfe70a", "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/terminals/checkouts/:checkout_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id", "cancel" ], "variable": [ { "key": "checkout_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\": \"INVALID_LOCATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SAR\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"COMPLETE\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"payment_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"PAYPAY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"DJF\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"GTQ\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-3740bc87-21a5-4831-8325-83be4dcfe70a" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-dd74494a-897b-4df5-ac2f-2cc030870b5e" } ], "id": "9d6a9c1a-6c4c-4973-8305-bb214479ec16", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-9d6a9c1a-6c4c-4973-8305-bb214479ec16" }, { "name": "dismiss", "item": [ { "name": "Square Dismiss Terminal Checkout", "id": "b5a3ebb7-60d0-4295-9aa4-76b8b6021a84", "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/terminals/checkouts/:checkout_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id", "dismiss" ], "variable": [ { "id": "000c2811-4d78-4795-995c-01899911bdc1", "key": "checkout_id", "value": "", "description": "(Required) Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed." } ] }, "description": "Dismisses a Terminal checkout request if the status and type of the request permits it." }, "response": [ { "id": "088be1f7-fec5-4068-820f-876e52495e31", "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/terminals/checkouts/:checkout_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id", "dismiss" ], "variable": [ { "key": "checkout_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\": \"ARRAY_EMPTY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"HUF\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"CANCEL\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"payment_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"FELICA_QUICPAY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"ZMK\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"NPR\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-088be1f7-fec5-4068-820f-876e52495e31" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-b5a3ebb7-60d0-4295-9aa4-76b8b6021a84" } ], "id": "4a0fb925-e9e7-487c-aa08-a8f4bb53bb3b", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-4a0fb925-e9e7-487c-aa08-a8f4bb53bb3b" }, { "name": "Square Get Terminal Checkout", "id": "0ea68123-0181-4a79-aa4f-0fe430fe76b7", "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/terminals/checkouts/:checkout_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id" ], "variable": [ { "id": "33ccf912-7335-4e19-9122-67bd198d5a96", "key": "checkout_id", "value": "", "description": "(Required) The unique ID for the desired `TerminalCheckout`." } ] }, "description": "Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days." }, "response": [ { "id": "ce753c7b-55b4-42d8-99a5-6d2074960e71", "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/terminals/checkouts/:checkout_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts", ":checkout_id" ], "variable": [ { "key": "checkout_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\": \"PAYMENT_AMOUNT_MISMATCH\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"JMD\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"COMPLETE\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"payment_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"FELICA_QUICPAY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"XBC\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"SGD\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-ce753c7b-55b4-42d8-99a5-6d2074960e71" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-0ea68123-0181-4a79-aa4f-0fe430fe76b7" } ], "id": "38aac2b8-8810-4f63-9320-184be5dd6cd3", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-38aac2b8-8810-4f63-9320-184be5dd6cd3" }, { "name": "Square Create Terminal Checkout", "id": "93cc7fd8-2e73-4934-a8c6-23af89b38e04", "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 \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"KZT\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\",\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"CANCEL\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"payment_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"MANUAL_CARD_ENTRY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"KHR\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"XOF\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts" ] }, "description": "Creates a Terminal checkout request and sends it to the specified device to take a payment\nfor the requested amount." }, "response": [ { "id": "737ec9ea-4966-417d-9dc5-1f2a5125614e", "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 \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"KZT\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\",\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"CANCEL\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"payment_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"MANUAL_CARD_ENTRY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"KHR\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"XOF\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "checkouts" ] } }, "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 \"checkout\": {\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"TMT\"\n },\n \"device_options\": {\n \"device_id\": \"\",\n \"skip_receipt_screen\": \"\",\n \"collect_signature\": \"\",\n \"tip_settings\": {\n \"allow_tipping\": \"\",\n \"separate_tip_screen\": \"\",\n \"custom_tip_field\": \"\",\n \"tip_percentages\": [\n \"\"\n ],\n \"smart_tipping\": \"\"\n },\n \"show_itemized_cart\": \"\"\n },\n \"id\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"order_id\": \"\",\n \"payment_options\": {\n \"autocomplete\": \"\",\n \"delay_duration\": \"\",\n \"accept_partial_authorization\": \"\",\n \"delay_action\": \"COMPLETE\"\n },\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"payment_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\",\n \"payment_type\": \"MANUAL_CARD_ENTRY\",\n \"team_member_id\": \"\",\n \"customer_id\": \"\",\n \"app_fee_money\": {\n \"amount\": \"\",\n \"currency\": \"DKK\"\n },\n \"statement_description_identifier\": \"\",\n \"tip_money\": {\n \"amount\": \"\",\n \"currency\": \"SZL\"\n }\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-737ec9ea-4966-417d-9dc5-1f2a5125614e" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-93cc7fd8-2e73-4934-a8c6-23af89b38e04" } ], "id": "b38e30ab-57a8-4082-b33c-231b270269d1", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-b38e30ab-57a8-4082-b33c-231b270269d1" }, { "name": "refunds", "item": [ { "name": "search", "item": [ { "name": "Square Search Terminal Refunds", "id": "ce1c0e49-bfaf-4583-b6a4-cf19d4f3502f", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\"\n },\n \"sort\": {\n \"sort_order\": \"\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/refunds/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", "search" ] }, "description": "Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days." }, "response": [ { "id": "681f793a-5b6b-4326-8aac-0e119e5a6bf4", "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 \"device_id\": \"\",\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"status\": \"\"\n },\n \"sort\": {\n \"sort_order\": \"\"\n }\n },\n \"cursor\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/refunds/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", "search" ] } }, "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\": \"INVALID_PHONE_NUMBER\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"MAP_KEY_LENGTH_TOO_SHORT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refunds\": [\n {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"QAR\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n },\n {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BDT\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-681f793a-5b6b-4326-8aac-0e119e5a6bf4" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-ce1c0e49-bfaf-4583-b6a4-cf19d4f3502f" } ], "id": "198d3071-e2d0-4c0c-a3e9-c0a17e5f6be1", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-198d3071-e2d0-4c0c-a3e9-c0a17e5f6be1" }, { "name": "{terminal_refund_id}", "item": [ { "name": "cancel", "item": [ { "name": "Square Cancel Terminal Refund", "id": "34bccc54-fa9c-41c9-a3ba-55bc2f2f538c", "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/terminals/refunds/:terminal_refund_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id", "cancel" ], "variable": [ { "id": "cbb30ba5-2e84-44bc-928b-2128b122dfac", "key": "terminal_refund_id", "value": "", "description": "(Required) The unique ID for the desired `TerminalRefund`." } ] }, "description": "Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it." }, "response": [ { "id": "5fa2d99a-8113-4c44-aaab-65fd90a14626", "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/terminals/refunds/:terminal_refund_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id", "cancel" ], "variable": [ { "key": "terminal_refund_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_CONTENT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"SOURCE_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"KGS\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"TIMED_OUT\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-5fa2d99a-8113-4c44-aaab-65fd90a14626" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-34bccc54-fa9c-41c9-a3ba-55bc2f2f538c" } ], "id": "91f5b42b-2bcf-438c-ae83-c1bd673264ea", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-91f5b42b-2bcf-438c-ae83-c1bd673264ea" }, { "name": "dismiss", "item": [ { "name": "Square Dismiss Terminal Refund", "id": "bd6ae87d-fa6f-4b39-94c9-e8c756389827", "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/terminals/refunds/:terminal_refund_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id", "dismiss" ], "variable": [ { "id": "34d0a3e5-a8c8-4c17-ab4d-e891f6614e5d", "key": "terminal_refund_id", "value": "", "description": "(Required) Unique ID for the `TerminalRefund` associated with the refund to be dismissed." } ] }, "description": "Dismisses a Terminal refund request if the status and type of the request permits it." }, "response": [ { "id": "e8982094-399a-42a4-9b67-304051ff6fe0", "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/terminals/refunds/:terminal_refund_id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id", "dismiss" ], "variable": [ { "key": "terminal_refund_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\": \"PLAID_ERROR_ITEM_LOGIN_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"BAD_EXPIRATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"AWG\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-e8982094-399a-42a4-9b67-304051ff6fe0" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-bd6ae87d-fa6f-4b39-94c9-e8c756389827" } ], "id": "de7949c7-418b-483e-b5b1-5db7f8dab1d3", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-de7949c7-418b-483e-b5b1-5db7f8dab1d3" }, { "name": "Square Get Terminal Refund", "id": "392b76da-a277-4b20-ad35-adf1ec1f2c4b", "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/terminals/refunds/:terminal_refund_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id" ], "variable": [ { "id": "6b44b8cb-17b4-4818-9dd1-cc17572a3f0e", "key": "terminal_refund_id", "value": "", "description": "(Required) The unique ID for the desired `TerminalRefund`." } ] }, "description": "Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days." }, "response": [ { "id": "64990779-35ff-418a-a929-1c17bc4ab721", "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/terminals/refunds/:terminal_refund_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds", ":terminal_refund_id" ], "variable": [ { "key": "terminal_refund_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\": \"INVALID_CARD_DATA\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_DATE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"MZN\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-64990779-35ff-418a-a929-1c17bc4ab721" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-392b76da-a277-4b20-ad35-adf1ec1f2c4b" } ], "id": "4f502078-c436-40ad-aecc-688213a613b6", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-4f502078-c436-40ad-aecc-688213a613b6" }, { "name": "Square Create Terminal Refund", "id": "1ba8b7ab-9c83-4017-a62d-1b9ea67cccff", "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 \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"DZD\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/refunds", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds" ] }, "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds)." }, "response": [ { "id": "b6584e6b-819b-448f-8beb-52e4aeee0d39", "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 \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"DZD\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/terminals/refunds", "host": [ "{{baseUrl}}" ], "path": [ "v2", "terminals", "refunds" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"DELAYED_TRANSACTION_CAPTURED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"ARRAY_EMPTY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refund\": {\n \"payment_id\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UYI\"\n },\n \"reason\": \"\",\n \"device_id\": \"\",\n \"id\": \"\",\n \"refund_id\": \"\",\n \"order_id\": \"\",\n \"deadline_duration\": \"\",\n \"status\": \"\",\n \"cancel_reason\": \"BUYER_CANCELED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"app_id\": \"\",\n \"location_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-b6584e6b-819b-448f-8beb-52e4aeee0d39" } ], "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-1ba8b7ab-9c83-4017-a62d-1b9ea67cccff" } ], "id": "244d5f16-d4fe-436c-868e-bbe47189fdd0", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-244d5f16-d4fe-436c-868e-bbe47189fdd0" } ], "id": "3e1925e6-b9ae-4b12-bacd-276ff22c9660", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-3e1925e6-b9ae-4b12-bacd-276ff22c9660" } ], "id": "25f69530-c8e6-40af-9077-bb15117514f5", "createdAt": "2026-07-28T03:04:42.000Z", "updatedAt": "2026-07-28T03:04:42.000Z", "uid": "35240-25f69530-c8e6-40af-9077-bb15117514f5" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }