Mobile Airtime NG API

Developers can use our HTTP APIs to quickly and easily integrate with their systems and applications.
You can get your responses in simple text or json. To get a json response add jsn=json to the parameter.
Success code response: 100
Error codes: 101 or 104
Any other code apart from 100 is a failed response

CHECK BALANCE

https://mobileairtimeng.com/httpapi/balance?userid=xxxx&pass=xxxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key (available in the settings page in your vendor account)

RESPONSES
FAILED: 104|Invalid User id OR {"code":104,"message":"Invalid User id"}
SUCCESS: 2000 OR {"code":100,"message":"2000"}

AIRTIME TOP UP API - VTU API

https://mobileairtimeng.com/httpapi/?userid=xxxx&pass=xxxx&network=x&phone=xxxxx&amt=xx&user_ref=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key (available in the settings page in your vendor account)
phone = receiver's number
user_ref= user defined reference (optional)
network= network Id. See network IDs below;
* MTN VTU = 15
* MTN AWUFU = 20
* GLO = 6
* Airtel = 1
* 9Mobile = 2

RESPONSES
FAILED: {"code":101,"message":"Invalid amount"}
SUCCESS: {"code":100,"message":"Recharge successful"}

Any other response code apart from 100 is failed

MTN SHARE N SELL API

https://mobileairtimeng.com/httpapi/msharesell?userid=xxxx&pass=xxxx&phone=xxxxx&amt=xx&user_ref=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key (available in the settings page in your vendor account)
phone = receiver's number
user_ref= user defined reference (optional)

RESPONSES
FAILED: {"code":101,"message":"Invalid amount"}
SUCCESS: {"code":100,"message":"Recharge successful"}

Any other response code apart from 100 is failed

CHECK TRANSACTION

https://mobileairtimeng.com/httpapi/status?userid=xxxx&pass=xxxx&transid=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key (available in the settings page in your vendor account)
transid= user defined reference

RESPONSES
SUCCESS: {"code":100,"recipient":"08132903101","amount_charged":200,"message":"completed","current_status":"completed"}
current_status values; completed, processing, pending, refunded

FAILED: {"code":104,"message":"Invalid User id"}

MTN CORPORATE DATA GIFTING LITE API

https://mobileairtimeng.com/httpapi/cdatashare?userid=xxxx&pass=xxxx&network=x&phone=xxxxx&datasize=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key (available in the settings page in your vendor account)
phone = receiver's number
user_ref= user defined reference (optional)
network= network Id which is 1 for MTN
datasize = bundle (500, 1000 etc)
* 500MB = 500
* 1GB = 1000
* 2GB = 2000
* 3GB = 3000
* 5GB = 5000
* 10GB = 10000

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"message":"Recharge successful"}
Any other response code apart from 100 is failed

MTN DATA SHARE API

https://mobileairtimeng.com/httpapi/datashare?userid=xxxx&pass=xxxx&network=x&phone=xxxxx&datasize=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
phone = receiver's number
user_ref= user defined reference (optional)
network= network Id which is 1 for MTN
datasize = bundle (500, 1000 etc)
* 500MB = 500
* 1GB = 1000
* 2GB = 2000
* 3GB = 3000
* 5GB = 5000
* 10GB = 10000

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"message": "Data recharge completed","user_ref":"ywyq13e", "amount_charged":240.54 , "current_status":"completed", "true_response":"Dear Customer, You have successfully shared 1GB Data to 2348135534866. Your SME data balance is 7321.04GB expires 24/02/2024. Thankyou"}
Due to network issues, the data might not deliver instantly, so the current_status is used to determine the actual state of the transaction.
The "current_status" will have any of these values; completed, processing, pending, failed
Any other response code apart from 100 is failed

AIRTEL CG DATA API

https://mobileairtimeng.com/httpapi/airtel_data_share?userid=xxxx&pass=xxxx&phone=xxxxx&datasize=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
phone = receiver's number
user_ref= user defined reference (optional)
datasize = bundle (500, 1000 etc)
* 500MB = 500
* 1GB = 1000
* 2GB = 2000
* 5GB = 5000
* 10GB = 10000
* 15GB = 15000
* 20GB = 20000

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"Data recharge completed","user_ref":"12333", "amount_charged":240.54 , "current_status":"completed", "true_response":"You have successfully gifted 2348128496819 with 2GB of Data. valid till 2/16/2024 12:00:00 PM"}
Due to network issues, the data might not deliver instantly, so the current_status is used to determine the actual state of the transaction.
Any other response code apart from 100 is failed

