Skip to main content
GET
/
v1
/
links
/
balances
Get Aggregated Balances Endpoint
curl --request GET \
  --url https://api.mytruv.com/v1/links/balances \
  --header 'Authorization: Basic <encoded-value>'
{
  "total_accounts": 6,
  "accounts": [
    {
      "type": "CHECKING",
      "balances": {
        "currency_code": "USD",
        "balance": "100.00",
        "available_balance": "50.99",
        "credit_limit": "200.00"
      },
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "subtype": "MONEY_MARKET",
      "mask": "6789",
      "nickname": "My account",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "logo_url": "<string>"
      }
    }
  ],
  "aggregated_balances": [
    {
      "type": "CHECKING",
      "currency_code": "USD",
      "balance": "49635.00",
      "available_balance": "48200.00",
      "credit_limit": "0.00",
      "account_count": 2
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use user_id as username and access_token as password.

Response

Successful Response

Aggregated balances across all connected financial accounts.

​
total_accounts
integer
required

Total number of accounts across all links.

Example:

6

​
accounts
AccountWithProvider · object[]
required

Individual account records with provider information.

​
aggregated_balances
AggregatedBalanceSchema · object[]
required

Balances aggregated by account type and currency.