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.

Attribute	Type	Description
`count`	integer	Total number of accounts
`next`	uri	URL of the next page of results, `null` if none
`previous`	uri	URL of the previous page of results, `null` if none
`results`	array of objects	List of accounts, see Account object

Account object

Attribute	Type	Description
`id`	string	Unique ID
`created_at`	date-time	Timestamp when the account was created in Truv
`updated_at`	date-time	Timestamp when the account was updated in Truv
`type`	string	The account’s type
`subtype`	string	The account’s subtype
`mask`	string	Last 4 digits of account number
`nickname`	string	Description of account
`balances`	object	Balance information, see Balances object

Balances object

Attribute	Type	Description
`currency_code`	string	Three-character ISO 4217 currency code (e.g., `USD`)
`balance`	string	Current account balance (nullable)
`available_balance`	string	Available balance for use. `PENDING` transactions may not be reflected. (nullable)
`credit_limit`	string	Credit limit, `null` for non-credit accounts (nullable)

Endpoints

List all balances

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"
      }
    }
  ]
}