Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 3.82 KB

bank-account.md

File metadata and controls

55 lines (46 loc) · 3.82 KB
Raw

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 str (Country) Required Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
currency str (Currency) Required Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.
account_type str (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 str (Bank Account Status) Required Indicates the current verification status of a BankAccount object.
creditable bool Required Indicates whether it is possible for Square to send money to this bank account.
debitable bool 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 int 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": "id0",
  "account_number_suffix": "account_number_suffix8",
  "country": "FO",
  "currency": "YER",
  "account_type": "BUSINESS_CHECKING",
  "holder_name": "holder_name4",
  "primary_bank_identification_number": "primary_bank_identification_number8",
  "secondary_bank_identification_number": "secondary_bank_identification_number0",
  "debit_mandate_reference_id": "debit_mandate_reference_id4",
  "reference_id": "reference_id2",
  "location_id": "location_id4",
  "status": "DISABLED",
  "creditable": false,
  "debitable": false,
  "fingerprint": "fingerprint6"
}