The Bank Account Object
From the Bank Accounts endpoint, you can retrieve the real-time balance for each bank account.
| Field | Type | Description |
|---|---|---|
| accountId sortable, filterable | string | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new accountId will be assigned to the account. |
| currentBalance sortable, filterable | decimal | The total amount of funds in or owed by the account. For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae ( ins_116944).For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. For investment-type accounts, the current balance is the total value of assets as presented by the institution. |
| availableBalance sortable, filterable | decimal | The amount of funds available to be withdrawn from the account, as determined by the financial institution. For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows. For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit. For investment-type accounts, the available balance is the total cash available to withdraw as presented by the institution. |
| limit sortable, filterable | decimal | For credit-type accounts, this represents the credit limit. For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for credit-type accounts. |
| currency sortable, filterable | string | The ISO-4217 currency code of the transaction or unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. |
| maskedAccountNumber | string | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between a connection accounts, and it may also not match the mask that the bank displays to the user. |
| accountName | string | The name of the account, either assigned by the user or by the financial institution itself. |
| officialAccountName | string | The official name of the account as given by the financial institution. |
| accountType sortable, filterable | string | The bank account type. Possible values: investment, credit, depository, loan, brokerage, other |
| accountSubType | string | The bank account subtype. |
| sourceModifiedDate sortable, filterable | string See Date | Timestamp indicating the last time that the balance for the given account has been updated. |