AccountsAccounts

Get account

Get account balances, liabilities, and other detailed account information for a single deposit account.

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token with the read:bank_accounts scope

Path parameters

idstringRequiredformat: "uuid"
Unique identifier for the account

Response

The deposit account details including balances
accountCategoryenum
Category of account
Allowed values:
accountIdstring
Unique identifier for the account
accountNumberstring
Full account number
accountNumberDisplaystring
Masked or truncated account number for display
accountOpenDatestringformat: "date"

Date the account was opened (YYYY-MM-DD)

accountTypeenum
Type of deposit account
Allowed values:
availableBalancedouble
Available balance of the account
balanceTypeenum
Type of balance
Allowed values:
currencyobject
Currency information.
currentBalancedouble
Current balance of the account
productNamestring
Product name for the account
routingTransitNumberstring

Routing transit number (RTN) for the account

statusenum
Status of the account
accountCloseDatestringformat: "date"

Date the account was closed (YYYY-MM-DD). Present only for closed accounts.

balanceAsOfstringformat: "date-time"
Timestamp of when the balance was calculated
descriptionstring
Description of the account
interestRatedouble
Interest rate for the account
lineOfBusinessstring
Line of business for the account
nickNamestring

User-assigned nickname for the account

nicknamestring
Alternate nickname field
transferInboolean
Whether the account supports incoming transfers
transferOutboolean
Whether the account supports outgoing transfers

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error