Catalogue
List providers
Who you can buy from inside a service: the networks for airtime and data, the TV companies for cable. The id here is the provider_id an order needs.
Shares the budget your orders do not reserve. Works with a live or test key.
curl 'https://stagingapi.getelectric.ng/api/v2/reseller/catalogue/services/airtime/providers' \
-H 'Authorization: Bearer <your-test-key>'// The providers for that service.Authorization
AuthorizationstringheaderrequiredYour reseller API key, as Bearer <key>.
Path parameters
servicestringpathrequiredA service code from listServices. Case does not matter.
One of airtime, data, cable_tv, electricity
Response 200
The providers for that service.
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
servicestringrequiredprovidersarray of objectrequiredShow child attributes
idintegerrequiredThe provider_id an order needs.
codestringrequirednamestringrequiredlogostringprefixesarray of stringPhone prefixes belonging to this network, so you can preselect one from a number the customer typed. A hint, never a rule: let them change it.
sort_orderintegerrequiredhas_plansbooleanrequiredWhether to read plans before asking for money.
Other responses
- 400
- No service was named.
- 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.
- 404
- We do not sell that service. Distinct from a service that exists and has nothing available today, which answers 200 with an empty list.
- 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 load the catalogue. Safe to retry.