BankAccount
February 26, 2020 ยท View on GitHub
Description
Represents a bank account. For more information about linking a bank account to a Square account, see Bank Accounts API.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | The unique, Square-issued identifier for the bank account. | |
| account_number_suffix | getAccountNumberSuffix() | setAccountNumberSuffix($value) | string | The last few digits of the account number. | |
| country | getCountry() | setCountry($value) | string | The ISO 3166 Alpha-2 country code where the bank account is based. See Country for possible values | |
| currency | getCurrency() | setCurrency($value) | string | 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`. See Currency for possible values | |
| account_type | getAccountType() | setAccountType($value) | string | The financial purpose of the associated bank account. See BankAccountType for possible values | |
| holder_name | getHolderName() | setHolderName($value) | string | Name of the account holder. This name must match the name on the targeted bank account record. | |
| primary_bank_identification_number | getPrimaryBankIdentificationNumber() | setPrimaryBankIdentificationNumber($value) | string | Primary identifier for the bank. For more information, see Bank Accounts API. | |
| secondary_bank_identification_number | getSecondaryBankIdentificationNumber() | setSecondaryBankIdentificationNumber($value) | string | Secondary identifier for the bank. For more information, see Bank Accounts API. | [optional] |
| debit_mandate_reference_id | getDebitMandateReferenceId() | setDebitMandateReferenceId($value) | string | Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts. | [optional] |
| reference_id | getReferenceId() | setReferenceId($value) | 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). | [optional] |
| location_id | getLocationId() | setLocationId($value) | string | The location to which the bank account belongs. | [optional] |
| status | getStatus() | setStatus($value) | string | Read-only. The current verification status of this BankAccount object. See BankAccountStatus for possible values | |
| creditable | getCreditable() | setCreditable($value) | bool | Indicates whether it is possible for Square to send money to this bank account. | |
| debitable | getDebitable() | setDebitable($value) | bool | Indicates whether it is possible for Square to take money from this bank account. | |
| fingerprint | getFingerprint() | setFingerprint($value) | 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. | [optional] |
| version | getVersion() | setVersion($value) | int | The current version of the `BankAccount`. | [optional] |
| bank_name | getBankName() | setBankName($value) | string | Read only. Name of actual financial institution. For example "Bank of America". | [optional] |
Note: All properties are protected and only accessed via getters and setters.