VTU API for Airtime, Data (MTN, Glo, Airtel & 9mobile), Cable TV (DSTv, GOTv & Startimes) Subscription and Electricity Bills Payment in Nigeria

The eBills API is an HTTPS GET API that allows you (developers) to integrate all virtual top-up (VTU) and bills payment services available on the eBills.ng platform with your application (websites, desktop apps & mobile apps). You can also start your own VTU business by integrating our VTU API and be reselling our services in Nigeria.

As an API user, you will enjoy even cheaper prices. You will get 1GB at ₦239; 3% discounts on airtime; 1.5% discounts on cable TV subscription; 1% discounts on electricity bills payment; and ₦0.00 service fees. Please see pricing for more information.

Alright, let me tell you. We have built an internal infrastructure for the best SIM hosting capabilities. We have many SIMs internally hosted on our dedicated server. These SIMs automatically get VTU requests in milliseconds and they constantly deliver our VTU services instantly by dialling the required USSD codes and sending SMSs where necessary. We have also connected our cable TV subscription and electricity bill payment services directly to the providers’ gateways (Premium Direct Connections). We also leverage direct connections to banks where necessary. Now you truly know why we are cheap and reliable.

Here, you will get all premium recharge APIs. From airtime vending API (recharge cards API) to data reselling API to bills payment API. All failed orders are refunded automatically. We are unarguably the best VTU API provider in Nigeria.

Note: You must have a reseller account with us to use our API.

API Integration

Unfortunately, we currently do not have the Sandbox environment where you can do your tests on but don’t get frightened, our HTTPS GET API is very easy to integrate. With the help of our super free VTU API documentation below, you can safely write your codes, believing that it will work and it will work as long as it’s about our simple yet robust API.

API BASE URL

The Live API BASE URL: https://ebills.africa/wp-json/api/v1/

Authentication

The eBills.ng API uses Basic Authentication. You need to always pass your username and password as part of the URL parameters.

Request Methods

All requests methods are GET.

Response

All responses from the eBills.ng API are returned in the JSON format.

Available Products and Services on the eBills.ng API include:

Balance
Airtime
Data
Customer Verification
Cable TV
Electricity

How to Get eBills.ng Wallet Balance via eBills.ng HTTP API

Wallet Balance Endpoint URL: https://ebills.africa/wp-json/api/v1/balance

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account

Example [Getting Wallet Balance]

https://ebills.africa/wp-json/api/v1/balance?username=Frank&password=123456

Sample Response on Success

{"code":"success","message":"Wallet balance successfully retrieved","data":{"balance":"120067.65","currency":"NGN"}}

Sample Response on Failure

{"code":"invalid_username","message":"Unknown username. Check again or try your email address.","data":null}

How to Purchase Airtime (MTN, Glo, Airtel & 9mobile) via eBills.ng HTTP API

Airtime Endpoint URL: https://ebills.africa/wp-json/api/v1/airtime

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account
phone	09123550994	The phone number that will receive the airtime
network_id	mtn	The network_id is used to make each network unique. They include mtn, glo, airtel and etisalat. Notice that they are all in small letters.
amount	2000	The amount of airtime you want to purchase

Example [Purchasing Airtime]

https://ebills.africa/wp-json/api/v1/airtime?username=Frank&password=123456&phone=09123550994&network_id=mtn&amount=2000

Sample Response on Success

{"code":"success","message":"Airtime successfully delivered","data":{"network":"MTN","phone":"09123550994","amount":"NGN2000","order_id":"3100"}}

Sample Response on Failure

{"code":"failure","message":"Your wallet balance (NGN1067.65) is insufficient to make this airtime purchase of NGN2000","order_id":"3289"}

How to Purchase Data (MTN, Glo, Airtel & 9mobile) via eBills.ng HTTP API

Data Endpoint URL: https://ebills.africa/wp-json/api/v1/data

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account
phone	09123550994	The phone number that will receive the data
network_id	mtn	The network_id is used to make each network unique. They include mtn, glo, airtel and etisalat. Notice that they are all in small letters.
variation_id	M1024	The variation ID of the data plan you want to purchase. They are as follows: 500 = MTN Data 500MB – 30 Days M1024 = MTN Data 1GB – 30 Days M2024 = MTN Data 2GB – 30 Days 3000 = MTN Data 3GB – 30 Days 5000 = MTN Data 5GB – 30 Days 10000 = MTN Data 10GB – 30 Days mtn-20hrs-1500 = MTN Data 6GB – 7 Days mtn-30gb-8000 = MTN Data 30GB – 30 Days mtn-40gb-10000 = MTN Data 40GB – 30 Days mtn-75gb-15000 = MTN Data 75GB – 30 Days glo100x = Glo Data 1GB – 5 Nights glo200x = Glo Data 1.25GB – 1 Day (Sunday) G500 = Glo Data 1.35GB – 14 Days G2000 = Glo Data 5.8GB – 30 Days G1000 = Glo Data 2.9GB – 30 Days G2500 = Glo Data 7.7GB – 30 Days G3000 = Glo Data 10GB – 30 Days G4000 = Glo Data 13.25GB – 30 Days G5000 = Glo Data 18.25GB – 30 Days G8000 = Glo Data 29.5GB – 30 Days glo10000 = Glo Data 50GB – 30 Days airt-1100 = Airtel Data 1.5GB – 30 Days airt-1300 = Airtel Data 2GB – 30 Days airt-1650 = Airtel Data 3GB – 30 Days airt-2200 = Airtel Data 4.5GB – 30 Days airt-3300 = Airtel Data 10GB – 30 Days airt-5500 = Airtel Data 20GB – 30 Days airt-11000 = Airtel Data 40GB – 30 Days airt-330x = Airtel Data 1GB – 1 Day airt-550 = Airtel Data 750MB – 14 Days airt-500x = Airtel Data 2GB – 2 Days airt-1650-2 = Airtel Data 6GB – 7 Days 9MOB1000 = 9mobile Data 1GB – 30 Days 9MOB34500 = 9mobile Data 2.5GB – 30 Days 9MOB8000 = 9mobile Data 11.5GB – 30 Days 9MOB5000 = 9mobile Data 15GB – 30 Days

