HTTP API

Developers can use our HTTP APIs to quickly and easily integrate with their systems and applications.

BALANCE CHECK API

Command:
https://mobileairtimeng.com/httpapi/balance.php?userid=xxxx&pass=xxxx

PARAMETERS
Userid = your registered number
pass = api key (available in your vendor area. See V-Home)

AIRTIME TOP UP API

  • Instant Top up GSM networks such as; MTN, Glo, Etisalat, Airtel, Visaphone
  • Dispense Mobile Top up from as low as N50 on all networks.
  • Switch between Instant Sell & Share and VTU
  • E-mail notification to vendor.
  • No activation fee

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

Userid = your registered number
pass = api key (available in your vendor area-VHome)
phone = receiver's number

Replace the network with the system codes

Network

System Code

Airtel

1

9Mobile

2

Visaphone

4

MTN
15

Glo

6


Response Codes
100 - Successful
101 - Account not activated
102 - Invalid amount
103 - Insufficient balance
104 - Invalid user id
105 - Invalid log in
106 - No network selected
107 - Invalid phone
108 - Other Platform errors
109 – Invalid Developer Account
Sample Response: 100|successful

VTU AVAILABLITY STATUS CHECK

This api is useful for anyone using the VTU API along side with an online payment processor. This API returns the status of the VTU API, if it is available (success) or not. So, as a developer using our VTU API, it is advised that you first check the availablity before processing payments.
Command:
https://mobileairtimeng.com/httpapi/vtustatus.php?userid=xxxx&pass=xxxx&network=x&amt=xx
API Response:
success - if service is available at our endpoint
failed - if service is unavailable at our endpoint
Other errors are directly reported as the case may be.

DATA TOP UP API (MTN, ETISALAT, AIRTEL)

Data top up is available for MTN, Airtel and Etisalat.

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

amt = the price for the data
See below data bundle pricing;
MTN
30MB-1day = 100
750MB-7days = 500
1.5GB-30days = 1000
3.5GB-30days = 2000
9Mobile
200MB-7days = 200
1GB-30days = 1000
1.5GB-30days = 1200
2.5GB-30days = 2000
3.5GB-30days = 2500
Airtel
30MB-1day = 100
100MB-3days = 200
750MB-14days = 500
1.5GB-30days = 1000
3.5GB-30days = 2000
5GB-30days = 2500

30MB MTN data top up sample;
https://mobileairtimeng.com/httpapi/datatopup.php?userid=0801111111&pass=abc123&network=15&phone=08135534866&amt=100

IMPORTANT:
Data top up will come in as airtime but would be automatically converted to the particular bundle. A recipient that has borrowed airtime will not receive the data top up because the airtime (or part) would have been deducted before conversion. 
To Check Data balance
Airtel: *123*10# or *140#, Etisalat: *228#, MTN: *131*4# 

 

NB: Startimes API, GOtv API and DStv API requires a one-time activation fee.

STARTIMES API Recharge

  • Recharges Startimes decoder instantly.
  • Sends SMS notification to client or customer
  • Sends SMS notification to vendor.

Command:
https://mobileairtimeng.com/httpapi/startimes.php?userid=xxx&pass=xxx&phone=xxx&amt=xxx&smartno=xxx

Response Codes
Same as above (VTU API)
202 - Empty Smart card no
205 - Service error

Commission/Discount: As shown on commission table here.

GOTV RECHARGE API

  • Recharges GOtv decoder instantly.
  • Sends SMS notification to client or customer
  • Sends SMS/Email notification to vendor.

Command:
https://mobileairtimeng.com/httpapi/gotv.php?userid=xxx&pass=xxx&phone=xxx&plan=xxx&smartno=xxx

smartno = decoder number
plan = recharge or bouquet
plan is as stated below;
1 = GOtv Mobile (N630)
2 = Gotv (N1,250)
3 = Gotv Plus (N1,900)
4 = GOtv Lite monthly (N400)
5 = GOtv Lite Quartely (N1,200)
6 = GOtv Lite Annual (N3,250)

DSTV RECHARGE API

  • Recharges Dstv decoder instantly.
  • Sends SMS notification to client or customer
  • Sends SMS/Email notification to vendor.

Command:
https://mobileairtimeng.com/httpapi/dstv.php?userid=xxx&pass=xxx&phone=xxx&plan=xxx&smartno=xxx

smartno = decoder number
plan = recharge or bouquet
plan is as stated below;
1 = Access (N1,900)
2 = Family (N3,800)
3 = Compact (N6,300)

Check Customer Information API (Startimes, DStv/Gotv)

Returns the name of the user registered on the decoder.

Command:
https://mobileairtimeng.com/httpapi/blookup.php?userid=xxx&pass=xxx&bill=xxx&smartno=xxx

bill = startimes, gotv or dstv
smartno = smart card no, decoder no or ICU

NB: Startimes API, GOtv API and DStv API requires a one-time activation fee of N15,000. Access to other DStv bouqet/packages requires an intial deposit of N50,000.

Bulk SMS API

Bulk SMS API comes with detailed reporting. Failed SMS will not be charged. Pricing is determined by vendor level. See SMS pricing on the home page

Command: https://www.mobileairtimeng.com/smsapi/bulksms.php
POST parameters
username=xxx
password=xxx
message=xxx
mobile=xxx
sender=xxx
route=x
vtype=1

username = Your registered phone 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
route = 1
vtype = 1 (for vendors)

Response Codes and Format
Success messages comes with 2001 while failed or rejected messages comes with 2002
Successful message format:
2001|phone|message sent e.g. 2001|2348135534866|message sent
Failed or Rejected SMS:
2002|phone|reason e.g. 2002|2348135534866|dnd rejected
Bulk numbers separated by comma:
The responses are also separated by comma e.g.
2001|2348139170491|message sent,2001|2348135534866|message sent

Do you have enquiries? Please contact us here