Skip to content

Bills

Postpaid municipal bill payments for Tshwane and Mogale accounts, identified by account number rather than meter number.

Operations

Confirm Customer

Request

Verifies that a postpaid municipal account number exists and returns its current running balance. Call this before Purchase to avoid higher latency — if you pay a bill for an unknown account number the system runs an implicit lookup first.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
accountNumberstringrequired

Account number to confirm.

Example:"04235758721"
municipalitystring(BillMunicipality)

Municipality the account belongs to. If omitted the system multi-casts to all known bill municipalities (slower).

Enum:"mogale_postpaid""tshwane_postpaid"
amountnumber

Intended payment amount (used for credit pre-checking).

methodstring

Intended payment method.

Enum:"cash""card"
curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v2/Bills/ConfirmCustomer \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "accountNumber": "04235758721",
    "municipality": "mogale_postpaid"
  }'

Responses

Customer confirmation 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(ConfirmCustomerResult)

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": {
    "exists": true,
    "municipality": "mogale_postpaid",
    "customer": { … }
  }
}