Orders
List orders
Your orders in this mode, newest first. A live key sees live orders and a test key sees sandbox orders; there is no way to read one from the other.
Shares the budget your orders do not reserve. Works with a live or test key.
curl 'https://stagingapi.getelectric.ng/api/v2/reseller/orders?limit=50&offset=0' \
-H 'Authorization: Bearer <your-test-key>'// A page of orders. count is the number in this page, not the total you have.Authorization
AuthorizationstringheaderrequiredYour reseller API key, as Bearer <key>.
Query parameters
limitintegerqueryHow many orders to return. Asking for 0 or less, or for more than 200, silently gives you 50 rather than failing or clamping to 200.
Defaults to 50 · 1 or more · 200 or less
offsetintegerqueryHow many to skip. A negative offset is treated as 0.
Defaults to 0 · 0 or more
Response 200
A page of orders. count is the number in this page, not the total you have.
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.
messagestringrequireddataobjectrequiredShow child attributes
ordersarray of objectrequiredShow child attributes
referencestringrequiredYour reference, as you sent it.
At most 120 characters
modestringrequiredOne of live, test
servicestringrequiredOne of electricity, airtime, data, cable_tv
statestringrequireddelivered, failed and refunded are terminal. accepted and processing are not: keep polling, or wait for the webhook.
One of accepted, processing, delivered, failed, refunded
settledbooleanrequiredTrue once the state is terminal and the money has stopped moving.
meter_numberstringnullablerequireddisco_codestringnullablerequiredtargetstringnullablerequiredThe phone or smartcard number, for anything that is not electricity.
At most 64 characters
provider_idintegernullablerequiredplan_idintegernullablerequiredamountnumberrequiredNaira.
messagestringrequiredPlain words about where the order stands. For people, not for branching on.
transactionstringnullablerequiredOur transaction reference, once there is one.
tokenstringnullablerequiredThe electricity token, once delivered. Never set for anything but electricity.
token_unitsnumbernullablerequiredUnits the token carries, in kWh.
placed_atstringrequiredAlways UTC, written 2026-11-18T09:14:22Z with no offset. Note that the webhook uses a different format, so parse with a real RFC 3339 parser rather than a fixed pattern.
UTC with no offset, written 2026-11-18T09:14:22Z.
updated_atstringrequiredUTC with no offset, written 2026-11-18T09:14:22Z.
phone_numberstringnullablerequiredWhatever you sent, echoed back. We do not validate it.
countintegerrequiredOrders in this page.
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.
- 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
- Our side could not serve this. Safe to retry.