Confirm Customer

Request

Verifies that a meter number exists and is eligible for electricity vending or bill payment. Call this before purchasing to avoid higher latency — if you vend with an unknown meter number the system runs an implicit lookup first.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

meterNumberstringrequired

Meter number to confirm.

Example:"142567423303"

municipalitystring(Municipality)

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

Enum:"tshwane_prepaid""zeerust_prepaid""mogale_prepaid""ngwathe_prepaid""mogale_postpaid""tshwane_postpaid"

amountnumber

Intended purchase 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/Electricity/ConfirmCustomer \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "meterNumber": "0171001182",
    "municipality": "tshwane_prepaid"
  }'

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": "tshwane_prepaid",
    "customer": { … }
  }
}