You are viewing an old version of the API
List bank accounts

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

For more information, see Bank Accounts API.

Required permissions BANK_ACCOUNTS_READ

Query Parameters

Name Description
cursor
string

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.

limit
integer

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_id
string

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

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

bank_accounts
BankAccount [ ]

List of BankAccounts associated with this account.

cursor
string

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.

Examples

You are viewing an old version of the API
GET /v2/bank-accounts
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
curl https://connect.squareup.com/v2/bank-accounts \
  -H 'Square-Version: 2020-03-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "bank_accounts": [
    {
      "id": "ao6iaQ9vhDiaQD7n3GB",
      "account_number_suffix": "971",
      "country": "US",
      "currency": "USD",
      "account_type": "CHECKING",
      "holder_name": "Jane Doe",
      "primary_bank_identification_number": "112200303",
      "location_id": "S8GWD5example",
      "status": "VERIFICATION_IN_PROGRESS",
      "creditable": false,
      "debitable": false,
      "version": 5,
      "bank_name": "Bank Name"
    },
    {
      "id": "4x7WXuaxrkQkVlka3GB",
      "account_number_suffix": "972",
      "country": "US",
      "currency": "USD",
      "account_type": "CHECKING",
      "holder_name": "Jane Doe",
      "primary_bank_identification_number": "112200303",
      "location_id": "S8GWD5example",
      "status": "VERIFICATION_IN_PROGRESS",
      "creditable": false,
      "debitable": false,
      "version": 5,
      "bank_name": "Bank Name"
    }
  ]
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?