Object Index
You are viewing an old version of the API
BankAccount
Object Index
Represents a bank account.
For more information about linking a bank account to a Square account, see Bank Accounts API.
Properties
Name | Description |
---|---|
id
Required
|
The unique, Square-issued identifier for the bank account. |
account_
Required
|
The last few digits of the account number. |
country
Required
|
The ISO 3166 Alpha-2 country code where the bank account is based. |
currency
Required
|
The 3-character ISO 4217 currency code indicating the operating
currency of the bank account. For example, the currency code for US dollars
is |
account_
Required
|
The financial purpose of the associated bank account. |
holder_
Required
|
Name of the account holder. This name must match the name on the targeted bank account record. |
primary_
Required
|
Primary identifier for the bank. For more information, see Bank Accounts API. |
secondary_
|
Secondary identifier for the bank. For more information, see Bank Accounts API. |
debit_
|
Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts. |
reference_
|
Client-provided identifier for linking the banking account to an entity in a third-party system (for example, a bank account number or a user identifier). |
location_
|
The location to which the bank account belongs. |
status
Required
|
Read-only. The current verification status of this BankAccount object. |
creditable
Required
|
Indicates whether it is possible for Square to send money to this bank account. |
debitable
Required
|
Indicates whether it is possible for Square to take money from this bank account. |
fingerprint
|
A Square-assigned, unique identifier for the bank account based on the account information. The account fingerprint can be used to compare account entries and determine if the they represent the same real-world bank account. |
version
|
The current version of the |
bank_
|
Read only. Name of actual financial institution. For example "Bank of America". |