Verification
Verify a meter
Confirm an electricity meter and read back the customer it belongs to. Always call this first: the access_code it returns is required when you place the order, and it is how we know the customer you are about to charge is the one you checked.
Shares the budget your orders do not reserve. Works with a live or test key.
curl -X POST 'https://stagingapi.getelectric.ng/api/v2/reseller/meters/verify' \
-H 'Authorization: Bearer <your-test-key>' \
-H 'Content-Type: application/json' \
-d '{
"meter_number": "11111111111",
"disco_code": "IKEDC",
"meter_type": "prepaid"
}'{
"meter_number": "11111111111",
"disco_code": "IKEDC",
"meter_type": "prepaid"
}{
"success": true,
"status": "success",
"code": 200,
"message": "OK",
"data": {
"name": "Sandbox Customer",
"address": "1 Test Close, Sandbox",
"phone_number": "08000000000",
"meter_number": "11111111111",
"short_code": "IKEDC",
"meter_type": "PREPAID",
"access_code": "sbx_4f1c9a2b7e6d3085a1b4c7d2"
}
}Authorization
AuthorizationstringheaderrequiredYour reseller API key, as Bearer <key>.
Body
meter_numberstringrequiredThe meter to check. In test mode this must be one of the reserved sandbox meters.
disco_codestringrequiredThe distribution company's code.
meter_typestringCase does not matter. Left out, it is prepaid.
One of prepaid, postpaid · Defaults to prepaid
Response 200
The meter and its customer. In live mode this is the provider's own payload, passed through unchanged, so treat the fields as indicative rather than fixed. In test mode it is a fixed sandbox customer.
successbooleanrequiredstatusstringrequiredOne of success, failed
codeintegerrequiredThe HTTP status, repeated in the body. It is not an error code: this API has none, so the message text is the only thing distinguishing one refusal from another, and message text is not a stable contract.
messagestringrequireddataobjectrequiredIn live mode this is the provider's own payload, passed through unchanged, so expect fields to vary by provider. access_code is the field you must keep.
Show child attributes
namestringaddressstringphone_numberstringmeter_numberstringshort_codestringmeter_typestringEchoed in upper case.
access_codestringSend this back when you place the order. Without it the order is refused.
At most 100 characters
Other responses
- 401
- No key, a malformed Authorization header, or a key that no longer exists.
- 403
- The key is real but may not do this. Three separate causes, and only the message tells them apart: the token cannot use the reseller API at all, the calling address is not on your allowlist, or the key carries both test and live access and must be reissued for one mode.
- 422
- The request was refused. message says what is wrong, in English; there is no machine-readable code to branch on.
- 429
- You have too many requests open at once. This is a concurrency cap, not a rate limit: wait for your open requests to finish rather than backing off a fixed time. Retry-After is 1.
- 503
- We could not reach the provider. Safe to retry, and for an order you must retry with the same reference.