{ "info": { "_postman_id": "25727e9c-e899-408b-9ae0-e75784181799", "name": "Square ApplePay BankAccounts 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:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-25727e9c-e899-408b-9ae0-e75784181799" }, "item": [ { "name": "v2", "item": [ { "name": "bank-accounts", "item": [ { "name": "by-v1-id", "item": [ { "name": "{v1_bank_account_id}", "item": [ { "name": "Square Get Bank Account by V1 ID", "id": "dc9dcda7-04c5-41c1-9a1c-d102909eff44", "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/bank-accounts/by-v1-id/:v1_bank_account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts", "by-v1-id", ":v1_bank_account_id" ], "variable": [ { "id": "e7c7ae31-c7e2-4abd-922b-4db112c0a812", "key": "v1_bank_account_id", "value": "", "description": "(Required) Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api)." } ] }, "description": "Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID." }, "response": [ { "id": "5d913330-d30a-43bf-a20a-6f2a98778b26", "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/bank-accounts/by-v1-id/:v1_bank_account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts", "by-v1-id", ":v1_bank_account_id" ], "variable": [ { "key": "v1_bank_account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"bank_account\": {\n \"id\": \"\",\n \"account_number_suffix\": \"\",\n \"country\": \"ZM\",\n \"currency\": \"UAH\",\n \"account_type\": \"INVESTMENT\",\n \"holder_name\": \"\",\n \"primary_bank_identification_number\": \"\",\n \"status\": \"DISABLED\",\n \"creditable\": \"\",\n \"debitable\": \"\",\n \"secondary_bank_identification_number\": \"\",\n \"debit_mandate_reference_id\": \"\",\n \"reference_id\": \"\",\n \"location_id\": \"\",\n \"fingerprint\": \"\",\n \"version\": \"\",\n \"bank_name\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-5d913330-d30a-43bf-a20a-6f2a98778b26" } ], "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-dc9dcda7-04c5-41c1-9a1c-d102909eff44" } ], "id": "307b0fa6-31f1-4a20-9217-072bcef53e41", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-307b0fa6-31f1-4a20-9217-072bcef53e41" } ], "id": "4377d46f-3636-4dce-93d6-05807ab2d1f7", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-4377d46f-3636-4dce-93d6-05807ab2d1f7" }, { "name": "{bank_account_id}", "item": [ { "name": "Square Get Bank Account", "id": "6b2520d3-51f1-4c4b-9929-9e94bb188db3", "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/bank-accounts/:bank_account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts", ":bank_account_id" ], "variable": [ { "id": "a155e916-d3d1-4e1d-8ffd-b59c050594a1", "key": "bank_account_id", "value": "", "description": "(Required) Square-issued ID of the desired `BankAccount`." } ] }, "description": "Returns details of a [BankAccount](entity:BankAccount)\nlinked to a Square account." }, "response": [ { "id": "68d472ce-fb7b-4ae7-9ad6-22e279d83b55", "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/bank-accounts/:bank_account_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts", ":bank_account_id" ], "variable": [ { "key": "bank_account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"BAD_GATEWAY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"bank_account\": {\n \"id\": \"\",\n \"account_number_suffix\": \"\",\n \"country\": \"ME\",\n \"currency\": \"MVR\",\n \"account_type\": \"OTHER\",\n \"holder_name\": \"\",\n \"primary_bank_identification_number\": \"\",\n \"status\": \"VERIFICATION_IN_PROGRESS\",\n \"creditable\": \"\",\n \"debitable\": \"\",\n \"secondary_bank_identification_number\": \"\",\n \"debit_mandate_reference_id\": \"\",\n \"reference_id\": \"\",\n \"location_id\": \"\",\n \"fingerprint\": \"\",\n \"version\": \"\",\n \"bank_name\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-68d472ce-fb7b-4ae7-9ad6-22e279d83b55" } ], "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-6b2520d3-51f1-4c4b-9929-9e94bb188db3" } ], "id": "f7528a24-2a79-49be-a6ff-287b309c3ff0", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-f7528a24-2a79-49be-a6ff-287b309c3ff0" }, { "name": "Square List Bank Accounts", "id": "6592ca75-3c08-4c67-b03a-f4df83372fcf", "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/bank-accounts?cursor=&limit=&location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts" ], "query": [ { "description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", "key": "cursor", "value": "" }, { "description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.", "key": "limit", "value": "" }, { "description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.", "key": "location_id", "value": "" } ] }, "description": "Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account." }, "response": [ { "id": "93ba9206-3481-4c36-b48c-365444e576f8", "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/bank-accounts?cursor=&limit=&location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "bank-accounts" ], "query": [ { "description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.", "key": "cursor", "value": "" }, { "description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.", "key": "limit", "value": "" }, { "description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.", "key": "location_id", "value": "" } ] } }, "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_TIME\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"bank_accounts\": [\n {\n \"id\": \"\",\n \"account_number_suffix\": \"\",\n \"country\": \"VI\",\n \"currency\": \"IQD\",\n \"account_type\": \"OTHER\",\n \"holder_name\": \"\",\n \"primary_bank_identification_number\": \"\",\n \"status\": \"DISABLED\",\n \"creditable\": \"\",\n \"debitable\": \"\",\n \"secondary_bank_identification_number\": \"\",\n \"debit_mandate_reference_id\": \"\",\n \"reference_id\": \"\",\n \"location_id\": \"\",\n \"fingerprint\": \"\",\n \"version\": \"\",\n \"bank_name\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-93ba9206-3481-4c36-b48c-365444e576f8" } ], "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-6592ca75-3c08-4c67-b03a-f4df83372fcf" } ], "id": "edc15111-338f-4b42-9f55-08fefdce837f", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-edc15111-338f-4b42-9f55-08fefdce837f" } ], "id": "3cf5bb5d-4b35-499c-9b68-554a23a57834", "createdAt": "2026-07-28T03:01:42.000Z", "updatedAt": "2026-07-28T03:01:42.000Z", "uid": "35240-3cf5bb5d-4b35-499c-9b68-554a23a57834" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }