Bills Payment
Electricity
This service allow you to recharge your Prepaid and Postpaid Electricity Meter for your Customers over BudPay API.
- Call /api/v2/electricity to get all the avaliable Electricity providers.
- Call /api/v2/electricity/validate to fetch Meter Account information using the Meter Number.
- Call /api/v2/electricity/recharge to initialize Electricity recharge payment.
Electricity Providers
Getting all available Electricity Providers
Endpoint: /electricity
Method: GET
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
Sample Post
curl https://api.budpay.com/api/v2/electricity
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": [
{
"provider": "IKEDC",
"code": "ikeja-electric",
"providerLogoUrl": "assets/images/bills/Ikeja-Electric-Payment-PHCN.jpg",
"minAmount": "500"
},
{
"provider": "EKEDC",
"code": "eko-electric",
"providerLogoUrl": "assets/images/bills/Eko-Electric-Payment-PHCN.jpg",
"minAmount": "500"
},
{
"provider": "KEDCO",
"code": "kano-electric",
"providerLogoUrl": "assets/images/bills/Kano-Electric.jpg",
"minAmount": "500"
},
{
"provider": "PHED",
"code": "portharcourt-electric",
"providerLogoUrl": "assets/images/bills/Port-Harcourt-Electric.jpg",
"minAmount": "500"
},
{
"provider": "JED",
"code": "jos-electric",
"providerLogoUrl": "assets/images/bills/Jos-Electric-JED.jpg",
"minAmount": "500"
},
{
"provider": "IBEDC",
"code": "ibadan-electric",
"providerLogoUrl": "assets/images/bills/IBEDC-Ibadan-Electricity-Distribution-Company.jpg",
"minAmount": "500"
},
{
"provider": "KAEDCO",
"code": "kaduna-electric",
"providerLogoUrl": "assets/images/bills/Kaduna-Electric-KAEDCO.jpg",
"minAmount": "500"
},
{
"provider": "AEDC",
"code": "abuja-electric",
"providerLogoUrl": "assets/images/bills/Abuja-Electric.jpg",
"minAmount": "500"
}
]
}
Electricity Validate
To perform a Electricity Meter Number Validation
Endpoint: /electricity/validate
Method: POST
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
Body Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| provider | string | Yes | please use the id of the provider as returned in internet providers (e.g. for Airtel, use 1) |
| number | string | Yes | Customer's/beneficiary's Meter number to subscribe on |
Sample Post
curl https://api.budpay.com/api/v2/electricity/validate
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{"provider":"IBEDC",
"type": "prepaid",
"number": "1111111111111"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": {
"provider": "IBEDC",
"number": "1111111111111",
"type": "prepaid",
"Customer_Name": "OLADIPO OLUWAFEMI"
}
}
Electricity Recharge
To Initiate a Electricity Recharge Payment
Endpoint: /electricity/recharge
Method: POST
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
| Encryption | string | Yes | Set value to your {Signature_HMAC-SHA-512} output |
Body Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| provider | string | Yes | please use the provider name of the provider as returned in Electricity providers (e.g. for IBEDC) |
| number | string | Yes | Customer's/beneficiary's Meter number to recharge on |
| type | string | Yes | meter type (Prepaid or Postpaid) |
| amount | string | Yes | amount to recharge |
| reference | string | Yes | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. |
Sample Post
curl https://api.budpay.com/api/v2/electricity/recharge
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{"provider":"IKEDC",
"number": "1111111111111",
"type": "prepaid",
"amount": 1000,
"reference": "2022051105275457530"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "SUCCESSFUL",
"data": {
"orderNo": "16651456950755436254604761",
"reference": "20220511052754574330",
"status": "delivered",
"errorMsg": "TRANSACTION SUCCESSFUL",
"purchased_code": "Token : 26362054405982757802",
"units": "79.9 kWh"
}
}