AIRTEL DATA AWOOF API

https://mobileairtimeng.com/httpapi/airtel_data_share?userid=xxxx&pass=xxxx&phone=xxxxx&plantype=sme&planid=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
phone = receiver's number
user_ref= user defined reference (optional)
plantype = sme
planid = Use the get-items api below to obtain the plain ids

GET PLAN IDS
https://mobileairtimeng.com/httpapi/get-items?userid=xxxx&pass=xxxxx&service=airtel-awoof

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"Data recharge completed","user_ref":"12333", "amount_charged":240.54 , "current_status":"completed", "true_response":"You have successfully gifted 2348128496819 with 2GB of Data. valid till 2/16/2024 12:00:00 PM"}
Any other response code apart from 100 is failed

GLO CG DATA API

https://mobileairtimeng.com/httpapi/glo_data_share?userid=xxxx&pass=xxxx&phone=xxxxx&datasize=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
phone = receiver's number
user_ref= user defined reference (optional)
datasize = bundle (500, 1000 etc)
* 500MB = 500
* 1GB = 1000
* 2GB = 2000
* 5GB = 5000
* 10GB = 10000

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"message":"Data recharge completed" , "user_ref":"Awe312", "amount_charged":247.34, "current_status":"completed", "true_response":"You have successfully gifted 2348059320056 with 2GB of Data."}
Any other response code apart from 100 is failed

9Mobile SME API

https://mobileairtimeng.com/httpapi/nine_data_share?userid=xxxx&pass=xxxx&phone=xxxxx&datasize=xx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
phone = receiver's number
user_ref= user defined reference (optional)
datasize = bundle (500, 1000 etc)
* 500MB = 500
* 1GB = 1000
* 2GB = 2000
* 5GB = 5000

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS: {"code":100,"message":"Data recharge completed" , "user_ref":"78437875Q", "amount_charged":113.72, "current_status":"completed", "true_response":"Dear Customer, You have successfully shared 5.0GB with 08177481049, please dial *232# to check your balance,. Thank you."}
Any other response code apart from 100 is failed

WEBHOOK

Parameters are sent via POST to your URL, so you should receive the parameters via POST
Ensure you add your URL in the settings section on the website/app.

PARAMETERS THAT WILL BE SENT
status = current status of the transaction; completed, processing, pending, refunded
destination = recipient
service = type of service; mtn data share, airtel data share, glo data share etc
amt_charged = amount debited from wallet
user_ref = user defined reference
true_response = Response got directly from the network provider

DIRECT DATA BUNDLE TOP UP API (MTN, GLO, ETISALAT, AIRTEL)

PARAMETERS
userid = your registered number
pass = api key
phone = receiver number
user_ref= user defined reference (optional)
network= network Id as shown in the Airtime API
amt = the price for the data

Use this API to get the product list and price for each network;
https://mobileairtimeng.com/httpapi/get-items?userid=xxx&pass=xxx&service=mtn&jsn=json
https://mobileairtimeng.com/httpapi/get-items?userid=xxx&pass=xxx&service=airtel&jsn=json
https://mobileairtimeng.com/httpapi/get-items?userid=xxx&pass=xxx&service=glo&jsn=json
https://mobileairtimeng.com/httpapi/get-items?userid=xxx&pass=xxx&service=9mobile&jsn=json

RESPONSES
FAILED: {"code":104,"message":"Invalid User id"}
SUCCESS (MTN/GLO/9MOBILE SAMPLE): {"response":"OK","products":[{"data":"25MB (1 Days)","amount":50},{"data":"100MB (1 Days)","amount":100},{"data":"650MB (1 Days)","amount":200},{"data":"1GB (1 Days)","amount":300},{"data":"500MB (30 Days)","amount":500},{"data":"1.5GB (30 Days)","amount":1000},{"data":"2GB (30 Days)","amount":1200},{"data":"7GB (7 Days)","amount":1500},{"data":"4.5GB (30 Days)","amount":2000},{"data":"11GB (30 Days)","amount":4000},{"data":"15GB (30 Days)","amount":5000},{"data":"40GB (30 Days)","amount":10000},{"data":"75GB (30 Days)","amount":15000}]}
SUCCESS (AIRTEL SAMPLE): {"response":"OK","products":[{"id":"D-MFIN-1-40MB","data":"40MB (1 day)","amount":"49.99"},{"id":"D-MFIN-1-100MB","data":"100MB (1 day)","amount":"99.00"},{"id":"D-MFIN-1-200MB","data":"200MB (3 days)","amount":"199.03"},{"id":"D-MFIN-1-350MB","data":"350MB (7 days)","amount":"299.02"}]}

