API Documentation

Electricity Verification API Integration

(Sandbox Environment) Register and Login on the Sandbox Website to get your Sandbox API Key for the Sandbox Integration Click Here

Welcome to the Electricity Verification API Sandbox Integration page. This guide will help you integrate our Sandbox Electricity Verification API into your system.

On Sandbox environment the meter number you are purchasing electricity token for must be 1111111111111 any other meter number that is not 1111111111111 the electricity token purchase request will fail.

Electricty Verification API Request cURL Init Sample


curl -X POST https://sandbox.vtunaija.com.ng/api/billpayment/verify/ \ 
 
-H "Authorization: Token YOUR_API_KEY" \ 

-H "Content-Type: application/json" \ 

-d '{ 

    "disco_name": "1", 

    "meter_number": "289645439", 
  
    "request-id": "879207ty798y0787s" 
          
}'

Successful Electricity Verification API Response Example

This is an example of the response returned for a successful Electricity verification.


{ 

    "Status": "successful", 

    "status": "success", 

    "api_response": "Meter Verification Name gotten successfully",

    "id": "78977865523", 

    "ident": "78977865523", 

    "Customer_Name": "TESTMETER1", 

    "name": "TESTMETER1", 

    "Customer_Address": "ABULE - EGBA BU ABULE" 
  
}

Failed Electricity Verification API Response Example

This is an example of the response returned for a failed Electricity verification.


{ 

    "Status": "failed", 
  
    "status": "fail", 

    "api_response": "Meter Name Verification Failed", 

    "id": "78977865523", 

    "ident": "78977865523" 

}

Failed API Response

This is an example of a failed API response caused by factors such as an incorrect API key, Invalid request method and so on.


{ 

    "Status": "failed", 
 
    "status": "fail", 

    "message": "Invalid request method. Only POST method is allowed", 
         
              
}

Post Terms Defined and Interpreted

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 Sandbox 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. On Sandbox environment the meter number must be 1111111111111 any other meter number that is not 1111111111111 the electricity token purchase request will fail

request-id: This is the unique ID you send as the Request ID.