---
title: "Retrieve account balances with aggregates"
method: GET
path: "/pty/account/v1/accounts/{account_id}/aggregated-balances"
tags: ["Ledger API - Balances"]
---

# Retrieve account balances with aggregates

`GET /pty/account/v1/accounts/{account_id}/aggregated-balances`

## Request

- Base URL: `https://api.uat.paymentology.com`
- URL: `https://api.uat.paymentology.com/pty/account/v1/accounts/{account_id}/aggregated-balances`
- Auth: HTTP bearer

<ul>
<li class="docBullet">Retrieves the account list under a specified account along with aggregate balances.</li>
<li class="docBullet">Use the view query parameter to control the payload shape:</li>
<li class="docBullet">SUMMARY (default) Aggregate balances for the account and its child accounts (no account details).</li>
<li class="docBullet">ACCOUNT Aggregate balance for the specified account only, with its details.</li>
<li class="docBullet">EXPANDED Aggregate balances for the account and its child accounts, with details of all accounts.</li>
<li class="docBullet">Aggregate balances are only returned when all accounts in the response share the same currency.</li>
</ul>

## Path parameters

- `account_id` string, required

## Query parameters

- `view` 'SUMMARY' | 'ACCOUNT' | 'EXPANDED': Payload shape for the aggregated-balances endpoint: - `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

## Response `200`

Successful Response

- AccountBalancesResponse
  - `pending_amount_aggregate` string: Aggregate pending amount in minor units across all accounts in the result set. Returned only when all accounts share the same currency.
  - `available_amount_aggregate` string: Aggregate available amount in minor units across all accounts in the result set. Returned only when all accounts share the same currency.
  - `accounts` AccountBalanceItem[], required: List of accounts with balance details. Empty when `view=SUMMARY` (aggregates only). Populated for `view=ACCOUNT` and `view=EXPANDED`.
    - `account_id` string, required: Account identifier
    - `account_name` string, required: Account name
    - `parent_account_id` string, nullable: Parent account identifier
    - `external_reference` string, nullable: External reference for the account
    - `currency` string, required: ISO 4217 currency code.
    - `pending_balance` string, required: Pending balance amount in minor units — in-flight transactions and authorization holds.
    - `available_balance` string, required: Available balance amount in minor units.
    - `created_at` string, date-time, required: Account creation date

## Other responses

- `400`: `BAD_REQUEST`: invalid parameter (listed in `details` for field validation errors).
- `401`: Missing or invalid access token: `UNAUTHORIZED`, `INVALID_CLIENT` or `INVALID_TENANT`.
- `403`: Access token rejected by the API gateway (for example, expired).
- `404`: `NOT_FOUND`: the account does not exist or does not belong to the client.
- `500`: `INTERNAL_SERVER_ERROR`: unexpected error.
- `503`: `INFRASTRUCTURE_ERROR`: temporary failure, retry later.

---

[API](https://skmtc.dev/paymentology/apis/ledger-api.md) - [All operations](https://skmtc.dev/paymentology/apis/ledger-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/ledger-api/revisions/a5700c501bee?raw)