What you can sell
Four services, two pricing shapes, and one place to read the ids.
| Service | service | Priced by | Needs a lookup | Target |
|---|---|---|---|---|
| Electricity | electricity | amount | yes, meters/verify | meter number |
| Airtime | airtime | amount | no | phone number |
| Data | data | plan_id, or amount | no | phone number |
| Cable TV | cable_tv | plan_id, or amount | yes, targets/verify | smartcard number |
cable-tv and cabletv are accepted as well, and case does not matter.
Two pricing shapes
Priced by amount. The customer names a figure and you send amount in
naira. Electricity and airtime work this way.
Priced by plan. The customer picks a bundle and you send its plan_id. Data
bundles and TV packages work this way. You may send amount instead for data
and cable TV, and the provider decides whether that is valid, so prefer
plan_id when the customer chose a plan.
Read pricing on each service to know which form to show: OPEN means ask for
an amount, FIXED means offer a list of plans.
Where provider and plan ids come from
Everything but electricity needs a provider_id, and a bundle needs a
plan_id. Both come from the catalogue, which your API key can read:
curl https://stagingapi.getelectric.ng/api/v2/reseller/catalogue/services \
-H 'Authorization: Bearer <your-key>'curl https://stagingapi.getelectric.ng/api/v2/reseller/catalogue/services/data/providers \
-H 'Authorization: Bearer <your-key>'curl https://stagingapi.getelectric.ng/api/v2/reseller/catalogue/providers/3/plans \
-H 'Authorization: Bearer <your-key>'Warning
Plans and their prices are synced from the vendors and change during the day. A plan list fetched this morning can offer a bundle that has since gone off sale or changed price, and the order then fails after your customer has already chosen. Read plans when you need them. Do not cache them overnight.
The reference pages are List services, List providers and List plans.
Electricity is different
There is no catalogue call for electricity. You send the disco_code for the
distribution company and the meter number, and
Verify a meter confirms both and returns the
access_code the order requires. Verification is not a courtesy step here: an
order without a valid access_code is refused.
Prepaid and postpaid
meter_type on meter verify is prepaid unless you say otherwise, and
postpaid is the only other value. Prepaid meters get a token back on
delivery. Postpaid ones do not, because there is nothing to type in; the
payment lands on the account.
What a plan's amount is
amount on a plan is what you pay for it, before your commission. It is
not a recommended retail price. What you charge your own customer is yours to
decide. See Commission for how your earnings are
worked out.