Welcome to the Fetch Electricity Plan IDs API Integration page. This guide will help you integrate our API to fetch a list of all active electricity plan ids on the Sandbox Vtunaija website, including each plan’s ID, name, percentage commission.
curl -X POST https://sandbox.vtunaija.com.ng/api/listelectricity/ \
-H "Authorization: Token YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
}'
{
"status": "success",
"Status": "successful",
"count": 12,
"electricityplanids": [
{
"electricity_plan_id": 1,
"the_electricty_name": "Ikeja Electricity Distribution Company",
"commission_for_basicuser": "0.80%",
"commission_for_premiumuser": "1.00%"
},
{
"electricity_plan_id": 2,
"the_electricty_name": "Eko Electricity Distribution Company",
"commission_for_basicuser": "0.80%",
"commission_for_premiumuser": "0.80%"
},
{
"electricity_plan_id": 3,
"the_electricty_name": "Kano Electricity Distribution Company (KEDCO)",
"commission_for_basicuser": "0.80%",
"commission_for_premiumuser": "0.80%"
},
{
"electricity_plan_id": 4,
"the_electricty_name": "Port Harcourt Electricity Distribution Company (PHED)",
"commission_for_basicuser": "1.50%",
"commission_for_premiumuser": "1.50%"
},
{
"electricity_plan_id": 5,
"the_electricty_name": "Jos Electricity Distribution Company",
"commission_for_basicuser": "0.70%",
"commission_for_premiumuser": "0.70%"
},
{
"electricity_plan_id": 6,
"the_electricty_name": "Ibadan Electricity Distribution Company (IBEDC)",
"commission_for_basicuser": "0.90%",
"commission_for_premiumuser": "0.90%"
}
]
}
This section shows the possible failed API responses and the scenarios when they will be returned. These responses are sent whenever something goes wrong with the API request, such as invalid input, missing API key, inactive account, or wrong request method.
{
"status": "fail",
"Status": "failed",
"message": "Invalid request method. Only POST requests are allowed."
}
- Returned when the request method is not POST.
{
"status": "fail",
"Status": "failed",
"message": "No input data received."
}
- Returned when the POST body is empty.
{
"status": "fail",
"Status": "failed",
"message": "Missing or invalid API key in Authorization header. Format: Authorization: Token {api_key}"
}
- Returned when the Authorization header is missing or incorrectly formatted.
{
"status": "fail",
"Status": "failed",
"message": "API key provided in the API request does not exist on our platform."
}
- Returned when the API key does not exist in the database.
{
"status": "fail",
"Status": "failed",
"message": "Your account is inactive. Please contact support."
}
- Returned when the user’s account status is inactive.
{
"status": "fail",
"Status": "failed",
"message": "Invalid JSON input."
}
- Returned when the POST body contains malformed or invalid JSON.