Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 5.12 KB

bank-account.md

File metadata and controls

55 lines (46 loc) · 5.12 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 Setter
id string Required The unique, Square-issued identifier for the bank account.
Constraints: Minimum Length: 1, Maximum Length: 30		 getId(): string setId(string id): void
accountNumberSuffix string Required The last few digits of the account number.
Constraints: Minimum Length: 1		 getAccountNumberSuffix(): string setAccountNumberSuffix(string accountNumberSuffix): void
country string(Country) Required Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.		 getCountry(): string setCountry(string country): void
currency string(Currency) Required Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.		 getCurrency(): string setCurrency(string currency): void
accountType string(BankAccountType) Required Indicates the financial purpose of the bank account. getAccountType(): string setAccountType(string accountType): void
holderName string Required Name of the account holder. This name must match the name
on the targeted bank account record.
Constraints: Minimum Length: 1		 getHolderName(): string setHolderName(string holderName): void
primaryBankIdentificationNumber string Required Primary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40		 getPrimaryBankIdentificationNumber(): string setPrimaryBankIdentificationNumber(string primaryBankIdentificationNumber): void
secondaryBankIdentificationNumber ?string Optional Secondary identifier for the bank. For more information, see
Bank Accounts API.
Constraints: Maximum Length: 40		 getSecondaryBankIdentificationNumber(): ?string setSecondaryBankIdentificationNumber(?string secondaryBankIdentificationNumber): void
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.		 getDebitMandateReferenceId(): ?string setDebitMandateReferenceId(?string debitMandateReferenceId): void
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).		 getReferenceId(): ?string setReferenceId(?string referenceId): void
locationId ?string Optional The location to which the bank account belongs. getLocationId(): ?string setLocationId(?string locationId): void
status string(BankAccountStatus) Required Indicates the current verification status of a BankAccount object. getStatus(): string setStatus(string status): void
creditable bool Required Indicates whether it is possible for Square to send money to this bank account. getCreditable(): bool setCreditable(bool creditable): void
debitable bool Required Indicates whether it is possible for Square to take money from this
bank account.		 getDebitable(): bool setDebitable(bool debitable): void
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.		 getFingerprint(): ?string setFingerprint(?string fingerprint): void
version ?int Optional The current version of the BankAccount. getVersion(): ?int setVersion(?int version): void
bankName ?string Optional Read only. Name of actual financial institution.
For example "Bank of America".
Constraints: Maximum Length: 100		 getBankName(): ?string setBankName(?string bankName): void

Example (as JSON)

{
  "id": "id2",
  "account_number_suffix": "account_number_suffix6",
  "country": "TT",
  "currency": "SLL",
  "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"
}