Bank Accounts API

Applies to: Bank Accounts API

Use the Bank Accounts API to retrieve information about the bank accounts linked to a Square account.

Before retrieving information about a bank account linked to a Square account, you must first link a bank account to a Square account in the Square Dashboard. You can then use the following endpoints to retrieve the bank account information:

• GetBankAccount - Retrieves information about a specific bank account linked to a Square account.
• ListBankAccounts - Retrieves information about all bank accounts linked to a Square account.
• GetBankAccountByBV1ID - This endpoint is provided only if you currently use the V1 Bank Accounts API. If you have a V1 bank account ID, you can use this endpoint to retrieve bank account information.

These APIs return bank account information as an object of the BankAccount type. The bank account information always includes the primary_bank_identification_number field and optionally the secondary_bank_identification_number field. The values for these fields depend on the country of the bank as shown:

Single Euro Payments Area (SEPA) countries include Austria, Belgium, Bulgaria, Cyprus, Croatia, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Monaco, Netherlands, Norway, Poland, Portugal, Romania, Slovenia, Slovakia, Spain and Sweden, Switzerland, United Kingdom (if linked using an IBAN).

• The country of the bank account must match the country of the associated account.
• Applications using OAuth must have BANK_ACCOUNTS_READ permission to retrieve bank account information linked to a Square account.

The Bank Accounts API supports only retrieving information about the linked bank accounts. You can link a bank account to a Square account in the Square Dashboard. To link an existing bank account to a Square account, you need the following information:

• The bank account number.
• The type of the account (such as checking or saving).
• The name of the person who holds the bank account.
• The primary bank identification number (in the United States, this is the routing number of the bank).

Bank accounts cannot receive deposits until Square completes a verification process on the bank account. Square performs this verification automatically when you link a bank account.

The verification process varies by country but the entire process usually takes a few minutes. In some cases, it can take up to 4 business days. As part of the verification process, Square credits and debits a small amount (for example, $0.01 USD) resulting in no change in your balance. Be sure you have a positive balance in your bank account before attempting to link it to Square to ensure that the account can be verified.

After Square verifies a bank account, the status field on the BankAccount object is set to VERIFIED. Square can then deposit funds to the linked bank.

You can retrieve information about a linked bank account using the GetBankAccount endpoint. In the request, you provide the following information:

• The ID of the BankAccount object in the endpoint URL.
• The access token of the Square seller in the Authorization header.

The following is an example request:

The following is an example response of the bank account in the United States:

{
   "bank_account":{
      "id":"bact:cgvL1yv43VFjexample",
      "account_number_suffix":"526",
      "country":"US",
      "currency":"USD",
      "account_type":"CHECKING",
      "holder_name":"John Doe",
      "primary_bank_identification_number":"101211111",
      "location_id":"S8GWD5example",
      "status":"VERIFICATION_SUCCEEDED",
      "creditable":true,
      "debitable":true,
      "version":5,
      "bank_name":"Bank Name"			
   }
}

For more information about bank account fields, see BankAccount.

If you don't have the bank account ID or you want to get a list of all the bank accounts linked to a Square account, you can use the ListBankAccounts endpoint. The endpoint returns information about all the bank accounts linked to a Square account, identified by access token in the Authorization header.

The following is a sample response:

{
   "bank_accounts":[
      {
         "id":"bact:cgvL1yv43VFjexample",
         "account_number_suffix":"526",
         "country":"US",
         "currency":"USD",
         "account_type":"CHECKING",
         "holder_name":"John Doe",
         "primary_bank_identification_number":"101211111",
         "location_id":"S8GWD5example",
         "status":"VERIFICATION_SUCCEEDED",
         "creditable":true,
         "debitable":true,
         "version":5,.
         "bank_name":"Bank Name"
      }
   ]
}

For more information about bank account fields, see BankAccount. You can also view only the bank accounts linked to a specific location using the location_id parameter. The following is an example of filtering by location_id:

The API can return information for up to 1000 bank accounts in each response. If the result is truncated, the response includes a cursor that you can use in the next request to fetch the next set of bank accounts. You can also optionally include the limit parameter to specify the maximum number of bank accounts to return in a response. The following example request includes the limit parameter and the cursor in the endpoint URL:

For more information, see Pagination.

While transitioning from the deprecated V1 RetrieveBankAccount endpoint, you can retrieve information about a linked bank account using the GetBankAccountByBV1Id endpoint. In response, the API returns bank account information that also includes a Square API bank account ID. You can then use this ID for future references.

In the request, you provide the following information:

• The V1 bank account id in the endpoint URL.
• The access token of the Square seller in the Authorization header.

The following is an example request:

The following is an example response:

{
   "bank_account":{
      "id":"bact:cgvL1yv43VFjexample",
      "account_number_suffix":"526",
      "country":"US",
      "currency":"USD",
      "account_type":"CHECKING",
      "holder_name":"John Doe",
      "primary_bank_identification_number":"101211111",
      "location_id":"S8GWD5example",
      "status":"VERIFICATION_SUCCEEDED",
      "creditable":true,
      "debitable":true,
      "version":5,
      "bank_name":"Bank Name"
   }
}

The Bank Accounts API supports the following set of webhooks:

You can subscribe to these webhooks events to get notified when there are changes to a BankAccount. For a list of supported webhooks, see Webhook Events Reference. For more information about using webhooks, see Square Webhooks.