import type * as Square from "../index"; /** * Represents a bank account. For more information about * linking a bank account to a Square account, see * [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). */ export interface BankAccount { /** The unique, Square-issued identifier for the bank account. */ id: string; /** The last few digits of the account number. */ accountNumberSuffix: string; /** * The ISO 3166 Alpha-2 country code where the bank account is based. * See [Country](#type-country) for possible values */ country: Square.Country; /** * 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](#type-currency) for possible values */ currency: Square.Currency; /** * The financial purpose of the associated bank account. * See [BankAccountType](#type-bankaccounttype) for possible values */ accountType: Square.BankAccountType; /** * Name of the account holder. This name must match the name * on the targeted bank account record. */ holderName: string; /** * Primary identifier for the bank. For more information, see * [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). */ primaryBankIdentificationNumber: string; /** * Secondary identifier for the bank. For more information, see * [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). */ secondaryBankIdentificationNumber?: string | null; /** * Reference identifier that will be displayed to UK bank account owners * when collecting direct debit authorization. Only required for UK bank accounts. */ debitMandateReferenceId?: string | null; /** * 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). */ referenceId?: string | null; /** The location to which the bank account belongs. */ locationId?: string | null; /** * Read-only. The current verification status of this BankAccount object. * See [BankAccountStatus](#type-bankaccountstatus) for possible values */ status: Square.BankAccountStatus; /** Indicates whether it is possible for Square to send money to this bank account. */ creditable: boolean; /** * Indicates whether it is possible for Square to take money from this * bank account. */ debitable: boolean; /** * 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. */ fingerprint?: string | null; /** The current version of the `BankAccount`. */ version?: number; /** * Read only. Name of actual financial institution. * For example "Bank of America". */ bankName?: string | null; /** The ID of the customer who owns the bank account */ customerId?: string; }