Example [Purchasing Data]

https://ebills.africa/wp-json/api/v1/data?username=Frank&password=123456&phone=09123550994&network_id=mtn&variation_id=M1024

Sample Response on Success

{"code":"success","message":"Data successfully delivered","data":{"network":"MTN","data_plan":"MTN Data 1GB – 30 Days","phone":"09123550994","amount":"NGN259","order_id":"2443"}}

Sample Response on Failure

{"code":"failure","message":"Invalid data variation_id. Please, crosscheck and enter the correct variation_id.","order_id":"3456"}

How to Verify Customers via eBills.ng HTTP API

We advise that you always verify the customer’s details before submitting requests to purchase the service (cable TV or electricity). The eBills.ng customer verification endpoint allows you to get the customer’s full name, address and many more.

Customer Verification Endpoint URL: https://ebills.africa/wp-json/api/v1/verify-customer

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account
customer_id	62418234034	This is either the customer’s smartcard number or the meter number
service_id	ikeja-electric	The service_id is unique for all cable TV and electricity services. They include dstv, gotv, startimes, abuja-electric, eko-electric, ibadan-electric, ikeja-electric, jos-electric, kaduna-electric, kano-electric and portharcout-electric. Notice that they are all in small letters.
variation_id	prepaid	The meter type of the electricity company. This is only required for verifying the electricity customers and not required for cable TV customer verification.

Example [Verifying Customers]

https://ebills.africa/wp-json/api/v1/verify-customer?username=Frank&password=123456&customer_id=62418234034&service_id=ikeja-electric&variation_id=prepaid

Sample Response on Success

{"code":"success","message":"Customer details successfully retrieved","data":{"customer_id":"62418234034","customer_name":"FIRSTNAME LASTNAME","customer_address":"10 Example Street, Town, State","customer_arrears":"0.00","decoder_status":null,"decoder_due_date":null,"decoder_balance":null}}

Sample Response on Failure

{"code":"failure","message":"Invalid Meter Number"}

How to Purchase/Subscribe Cable TV (DSTv, GOTv & Startimes) via eBills.ng HTTP API

Cable TV Endpoint URL: https://ebills.africa/wp-json/api/v1/tv

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account
phone	09123550994	The phone number that will be stored for reference
service_id	gotv	The service_id is used to make each cable TV unique. They include dstv, gotv, and startimes. Notice that they are all in small letters.
smartcard_number	7032400086	The smartcard/IUC number of the decoder that should be subscribed
variation_id	gotv-max	The variation ID of the cable TV package/bouquet you want to purchase. They are as follows: dstv-padi = DStv Padi dstv-yanga = DStv Yanga dstv-confam = DStv Confam dstv6 = DStv Asia dstv79 = DStv Compact dstv7 = DStv Compact Plus dstv3 = DStv Premium dstv10 = DStv Premium Asia dstv9 = DStv Premium-French confam-extra = DStv Confam + ExtraView yanga-extra = DStv Yanga + ExtraView padi-extra = DStv Padi + ExtraView com-asia = DStv Compact + Asia dstv30 = DStv Compact + Extra View com-frenchtouch = DStv Compact + French Touch dstv33 = DStv Premium – Extra View dstv40 = DStv Compact Plus – Asia com-frenchtouch-extra = DStv Compact + French Touch + ExtraView com-asia-extra = DStv Compact + Asia + ExtraView dstv43 = DStv Compact Plus + French Plus complus-frenchtouch = DStv Compact Plus + French Touch dstv45 = DStv Compact Plus – Extra View complus-french-extraview = DStv Compact Plus + FrenchPlus + Extra View dstv47 = DStv Compact + French Plus dstv48 = DStv Compact Plus + Asia + ExtraView dstv61 = DStv Premium + Asia + Extra View dstv62 = DStv Premium + French + Extra View hdpvr-access-service = DStv HDPVR Access Service frenchplus-addon = DStv French Plus Add-on asia-addon = DStv Asian Add-on frenchtouch-addon = DStv French Touch Add-on extraview-access = ExtraView Access french11 = DStv French 11 gotv-smallie = GOtv Smallie gotv-jinja = GOtv Jinja gotv-jolli = GOtv Jolli gotv-max = GOtv Max gotv-supa= GOtv Supa nova = Startimes Nova basic = Startimes Basic smart = Startimes Smart classic = Startimes Classic super = Startimes Super

