| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
String | ✔️ | A unique identifier for an object. | 12345 |
downstreamId |
JsonNullable<String> | ➖ | The third-party API ID of original entity | 12345 |
displayId |
JsonNullable<String> | ➖ | Display ID for the bank account | BA-001 |
name |
JsonNullable<String> | ➖ | The name of the bank account | Main Operating Account |
accountNumber |
JsonNullable<String> | ➖ | The bank account number | 123465 |
accountType |
Optional<AccountingBankAccountAccountType> | ➖ | The type of bank account | checking |
ledgerAccount |
JsonNullable<LinkedLedgerAccount> | ➖ | N/A | |
bankName |
JsonNullable<String> | ➖ | The name of the bank or financial institution | Chase Bank |
currency |
JsonNullable<Currency> | ➖ | Indicates the associated currency for an amount of money. Values correspond to ISO 4217. | USD |
balance |
JsonNullable<Double> | ➖ | The current balance of the bank account | 25000 |
availableBalance |
JsonNullable<Double> | ➖ | The available balance (considering pending transactions and overdraft) | 24500 |
overdraftLimit |
JsonNullable<Double> | ➖ | The overdraft limit for the account | 5000 |
routingNumber |
JsonNullable<String> | ➖ | Bank routing number (US) | 021000021 |
iban |
JsonNullable<String> | ➖ | International Bank Account Number | GB33BUKB20201555555555 |
bic |
JsonNullable<String> | ➖ | Bank Identifier Code / SWIFT Code | CHASUS33 |
bsbNumber |
JsonNullable<String> | ➖ | Bank State Branch number (Australia/New Zealand) | 062-001 |
branchIdentifier |
JsonNullable<String> | ➖ | Bank branch identifier | 001 |
bankCode |
JsonNullable<String> | ➖ | Bank code assigned by central bank | BNH |
country |
JsonNullable<String> | ➖ | Country code according to ISO 3166-1 alpha-2. | US |
status |
JsonNullable<AccountingBankAccountStatus> | ➖ | The status of the bank account | active |
description |
JsonNullable<String> | ➖ | Description or notes about the bank account | Primary operating account for daily transactions |
customFields |
List<CustomField> | ➖ | N/A | |
customMappings |
Map<String, Object> | ➖ | When custom mappings are configured on the resource, the result is included here. | |
createdAt |
OffsetDateTime | ➖ | The date and time when the object was created. | 2020-09-30T07:43:32.000Z |
updatedAt |
OffsetDateTime | ➖ | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z |
createdBy |
JsonNullable<String> | ➖ | The user who created the object. | 12345 |
updatedBy |
JsonNullable<String> | ➖ | The user who last updated the object. | 12345 |