PApaymentology
Ledger API - Balances

Retrieve account balances for a single account

<ul> <li class="docBullet">Retrieves the pending and available balances for a single account.</li> </ul>
get/pty/account/v1/accounts/{account_id}/balances

Request

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

Path parameters

account_idstring required
Example:479823917

Account identifier

Response

Successful Response

account_idstring required

Account identifier

account_namestring required

Account name

parent_account_idstring nullable

Parent account identifier

external_referencestring nullable

External reference for the account

currencystring required

ISO 4217 currency code.

pending_balancestring required

Pending balance amount in minor units — in-flight transactions and authorization holds.

available_balancestring required

Available balance amount in minor units.

created_atstring date-time required

Account creation date

Example response

{
  "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.