Skip to main content
Each balance belongs to an account. The balance fields appear within the balances object on each account. The Balances endpoint returns current balance information for all accounts associated with a link.

​
Attributes

The balances endpoint returns a paginated list of accounts, each with a nested balances object.
AttributeTypeDescription
countintegerTotal number of accounts
nexturiURL of the next page of results, null if none
previousuriURL of the previous page of results, null if none
resultsarray of objectsList of accounts, see Account object

​
Account object

AttributeTypeDescription
idstringUnique ID
created_atdate-timeTimestamp when the account was created in Truv
updated_atdate-timeTimestamp when the account was updated in Truv
typestringThe account’s type
subtypestringThe account’s subtype
maskstringLast 4 digits of account number
nicknamestringDescription of account
balancesobjectBalance information, see Balances object

​
Balances object

AttributeTypeDescription
currency_codestringThree-character ISO 4217 currency code (e.g., USD)
balancestringCurrent account balance (nullable)
available_balancestringAvailable balance for use. PENDING transactions may not be reflected. (nullable)
credit_limitstringCredit limit, null for non-credit accounts (nullable)

​
Endpoints

​
Example response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "type": "CHECKING",
      "subtype": "MONEY_MARKET",
      "mask": "6789",
      "nickname": "My account",
      "balances": {
        "currency_code": "USD",
        "balance": "100.00",
        "available_balance": "50.99",
        "credit_limit": "200.00"
      }
    }
  ]
}