Data Top up API (MTN/GLO/9MOBILE)

https://mobileairtimeng.com/httpapi/datatopup?userid=xxxx&pass=xxxx&network=x&phone=xxxxx&amt=xx&jsn=json

Data Top up API (AIRTEL)

https://mobileairtimeng.com/httpapi/datatopup?userid=xxxx&pass=xxxx&network=x&phone=xxxxx&product=xx&jsn=json

In the Airtel data top up API, product ID is required which is obtained from the product list.

WAEC PIN API

https://mobileairtimeng.com/httpapi/waecdirect?userid=xxxx&pass=xxxx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key

RESPONSES
FAILED: {"code":103,"message":"Insufficient balance in wallet!"}
SUCCESS: {"code":100,"serial":"38787","pin":"128981"}

NECO TOKEN API

https://mobileairtimeng.com/httpapi/neco?userid=xxxx&pass=xxxx&pcs=1&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
pcs = no of pins

RESPONSES
FAILED: {"code":103,"message":"Insufficient balance in wallet!"}
SUCCESS: {"code":100,"pin":"128981"}
Any other response code apart from 100 is failed

VERIFY CUSTOMER (STARTIMES, GOTV, DSTV)

https://mobileairtimeng.com/httpapi/customercheck?userid=xxx&pass=xxx&bill=xxx&smartno=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key
bill = startimes, gotv or dstv
smartno = smart card number or IUC number

RESPONSES
FAILED: {"code":104,"message":"invalid account"}
SUCCESS STARTIMES: {"code":100,"customerName":"Alex Jones ","balance":60}
SUCCESS DSTV/GOTV: {"code":100,"customerName":"Alex Jones ","decoderStatus":"opened","dueDate":"2018-10-09","invoicePeriod":1,"customerNumber":128392}

customerName = Full name of customer
decoderStatus = OPENED/CLOSED
dueDate = Subscription expiration date
invoiceDate = months
customerNumber = unique customer number registered by multichoice

GET PACKAGES (STARTIMES, GOTV, DSTV)

STARTIMES
https://mobileairtimeng.com/httpapi/get-items?userid=xxxx&pass=xxx&service=startimes-u&jsn=json

GOTV
https://mobileairtimeng.com/httpapi/get-items?userid=xxxx&pass=xxx&service=gotvw&jsn=json

DSTV
https://mobileairtimeng.com/httpapi/get-items?userid=xxxx&pass=xxx&service=dstvw&jsn=json

STARTIMES RECHARGE API

https://mobileairtimeng.com/httpapi/startimes-u?userid=xxx&pass=xxx&phone=xxx&amt=xxx&smartno=xxx&vcode=xxx&jsn=json&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key
amt = amount to recharge
phone = phone number for notification
smartno = smart card number
vcode = product code obtained from the get packages API
user_ref= user defined reference

RESPONSES
FAILED: {"code":103,"message":"Insufficient balance in wallet!"}
SUCCESS: {"code":100,"message":"Successful","exchangeReference":"177269","responseMessage":"operation successful"}
Any other response code apart from 100 is failed

GOTV/DSTV RECHARGE API

https://mobileairtimeng.com/httpapi/multichoice?userid=xxx&pass=xxx&phone=xxx&amt=xxx&smartno=xxx&product=xxx&customer=xxx&invoice=x&billtype=xx&customernumber=x&jsn=json

PARAMETERS
userid = your registered number
pass = api key
smartno = decoder number
customer = customer name received during customer check
invoice = invoice number received during customer check
billtype = gotv or dstv
product = product code obtained from the get packages API
amt = recharge or bouquet in amount.
customernumber = unique customer number retrieved during customer check, this is not the phone number or IUC number

RESPONSES
FAILED: {"code":104,"message":"Insufficient balance in wallet!"}
SUCCESS: {"code":100,"message":"Successful","exchangeReference":"112377269"}

ELECTRICITY API

Get Available Electricity Companies (DISCOS)
http://mobileairtimeng.com/httpapi/power-lists?userid=xxx&pass=xxx

