<- Object

Object

BankAccount

Represents a bank account.

For more information about linking a bank account to a Square account, see Bank Accounts API.

Link to section

Properties

Link to section

id

string

Required

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

Link to section

account_number_suffix

string

Required

The last few digits of the account number.

Link to section

country

string

Required

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

Link to section

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.

Link to section

account_type

string

Required

The financial purpose of the associated bank account.

Link to section

holder_name

string

Required

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

Link to section

primary_bank_identification_number

string

Required

Link to section

secondary_bank_identification_number

string

Link to section

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.

Link to section

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

Link to section

location_id

string

The location to which the bank account belongs.

Link to section

status

string

Required

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

Link to section

creditable

boolean

Required

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

Link to section

debitable

boolean

Required

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

Link to section

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.

Link to section

version

integer(32-bit)

The current version of the BankAccount.

Link to section

bank_name

string

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