Migrate from Connect v1 BankAccounts API
On this page
The Connect v1 BankAccounts API lets developers view external linked bank accounts.
The Square BankAccounts API provides all of the functionality of the Connect v1 BankAccounts API and adds these new features:
Webhooks — Square v2 Webhooks (beta) provide notifications when a bank account is created, verified, or disabled.
You can use a v1 bank account ID to retrieve the Square API equivalent BankAccount object. Call the Square API GetBankAccountByV1Id endpoint .
Square BankAccounts API endpoints replace the v1 BankAccounts endpoints in v1BankAccounts API.
You must update the code that relies on the following endpoints to avoid breaking when the v1 BankAccounts API retires:
|ListBankAccounts||ListBankAccounts||Gets a list of BankAccount objects|
|RetrieveBankAccount||GetBankAccount||Gets a single BankAccount|
|N/A||GetBankAccountByV1Id||Gets a single v1 BankAccount by ID|
When you used the Connect v1 API to get a list of bank accounts, you set a location ID in the URL path. With the Square API, you specify the location ID by setting the ID as a query parameter of the request:
Connect v1 API
All fields in v1 BankAccount object are available in the Square BankAccount object. As a result, most code will only need to update the endpoint reference and field names to work properly.
The Square API BankAccount object contains all of the fields of the v1 object, but they are mapped to new names:
|v1 field||Square field||Notes|
|The v1 |
|The id of the Location of the seller associated with the bank account|
secondary_bank_identification_number correspond to different bank account fields according to country:
|Primary bank ID number||Secondary bank ID number|
|Australia (AU)||BSB code||❌|
|Canada (CA)||Institution number||Transit number|
|Japan (JP)||Bank code||Branch code|
|United Kingdom (GB)||Sort code||❌|
|United States (US)||Routing number||❌|