{"response":"OK","result":[{"product_id":"BPE-NGIE-OR","name":"Ikeja Electric","hasProductList":false,"hasValidation":true,"openRange":true,"min_denomination":"500","max_denomination":"50000","step":100},{"product_id":"BPE-NGIB-OR","name":"Ibadan Distribution","hasProductList":false,"hasValidation":true,"openRange":true,"min_denomination":"1000","max_denomination":"50000","step":100}]}

Validate Customer Meter Number
http://mobileairtimeng.com/httpapi/power-validate?userid=xxx&pass=xxx&service=xxx&meterno=xxx&jsn=json

PARAMETERS
service - the product_id of the Electricity company/DISCO
meterno - customer meter number

RESPONSES
FAILED: {"code":104,"message":"Invalid user id"}
SUCCESS: {"code":100,"message":"Nwobodo C"}

Pay Electricity Bills
http://mobileairtimeng.com/httpapi/power-pay?userid=xxx&pass=xxx&user_ref=xxx&service=xxx&meterno=xxx&mtype=xxx&amt=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key
service - the product_id of the Electricity company/DISCO
user_ref - unique user defined reference (useful for querying transaction) meterno - customer meter number
mtype - meter type, 1 for prepaid, 0 for postpaid.

RESPONSES
FAILED: {"code":103,"message":"Insufficient balance in wallet!"}
SUCCESS: {"code":100,"message":"Recharge successful","user_ref":"ibk748737","meterno":"36565","pincode":"08205597303581330549","pinmessage":"CreditToken:08205597303581330549 / TranId:106208046 / Value:22.4. Thank you for using the service. Ikeja Electric.\Recharge: 500"}
Any other response code apart from 100 is failed

SEND MONEY

Get Banks List

https://mobileairtimeng.com/money-transfer/get_banks_list

Verify Account Number

https://mobileairtimeng.com/money-transfer/get-account?userid=xxx&pass=xxx&accno=xxx&bankcode=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key
accno= account number
bankcode= bank code (retrieved from the Get Bank List API)

RESPONSES
FAILED: {"code":104,"message":"Invalid user id"}
SUCCESS: {"status":"success","message":" IBK INFORMATION TECHNOLOGY"}

Transfer Money

https://mobileairtimeng.com/money-transfer/send-money?userid=xxx&pass=xxx&accno=xxx&bankcode=xxx&amount=xxx&reference=xxx&caption=xxx&jsn=json

PARAMETERS
userid = your registered number
pass = api key
accno= account number
bankcode= bank code (retrieved from the Get Bank List API)
amount= amount you want to transfer (minimum of 200)
reference= user defined reference
caption= a short identifier

RESPONSES
{"status":"success", "ref":123441, "message":"Request received"}
{"status":"pending", "ref":355434, "message":"Transaction in progress"}
{"status":"failed", "ref": "none", "message":"Transfer failed"}

HLR API

https://mobileairtimeng.com/httpapi/hlrlook?userid=xxx&pass=xxx&phone=xxx&user_ref=xxx

PARAMETERS
userid = your registered number
pass = api key

RESPONSES
FAILED: {"status":"failed","reason":"Rejected by Destination"}
SUCCESS: {"status":"success","ported":"YES","mccmnc":"62160","country":"Nigeria","imsi":"62160","operator":"MTN"}

Verificode (Whatsapp) API

https://mobileairtimeng.com/httpapi/verificode

PARAMETERS
The parameter used here is POST not GET
userid = your registered number
pass = api key
phone = receipent phone number in international format without (+) e.g. 23480xxxx.
message = message to send

RESPONSES
SUCCESS: {"code":100, "message":"Message sent"}
FAILED: {"code":103,"message":"invalid message"}
Any other response code apart from 100 is failed

BULK SMS API

https://mobileairtimeng.com/smsapi/bulksms

PARAMETERS
The parameter used here is POST not GET
username = your registered number
password= api key
message = message to send
mobile = recipients format e.g 081xxx,080xxx,070xxx. Separate multiple numbers with comma
sender = caption to display to recipients. Max of 11 characters
jsn = json

RESPONSES
For successful transaction here, code is 2001
SUCCESS(SINGLE SMS): {"status":"OK","response":{"code":2001,"phone":"2348139170491","response":"message sent"}}
SUCCESS(BULK SMS):{"status":"OK","response":[{"code":2001,"phone":"2348139170491","response":"message sent"},{"code":2001,"phone":"2348066550949","response":"message sent"}]} FAILED: {"status":"OK","code":2002, "phone":"08134233456","response":"Rejected by Destination"}

Do you have enquiries? Please contact us here