API Reference Electricity Validation Requests
Get Discos
GET

Service Information

{{baseUrl}}discos?loginId={{loginId}}&key={{publicKey}}
GET
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchant’s (public) key 
{
    "statusCode": "00",
    "statusDescription": "Successful",
    "details": [
        {
            "serviceId": "E01E",
            "service": "IkejaPrepaid"
        },
        {
            "serviceId": "E02E",
            "service": "IkejaPostpaid"
        },
        {
            "serviceId": "E03E",
            "service": "IbadanPrepaid"
        },
        {
            "serviceId": "E04E",
            "service": "IbadanPostpaid"
        },
        {
            "serviceId": "E05E",
            "service": "EkoPrepaid "
        },
        {
            "serviceId": "E06E",
            "service": "EkoPostpaid "
        },
        {
            "serviceId": "E07E",
            "service": "AbujaPrepaid "
        },
        {
            "serviceId": "E08E",
            "service": "AbujaPostpaid"
        },
        {
            "serviceId": "E09E",
            "service": "PortHarcourtPrepaid"
        },
        {
            "serviceId": "E10E",
            "service": "PortHarcourtPostpaid"
        },
        {
            "serviceId": "E11E",
            "service": "KadunaPrepaid"
        },
        {
            "serviceId": "E12E",
            "service": "KadunaPostpaid"
        },
        {
            "serviceId": "E13E",
            "service": "JosPrepaid"
        },
        {
            "serviceId": "E14E",
            "service": "JosPostpaid"
        },
        {
            "serviceId": "E15E",
            "service": "EnuguPrepaid"
        },
        {
            "serviceId": "E16E",
            "service": "EnuguPostpaid"
        },
        {
            "serviceId": "E17E",
            "service": "KanoPrepaid"
        },
        {
            "serviceId": "E18E",
            "service": "KanoPostpaid"
        },
        {
            "serviceId": "E19E",
            "service": "BENPRE"
        },
        {
            "serviceId": "E20E",
            "service": "BENPOST"
        },
        {
            "serviceId": "E21E",
            "service": "YolaPrepaid"
        },
        {
            "serviceId": "E22E",
            "service": "YolaPostpaid"
        },
        {
            "serviceId": "E23E",
            "service": "ABA PREPAID"
        },
        {
            "serviceId": "E24E",
            "service": "ABA POSTPAID"
        }
    ]
}

Electricity Validation Requests

POST

Electricity top-up requests follow a slightly different process, involving two key steps:

  1. Validation – The account or meter number must be verified before a top-up can proceed.
  2. Vending – Once validation is successful, the top-up is processed.

While the validation logic, input parameters, and responses are generally consistent across all distribution companies 🏢, vending responses may vary depending on the provider.

For details on checksum generation 🔐, see the Security: Checksum section.

Service Information

baseUrl/api/v1/evalidate
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
serviceId String M Corresponding service id for the request type. See "Services" section for the available services and corresponding service codes for each.
customerAccountId Numeric M Customers unique identifier on distributors platform e.g Account Number or Meter Number
key String M Merchants (public) key
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps 

{
    "loginId":1234,"serviceId":"E02E","customerAccountId":"0110347638",
    "key":"0688378ec7fe233", checksum":"#2y*&23UnvC19"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
detail Collection M An array of merchant customer’s detail 
{
    "statusCode":"00","statusDescription":"successful",
    "detail":{"name":"MR & MRS XD MICHAEL","address":"71 XAVIER CRESCENT ",
    "accountId":"0110347638","providerRef":"150168371668"}
}

Electricity Vending Requests

POST

The request parameters for the Vending endpoint 🔌 remain consistent across all distribution companies 🏢. However, pay close attention to the Vending responses 📩, as these vary for each electricity provider ⚡. For guidance on security checksum generation 🔐, refer to the Security: Checksum section.

Service Information

baseUrl/api/v1/evend
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
serviceId String M Corresponding service id for the request type. See "Services" section for the available services and corresponding service codes for each.
customerAccountId Numeric M Customers unique identifier on distributors platform e.g Account Number or Meter Number
amount Numeric M Amount to top-up customers account/meter with
customerName String M Name of Customer
requestId Numeric M Merchants unique id/reference for the transaction
customerAddress String M Address of the Customer
key String M Merchants (public) key
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps 

{
    "loginId":"1234","key":"0688378ec7fe233",
    "serviceId":"E02E","customerAccountId":"0110347638","requestId":1511693541,"amount":"1000","customerName": "MR & MRS. Test CSW",
    "customerAddress": "93B, ODUDUWA CRESCENT, GRA, IKEJA, LAGOS","checksum": "$2y$10$rv89doOk0TdmGrWhyrj4gepYG6I3Toi5CSVdMV.mFmRvKBN\/\/JEE2"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
detail Collection M An array of merchant customer’s detail 
{
    "statusCode":"00","statusDescription":"successful","detail":
    { "name": "MR & MRS XD MICHAEL","address":"71 XAVIER CRESCENT ","accountId":"0110347638","amount":"1000",
    "units":"788.14kWh","token":"01234567890123456789","tranxId":"20170727085357" }
}