Skip to main content
POST
Purchase Electricity

Overview

Purchase an electricity token for a validated meter. The token will be generated instantly and can be used to recharge the meter.

Request Body

Response Fields

string
Reference to store for reconciliation, support, and requerying pending transactions.
string
Electricity token for successful prepaid purchases.
number
Units returned for successful electricity purchases, when available.
string
Receipt number returned for successful purchases, when available.
number
Commission earned on the purchase, in Naira.

Status Codes

Notes

  • Validate the meter before purchase and let the customer confirm the returned details.
  • Use the minimum and maximum amount returned by the electricity catalog.
  • The vendType must match the customer’s meter type.
  • If the API returns gatewayStatus: "01" or an accepted pending response, wait at least 2 minutes before calling Requery Transaction.
  • Successful prepaid purchases include token details in the response data.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
number
required

Amount of electricity to purchase (in Naira)

Example:

1500

meter
string
required

The validated electricity meter number

Example:

"12345678910"

phone
string
required

Customer phone number for the transaction

Example:

"08000000000"

disco
string
required

Electricity provider productCode returned by the ElectricityList endpoint

Example:

"IKEJA_ELECTRIC"

vendType
enum<string>
required

Meter type

Available options:
PREPAID,
POSTPAID
Example:

"PREPAID"

Response

Successfully Processed

gatewayStatus
string
Example:

"00"

gatewayMessage
string
Example:

"Successfully Processed"

requestReference
string
Example:

"bpr_req_a1b2c3d4e5f6"

data
object