Skip to main content
The Balances response aggregates balances from all connected financial accounts, grouped by account type and currency.

Aggregated balance attributes

AttributeTypeDescription
typestringAccount type (CHECKING, SAVINGS, CREDIT_CARD, LOAN, INVESTMENT, etc.)
currency_codestringISO 4217 currency code
balancestringSum of current balances across all accounts of this type
available_balancestringSum of available balances across all accounts of this type
credit_limitstringSum of credit limits (0 for deposit accounts)
account_countintegerNumber of accounts in this aggregation

Account attributes

AttributeTypeDescription
idstringUnique identifier of account
created_atdate-timeDate and time account was created
updated_atdate-timeDate and time account was last updated
typestringAccount type
subtypestringAccount subtype
maskstringMasked account number
nicknamestringAlternate name for account
balancesobjectBalance information (currency_code, balance, available_balance, credit_limit)
providerobjectFinancial institution details (id, name, logo_url)

Response attributes

AttributeTypeDescription
total_accountsintegerTotal number of accounts across all links
accountsarray of objectsIndividual account records with provider information
aggregated_balancesarray of objectsBalances grouped by account type and currency

Endpoints


Example response