Check Overall Balance
The Overall Balance endpoint returns a consolidated view of the current and past balances for all accounts that the authenticated user can access. It shows each individual account’s balances as well as an aggregated total by category.
Request Endpoint
All methods use the same endpoint, differing only in their request payload structure
GET /partners-int/accounts/balance/overall
Query Parameters
| Parameter | Format | Description |
|---|---|---|
| filterDate (optional) | string (ISO8601) | Used to retrieve the closing (final) balance as of the specified date/time. If omitted, returns the current real-time balances. |
Retrieving the Overall (Current) Balance
If filterDate parameter is not included, the endpoint responds with the current balances.
GET {{baseUrl}}/partners-int/accounts/balance/overall
Retrieving the Overall Balance on a Specific Date
This request returns the balances as of the specified date (historical/closing balance).
GET {{baseUrl}}/partners-int/accounts/balance/overall?filterDate=2025-03-03T03:00:00.000Z
Success response Fields
| Parameter | Format | Description |
|---|---|---|
| statusCode | string | Indicates the general status of the request (e.g., "Done"). |
| data | object | Contains both the list of individual accounts and the overall, aggregated balances. |
| data.accounts | array of objects | Lists each account’s unique information and balances. |
| accounts[n].uid | string (UUID) | Unique identifier of the account. |
| accounts[n].accountActualBalance | string (decimal) | Current (or specified date’s) available balance for the account. |
| accounts[n].accountTotalBalance | string (decimal) | Total (or specified date’s) balance for the account, which may include pending amounts depending on the business rules. |
| accounts[n].category | string | Account category, e.g. "TransactionalAccount", "ProprietaryAccount", etc. |
| accounts[n].institution | string | Institution associated with this account, e.g. "PayBrokers", "TRIO". |
| data.overall | object | Aggregated balances by category. |
| overall..actualBalance | string (decimal) | Sum of the actual balances for all accounts in this category. |
| overall..accountTotalBalance | string (decimal) | Sum of the total balances for all accounts in this category. |
If you want to learn more about account categories, check Get accounts
Updated 8 days ago