Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 3.9 KB

bank-account.md

File metadata and controls

55 lines (46 loc) · 3.9 KB

Bank Account

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

Structure

Bank Account

Fields

Name Type Tags Description
id String Required The unique, Square-issued identifier for the bank account.
Constraints: Minimum Length: 1, Maximum Length: 30
account_number_suffix String Required The last few digits of the account number.
Constraints: Minimum Length: 1
country String (Country) Required Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
currency String (Currency) Required Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.
account_type String (Bank Account Type) Required Indicates the financial purpose of the bank account.
holder_name String Required Name of the account holder. This name must match the name
on the targeted bank account record.
Constraints: Minimum Length: 1
primary_bank_identification_number String Required Primary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40
secondary_bank_identification_number String Optional Secondary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40
debit_mandate_reference_id String Optional 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 Optional 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 Optional The location to which the bank account belongs.
status String (Bank Account Status) Required Indicates the current verification status of a BankAccount object.
creditable TrueClass | FalseClass Required Indicates whether it is possible for Square to send money to this bank account.
debitable TrueClass | FalseClass Required Indicates whether it is possible for Square to take money from this
bank account.
fingerprint String Optional 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 Optional The current version of the BankAccount.
bank_name String Optional Read only. Name of actual financial institution.
For example "Bank of America".
Constraints: Maximum Length: 100

Example (as JSON)

{
  "id": "id2",
  "account_number_suffix": "account_number_suffix6",
  "country": "TT",
  "currency": "MVR",
  "account_type": "OTHER",
  "holder_name": "holder_name8",
  "primary_bank_identification_number": "primary_bank_identification_number0",
  "secondary_bank_identification_number": "secondary_bank_identification_number2",
  "debit_mandate_reference_id": "debit_mandate_reference_id2",
  "reference_id": "reference_id0",
  "location_id": "location_id6",
  "status": "VERIFICATION_IN_PROGRESS",
  "creditable": false,
  "debitable": false,
  "fingerprint": "fingerprint8"
}