<- Bank Accounts API

Bank Accounts API

All versions ->

List bank accounts

GET

 /v2/bank-accounts

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

Permissions:BANK_ACCOUNTS_READ

Guide

Retrieve all bank accounts linked to a Square account

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

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.

Link to section

limit

integer(32-bit)

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.

Link to section

location_id

string

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

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

bank_accounts

List of BankAccounts associated with this account.

Link to section

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.