Example [Purchasing Cable TV]

https://ebills.africa/wp-json/api/v1/tv?username=Frank&password=123456&phone=09123550994&service_id=gotv&smartcard_number=7032400086&variation_id=gotv-max

Sample Response on Success

{"code":"success","message":"Cable TV subscription successfully delivered","data":{"cable_tv":"GOtv","subscription_plan":"GOtv Max","smartcard_number":"7032400086","phone":"09123550994","amount":"NGN3280","amount_charged":"NGN3247.2","service_fee":"NGN0.00","order_id":"2876"}}

Sample Response on Failure

{"code":"failure","message":"Invalid Smartcard Number","order_id":"3652"}

How to Purchase/Pay Electricity Bills via eBills.ng HTTP API

You can purchase electricity through our API and get an instant token for prepaid meters.

Electricity Endpoint URL: https://ebills.africa/wp-json/api/v1/electricity

Request Method: GET

Parameters

Field Name	Example Value	Description
username	Frank	The login username/email for your eBills.ng account
password	123456	The login password for your eBills.ng account
phone	09123550994	The phone number that will be stored for reference
meter_number	62418234034	The meter number you want to purchase electricity for
service_id	ikeja-electric	The service_id is used to make each electricity company unique. They are as follows: abuja-electric = Abuja Electricity Distribution Company (AEDC) eko-electric = Eko Electricity Distribution Company (EKEDC) ibadan-electric = Ibadan Electricity Distribution Company (IBEDC) ikeja-electric = Ikeja Electricity Distribution Company (IKEDC) jos-electric = Jos Electricity Distribution PLC (JEDplc) kaduna-electric = Kaduna Electricity Distribution Company (KAEDCO) kano-electric = Kano Electricity Distribution Company (KEDCO) portharcourt-electric = Port Harcourt Electricity Distribution Company (PHED)
variation_id	prepaid	The meter type of electricity company you want to purchase. It is either prepaid or postpaid
amount	8000	The amount of electricity you want to purchase

Example [Purchasing Electricity]

https://ebills.africa/wp-json/api/v1/electricity?username=Frank&password=123456&phone=09123550994&meter_number=62418234034&service_id=ikeja-electric&variation_id=prepaid&amount=3000

Sample Response on Success

{"code":"success","message":"Electricity bill successfully paid","data":{"electricity":"Ikeja (IKEDC)","meter_number":"62418234034","token":"Token: 5345 8765 3456 3456 1232","units":"47.79kwH","phone":"09123550994","amount":"NGN3000","amount_charged":"NGN2970","order_id":"4324"}}

Sample Response on Failure

{"code":"failure","message":"Invalid Meter Number","order_id":"3907"}

Response Codes

Code	Description
success	The order succeeded and was delivered.
processing	The order is currently processing. It may still be delivered or refunded.
failure	The order failed and your eBills.ng wallet was refunded automatically.
empty_username	The username field is empty.
empty_password	The password field is empty.
invalid_username	Unknown username. Check again or try your email address.
Incorrect_password	The password you entered for the username is incorrect.

VTU API for Airtime, Data (MTN, Glo, Airtel & 9mobile), Cable TV (DSTv, GOTv & Startimes) Subscription and Electricity Bills Payment in Nigeria

Contents

API Integration

API BASE URL

Authentication

Request Methods

Response

Available Products and Services on the eBills.ng API include:

How to Get eBills.ng Wallet Balance via eBills.ng HTTP API

Parameters

Example [Getting Wallet Balance]

Sample Response on Success

Sample Response on Failure

How to Purchase Airtime (MTN, Glo, Airtel & 9mobile) via eBills.ng HTTP API

Parameters

Example [Purchasing Airtime]

Sample Response on Success

Sample Response on Failure

How to Purchase Data (MTN, Glo, Airtel & 9mobile) via eBills.ng HTTP API

Parameters

Example [Purchasing Data]

Sample Response on Success

Sample Response on Failure

How to Verify Customers via eBills.ng HTTP API

Parameters

Example [Verifying Customers]

Sample Response on Success

Sample Response on Failure

How to Purchase/Subscribe Cable TV (DSTv, GOTv & Startimes) via eBills.ng HTTP API

Parameters

Example [Purchasing Cable TV]

Sample Response on Success

Sample Response on Failure

How to Purchase/Pay Electricity Bills via eBills.ng HTTP API

Parameters

Example [Purchasing Electricity]

Sample Response on Success

Sample Response on Failure

Response Codes