Welcome to the Electricity API Integration page. This guide will help you integrate our Electricity API into your system.
curl -X POST https://vtunaija.com.ng/api/billpayment/ \
-H "Authorization: Token YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"disco_name": "1",
"meter_number": "289645439",
"MeterType": "prepaid",
"amount": "3000",
"mobile_number": "08023487895",
"request-id": "879207ty798y0787s"
}'
This is an example of the response returned for a successful Electricity payment.
{
"Status": "successful",
"status": "success",
"api_response": "TRANSACTION SUCCESSFUL",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "3000.00",
"transaction_internal_id": "8539",
"token": "Token: 076578558667856587587",
"electricitytoken": "Token: 076578558667856587587"
}
This is an example of the response returned for a failed Electricity payment.
{
"Status": "failed",
"status": "fail",
"api_response": "Failed Failed Failed. Something went wrong",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "0.00",
"transaction_internal_id": "8539"
}
This is an example of the response returned for a pending Electricity payment.
{
"Status": "processing",
"status": "processing",
"api_response": "Pending Electricity Payment, transaction pending",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "3000.00",
"transaction_internal_id": "8539"
}
This is an example of a failed API response caused by factors such as an insufficient wallet balance, an incorrect API key, missing POST fields and so on.
{
"Status": "failed",
"status": "fail",
"message": "Insufficient wallet balance",
}
disco_name: This field identifies the specific electricity service provider for which the user is making a bill payment. The *disco_name* field is represented by numbers such as 1, 2, 3, 4, 5, 6, etc., corresponding to various electricity companies in Nigeria. For the full list of Vtunaija Electricity IDs and Plan IDs, refer to API Documentation Page 1.
meter_number: This field specifies the electricity meter number for which the user intends to make a bill payment.
MeterType: This indicates the type of meter the user is paying for and can be either "prepaid" or "postpaid." The field is optional; if omitted in the API request, our server will default the *MeterType* to "prepaid."
amount: This field specifies the amount the user wishes to pay for the electricity bill.
mobile_number: The phone number of the customer making the electricity payment. The mobile_number field is optional and may not be included in the api request
request-id: This is the unique ID you send as the Request ID.