Retrieve account balances with aggregates

  • Retrieves the account list under a specified account along with aggregate balances.
  • Use the view query parameter to control the payload shape:
  • SUMMARY (default) Aggregate balances for the account and its child accounts (no account details).
  • ACCOUNT Aggregate balance for the specified account only, with its details.
  • EXPANDED Aggregate balances for the account and its child accounts, with details of all accounts.
  • Aggregate balances are only returned when all accounts in the response share the same currency.
Path Params
string
required
length between 1 and 50

Account identifier

Query Params
string
enum
Defaults to SUMMARY

Payload shape:

  • SUMMARY — Aggregate balances for the account and its child accounts (no account details)
  • ACCOUNT — Aggregate balance for the specified account only, with its details
  • EXPANDED — Aggregate balances for the account and its child accounts, with details
Allowed:
Responses

403

Access token rejected by the API gateway (for example, expired).

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json