Skip to content
/
Check Balance

Check Balance

Request

Returns the authenticated merchant's current credit balance across all consumed prepaid VAS services. Optionally includes a transaction breakdown for a specified period.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
printReceiptsboolean

If true, include topup and vend receipts per service for the period defined in receipts.

Default:false
receiptsobject(ReceiptsConfiguration)

Required when printReceipts is true.

curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v1/Merchant/CheckBalance \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "printReceipts": false
  }'

Responses

Balance response.

Bodyapplication/json
successboolean

true - action successful, result is in data. false - error occurred, details are in error and errorNo.

Example:true
dataobject or null(BalanceResponse)

Result payload. null when success is false.

errorstring or null

Human-readable error message. null when success is true.

Example:"999 - Internal server error"
errorNointeger or null

Error code. null when success is true.

Example:999
Response
{
  "success": true,
  "data": {
    "balance": -10908,
    "payments": { … },
    "services": [ … ],
    "timestamp": 1774193070098
  }
}