Object Index / Definition

You are viewing an old version of the API
BankAccount

Represents a bank account.

Properties

Name Description
id
string

Required

The unique, Square-issued identifier for the bank account.

Max Length 30 Min Length 1
account_number_suffix
string

Required

The last few digits of the account number.

Min Length 1
country
string

Required

The ISO 3166 Alpha-2 country code where the bank account is based.

currency
string

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 USD.

account_type
string

Required

The financial purpose of the associated bank account.

holder_name
string

Required

Name of the account holder. This name must match the name on the targeted bank account record.

Min Length 1
primary_bank_identification_number
string

Required

Primary identifier for the bank. For more information, see Bank Accounts API.

Max Length 40
secondary_bank_identification_number
string

Secondary identifier for the bank. For more information, see Bank Accounts API.

Max Length 40
debit_mandate_reference_id
string

Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts.

reference_id
string

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

The location to which the bank account belongs.

status
string

Required

Read-only. The current verification status of this BankAccount object.

creditable
boolean

Required

Indicates whether it is possible for Square to send money to this bank account.

debitable
boolean

Required

Indicates whether it is possible for Square to take money from this bank account.

fingerprint
string

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
integer

The current version of the BankAccount.

bank_name
string

Read only. Name of actual financial institution. For example "Bank of America".

Max Length 100

Share Feedback

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