Skip to main content
GET
List Electricity Providers

Overview

Get the catalog of all supported electricity providers. This is useful for building a dynamic dropdown of providers for your customers to select from.

Response

The data field is an array of provider entries. Each entry contains the fields below.

Response Fields

number
Unique catalog item ID.
string
Electricity provider or DisCo name.
string
Provider code to submit as disco when validating or purchasing electricity.
string
Customer-readable provider description.
number
Minimum supported electricity purchase amount, in Naira.
number
Maximum supported electricity purchase amount, in Naira.
number
Customer commission rate for the provider, when available.

Example Response

Notes

  • Use the returned productCode as the disco value when validating or purchasing electricity.
  • Use the returned minAmount and maxAmount to validate payment amounts before purchase.
  • Validate the meter before purchase so the customer can confirm the name and address.

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Successfully retrieved electricity providers

gatewayStatus
string
Example:

"00"

gatewayMessage
string
Example:

"Successfully Processed"

requestReference
string
Example:

"bpr_req_a1b2c3d4e5f6"

data
object[]