PApaymentology
Ledger API - Balances

Retrieve account balances with aggregates

<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>
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

Path parameters

account_idstring required
Example:479823917

Account identifier

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
Example:ACCOUNT

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

Response

Successful Response

pending_amount_aggregatestring

Aggregate pending amount in minor units across all accounts in the result set. Returned only when all accounts share the same currency.

available_amount_aggregatestring

Aggregate available amount in minor units across all accounts in the result set. Returned only when all accounts share the same currency.

Example response

{
  "pending_amount_aggregate": "75000",
  "available_amount_aggregate": "2125075",
  "accounts": [
    {
      "account_id": "479823917",
      "account_name": "Main ZAR Account",
      "parent_account_id": "542283189",
      "external_reference": "ext_ref_001",
      "currency": "ZAR",
      "pending_balance": "500",
      "available_balance": "11500",
      "created_at": "2026-06-15T10:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.