{ "info": { "_postman_id": "9fb26d75-3729-4df5-bedf-ca9811f92efb", "name": "Square ApplePay OAuth 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:09.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "lastUpdatedBy": "35240", "uid": "35240-9fb26d75-3729-4df5-bedf-ca9811f92efb" }, "item": [ { "name": "oauth2", "item": [ { "name": "revoke", "item": [ { "name": "Square Revoke Token", "id": "48a578e3-dd5b-4a65-9ef1-49d5260d4cc0", "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 \"client_id\": \"\",\n \"access_token\": \"\",\n \"merchant_id\": \"\",\n \"revoke_only_access_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/revoke", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "revoke" ] }, "description": "Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. \n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the **OAuth**\npage for your application in the Developer Dashboard." }, "response": [ { "id": "714322fe-a935-4550-aa39-074ed2873a44", "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 \"client_id\": \"\",\n \"access_token\": \"\",\n \"merchant_id\": \"\",\n \"revoke_only_access_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/revoke", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "revoke" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"INVALID_TIME_RANGE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"UNAUTHORIZED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-714322fe-a935-4550-aa39-074ed2873a44" } ], "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-48a578e3-dd5b-4a65-9ef1-49d5260d4cc0" } ], "id": "12c25f87-1a81-4480-8c89-6a16d9988f0b", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-12c25f87-1a81-4480-8c89-6a16d9988f0b" }, { "name": "token", "item": [ { "name": "status", "item": [ { "name": "Square Retrieve Token Status", "id": "fb277f85-b9a5-49c2-a39b-5ac36326e278", "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}}/oauth2/token/status", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token", "status" ] }, "description": "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application\u2019s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `ACCESS_TOKEN` is a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).\n\nIf the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error." }, "response": [ { "id": "55ebc1db-0725-4785-8878-fa13a93dda22", "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}}/oauth2/token/status", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"client_id\": \"\",\n \"merchant_id\": \"\",\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_POSTAL_CODE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"EXPECTED_FLOAT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-55ebc1db-0725-4785-8878-fa13a93dda22" } ], "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-fb277f85-b9a5-49c2-a39b-5ac36326e278" } ], "id": "c8418ec0-288c-47e7-b132-ed795a59538e", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-c8418ec0-288c-47e7-b132-ed795a59538e" }, { "name": "Square Obtain Token", "id": "0e83a287-0ee4-4178-b82d-40902febf8ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"grant_type\": \"\",\n \"client_secret\": \"\",\n \"code\": \"\",\n \"redirect_uri\": \"\",\n \"refresh_token\": \"\",\n \"migration_token\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"short_lived\": \"\",\n \"code_verifier\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token" ] }, "description": "Returns an OAuth access token and a refresh token unless the \n`short_lived` parameter is set to `true`, in which case the endpoint \nreturns only an access token.\n\nThe `grant_type` parameter specifies the type of OAuth request. If \n`grant_type` is `authorization_code`, you must include the authorization \ncode you received when a seller granted you authorization. If `grant_type` \nis `refresh_token`, you must provide a valid refresh token. If you're using \nan old version of the Square APIs (prior to March 13, 2019), `grant_type` \ncan be `migration_token` and you must provide a valid migration token.\n\nYou can use the `scopes` parameter to limit the set of permissions granted \nto the access token and refresh token. You can use the `short_lived` parameter \nto create an access token that expires in 24 hours.\n\n__Note:__ OAuth tokens should be encrypted and stored on a secure server. \nApplication clients should never interact directly with OAuth tokens." }, "response": [ { "id": "00f511fb-23f3-4ea0-a536-82285f2fba47", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"client_id\": \"\",\n \"grant_type\": \"\",\n \"client_secret\": \"\",\n \"code\": \"\",\n \"redirect_uri\": \"\",\n \"refresh_token\": \"\",\n \"migration_token\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"short_lived\": \"\",\n \"code_verifier\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_at\": \"\",\n \"merchant_id\": \"\",\n \"subscription_id\": \"\",\n \"plan_id\": \"\",\n \"id_token\": \"\",\n \"refresh_token\": \"\",\n \"short_lived\": \"\",\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"UNSUPPORTED_COUNTRY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"NOT_IMPLEMENTED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refresh_token_expires_at\": \"\"\n}", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-00f511fb-23f3-4ea0-a536-82285f2fba47" } ], "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-0e83a287-0ee4-4178-b82d-40902febf8ca" } ], "id": "39cdd79e-1a39-46c8-a1c9-7ea500073b8f", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-39cdd79e-1a39-46c8-a1c9-7ea500073b8f" } ], "id": "0c8786e4-41f6-43fe-abc4-86a4a8109fbe", "createdAt": "2026-07-28T03:04:10.000Z", "updatedAt": "2026-07-28T03:04:10.000Z", "uid": "35240-0c8786e4-41f6-43fe-abc4-86a4a8109fbe" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }