Electricity API Integration
Electricity API Integration
This section contains your RESTful API for Electricity API integration..
Electricity API Integration
Electricity API Integration
This section contains your RESTful API for Electricity API integration..
The VTU Africa API uses API Key for Authentication.
Please use your APIKEY for authentication
Live URL: https://vtuafrica.com.ng/portal/api/electric/
Sandbox: https://vtuafrica.com.ng/portal/api-test/electric/
Parameters: as specified in the parameters below:
| PARAMETERS | Required/Optional | TYPE | DESCRIPTION |
| apikey | R | String | The reseller gateway API key created at vtuafrica.com.ng |
| service | R | String | Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-electric, etc |
| meterNo | R | Number | The meter number to load the electricity token |
| metertype | R | String | This is the meter type. Example: prepaid or postpaid |
| amount | R | Number | The amount of electricity token you want to buy |
| ref | R | String | This is a unique reference with which you can use to execute and query the transaction. |
| webhookURL | R | String | Your webhook URL. We send transaction status and Electric Token to it. If not provided, the webhook in your profile will be used. |
SAMPLE CODE
$sandbox = "https://vtuafrica.com.ng/portal/api-test/electric/?apikey=1234&service=jos-electric&meterNo=100233&metertype=prepaid&amount=500&ref=826633"; $host = "https://vtuafrica.com.ng/portal/api/electric/?apikey=1234&service=ikeja-electric&meterNo=100221233&metertype=prepaid&amount=1000&ref=828466633"; //Initialize cURL. $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $host); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); $data = curl_exec($ch); //Close the cURL handle. curl_close($ch); $response = json_decode($data);
EXPECTED RESPONSE
{"code":101,
"description":{"Status":"Completed","ProductName":"Ikeja Electricity Payment",
"MeterNumber":"100221233","MeterType":"prepaid","Token":"2345786765","Unit":"25wat",
"Request_Amount":"500","Amount_Charged":"495","Previous_Balance":"1000",
"Current_Balance":"505","ReferenceID":"828466633","message":"Recharge Successful"
}
}
| Company | Service Code | Minimum Amount |
| Aba Electricity Distribution Company | aba-electric | |
| Abuja Electricity Distribution Company | abuja-electric | |
| Benin Electricity Distribution Company | benin-electric | |
| Eko Electricity Distribution Company | eko-electric | |
| Enugu Electricity Distribution Company | enugu-electric | |
| Ibadan Electricity Distribution Company | ibadan-electric | |
| Ikeja Electricity Distribution Company | ikeja-electric | |
| Jos Electricity Distribution Company | jos-electric | |
| Kaduna Electricity Distribution Company | kaduna-electric | |
| Kano Electricity Distribution Company | kano-electric | |
| Port Harcourt Electricity Distribution Company | portharcourt-electric | |
| Yola Electricity Distribution Company | yola-electric |