Aggregated balance attributes
| Attribute | Type | Description |
|---|---|---|
| type | string | Account type (CHECKING, SAVINGS, CREDIT_CARD, LOAN, INVESTMENT, etc.) |
| currency_code | string | ISO 4217 currency code |
| balance | string | Sum of current balances across all accounts of this type |
| available_balance | string | Sum of available balances across all accounts of this type |
| credit_limit | string | Sum of credit limits (0 for deposit accounts) |
| account_count | integer | Number of accounts in this aggregation |
Account attributes
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier of account |
| created_at | date-time | Date and time account was created |
| updated_at | date-time | Date and time account was last updated |
| type | string | Account type |
| subtype | string | Account subtype |
| mask | string | Masked account number |
| nickname | string | Alternate name for account |
| balances | object | Balance information (currency_code, balance, available_balance, credit_limit) |
| provider | object | Financial institution details (id, name, logo_url) |
Response attributes
| Attribute | Type | Description |
|---|---|---|
| total_accounts | integer | Total number of accounts across all links |
| accounts | array of objects | Individual account records with provider information |
| aggregated_balances | array of objects | Balances grouped by account type and currency |
Endpoints
Example response
{
"total_accounts": 6,
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"type": "CHECKING",
"subtype": "MONEY_MARKET",
"mask": "6789",
"nickname": "My account",
"balances": {
"currency_code": "USD",
"balance": "25000.00",
"available_balance": "24500.00",
"credit_limit": "0.00"
},
"provider": {
"id": "chase",
"name": "Chase",
"logo_url": "https://cdn.mytruv.com/providers/chase.png"
}
}
],
"aggregated_balances": [
{
"type": "CHECKING",
"currency_code": "USD",
"balance": "49635.00",
"available_balance": "48200.00",
"credit_limit": "0.00",
"account_count": 2
}
]
}