Skip to content

Latest commit

 

History

History
57 lines (48 loc) · 4.27 KB

bank-account.md

File metadata and controls

57 lines (48 loc) · 4.27 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

BankAccount

Fields

Name Type Tags Description Getter
Id String Required The unique, Square-issued identifier for the bank account.
Constraints: Minimum Length: 1, Maximum Length: 30		 String getId()
AccountNumberSuffix String Required The last few digits of the account number.
Constraints: Minimum Length: 1		 String getAccountNumberSuffix()
Country String Required Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.		 String getCountry()
Currency String Required Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.		 String getCurrency()
AccountType String Required Indicates the financial purpose of the bank account. String getAccountType()
HolderName String Required Name of the account holder. This name must match the name
on the targeted bank account record.
Constraints: Minimum Length: 1		 String getHolderName()
PrimaryBankIdentificationNumber String Required Primary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40		 String getPrimaryBankIdentificationNumber()
SecondaryBankIdentificationNumber String Optional Secondary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40		 String getSecondaryBankIdentificationNumber()
DebitMandateReferenceId String Optional Reference identifier that will be displayed to UK bank account owners
when collecting direct debit authorization. Only required for UK bank accounts.		 String getDebitMandateReferenceId()
ReferenceId 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).		 String getReferenceId()
LocationId String Optional The location to which the bank account belongs. String getLocationId()
Status String Required Indicates the current verification status of a BankAccount object. String getStatus()
Creditable boolean Required Indicates whether it is possible for Square to send money to this bank account. boolean getCreditable()
Debitable boolean Required Indicates whether it is possible for Square to take money from this
bank account.		 boolean getDebitable()
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.		 String getFingerprint()
Version Integer Optional The current version of the BankAccount. Integer getVersion()
BankName String Optional Read only. Name of actual financial institution.
For example "Bank of America".
Constraints: Maximum Length: 100		 String getBankName()

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": null,
  "debit_mandate_reference_id": null,
  "reference_id": null,
  "location_id": null,
  "status": "DISABLED",
  "creditable": false,
  "debitable": false,
  "fingerprint": null,
  "version": null,
  "bank_name": null
}