v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

BankAccounts

ListBankAccounts

Returns a list of BankAccount objects linked to a Square account.

get/v2/bank-accounts

Query parameters

cursorstring

The pagination cursor returned by a previous call to this endpoint. Use it in the next ListBankAccounts request to retrieve the next set of results.

See the Pagination guide for more information.

limitinteger

Upper limit on the number of bank accounts to return in the response. Currently, 1000 is the largest supported limit. You can specify a limit of up to 1000 bank accounts. This is also the default limit.

location_idstring

Location ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific location.

customer_idstring

Customer ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific customer.

Response

Success

cursorstring

When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch next set of bank accounts. If empty, this is the final response.

For more information, see Pagination.

Example response

{
  "bank_accounts": [
    {
      "account_number_suffix": "000",
      "account_type": "CHECKING",
      "bank_name": "Citizens Bank",
      "country": "US",
      "creditable": true,
      "currency": "USD",
      "customer_id": "HM3B2D5JKGZ69359BTEHXM2V8M",
      "debitable": true,
      "fingerprint": "sq-1-mO3XNctJpTLL8uYowOWpioS8nQyTc838gcBo90254XonoEJ_c7Uw6yqL6qihFNY8fA",
      "holder_name": "Nicola Snow",
      "id": "bact:OxfBTiXgByaXds1K4GB",
      "primary_bank_identification_number": "011401533",
      "status": "VERIFIED",
      "version": 2
    },
    {
      "account_number_suffix": "118",
      "account_type": "CHECKING",
      "bank_name": "Bank of America",
      "country": "US",
      "creditable": true,
      "currency": "USD",
      "customer_id": "HM3B2D5JKGZ69359BTEHXM2V8M",
      "debitable": true,
      "fingerprint": "sq-1-Poacr0bohmds1N--OseZUsG5kPwfCGxqYKlb-Q1Rxwsk0lxd1JLs4yaPDuMqIae7Qg",
      "holder_name": "Nicola Snow",
      "id": "bact:Msdfa2kgUDR9lMgk4GB",
      "primary_bank_identification_number": "100210004",
      "status": "DISABLED",
      "version": 3
    }
  ]
}