{ "info": { "_postman_id": "9e3df154-9205-4a3f-810d-25e0d43e8069", "name": "Square ApplePay Snippets 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:36.000Z", "updatedAt": "2026-07-28T03:04:36.000Z", "lastUpdatedBy": "35240", "uid": "35240-9e3df154-9205-4a3f-810d-25e0d43e8069" }, "item": [ { "name": "v2", "item": [ { "name": "sites", "item": [ { "name": "{site_id}", "item": [ { "name": "snippet", "item": [ { "name": "Square Delete Snippet", "id": "ae66a5a6-dbe0-4ec5-8599-a4cdb6fb7b8b", "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/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "id": "b81b786c-0a39-4574-b849-12c8e06e86b3", "key": "site_id", "value": "", "description": "(Required) The ID of the site that contains the snippet." } ] }, "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis)." }, "response": [ { "id": "415f09c9-638b-48ac-aebf-aa3e44f52b84", "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/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "key": "site_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\": \"LOCATION_MISMATCH\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"EXPECTED_JSON_BODY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-415f09c9-638b-48ac-aebf-aa3e44f52b84" } ], "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-ae66a5a6-dbe0-4ec5-8599-a4cdb6fb7b8b" }, { "name": "Square Retrieve Snippet", "id": "edf257ac-fa41-41e6-82b2-374a698bd33b", "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/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "id": "af49c2ae-dfde-444f-b549-1be0abe1fd3b", "key": "site_id", "value": "", "description": "(Required) The ID of the site that contains the snippet." } ] }, "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis)." }, "response": [ { "id": "ced45a87-d9e9-4bc8-9001-cbe7c6b01a37", "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/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "key": "site_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\": \"CONFLICT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_PHONE_NUMBER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"snippet\": {\n \"content\": \"\",\n \"id\": \"\",\n \"site_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-ced45a87-d9e9-4bc8-9001-cbe7c6b01a37" } ], "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-edf257ac-fa41-41e6-82b2-374a698bd33b" }, { "name": "Square Upsert Snippet", "id": "1feeecd5-f0ab-49ed-b77e-307b956c208d", "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 \"snippet\": {\n \"content\": \"\",\n \"id\": \"\",\n \"site_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "id": "eebd3d9e-8396-4e3b-932f-ec7596e7c784", "key": "site_id", "value": "", "description": "(Required) The ID of the site where you want to add or update the snippet." } ] }, "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis)." }, "response": [ { "id": "1ed8061c-bcab-4e5f-b767-0d793009d550", "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 \"snippet\": {\n \"content\": \"\",\n \"id\": \"\",\n \"site_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/sites/:site_id/snippet", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sites", ":site_id", "snippet" ], "variable": [ { "key": "site_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\": \"TOO_MANY_MAP_ENTRIES\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"BAD_REQUEST\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"snippet\": {\n \"content\": \"\",\n \"id\": \"\",\n \"site_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-1ed8061c-bcab-4e5f-b767-0d793009d550" } ], "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-1feeecd5-f0ab-49ed-b77e-307b956c208d" } ], "id": "373c941d-120f-4c8f-ba64-c4c32fa01dcb", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-373c941d-120f-4c8f-ba64-c4c32fa01dcb" } ], "id": "79db001f-c1ab-4222-b01e-3624537d2a4f", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-79db001f-c1ab-4222-b01e-3624537d2a4f" } ], "id": "675cdec1-320c-42f7-a24b-fddf35498544", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-675cdec1-320c-42f7-a24b-fddf35498544" } ], "id": "236a5565-45ec-48c6-ba05-bc45b17571b3", "createdAt": "2026-07-28T03:04:37.000Z", "updatedAt": "2026-07-28T03:04:37.000Z", "uid": "35240-236a5565-45ec-48c6-ba05-bc45b17571b3" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }