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

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

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

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
: Response is separated by pipe( | ); code | responseMessage
A successful recharge; 100|Recharge successful

Sample JSON Response: {"code":100,"message":"Recharge successful"}

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

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

amt = the price for the data.
See below data bundle pricing;
MTN
50MB-1day = 100
750MB-14days = 500
1GB-30days = 1000
1.5GB-30days = 1200
2.5GB-30days = 2000
5GB-30days = 3500
10GB-30days = 5000
22GB-30days = 10000
9Mobile
150MB-7days = 200
1GB-30days = 1000
1.5GB-30days = 1200
2.5GB-30days = 2000
3.5GB-30days = 2500
Airtel
50MB-1day = 100
100MB-3days = 200
750MB-14days = 500
1.5GB-30days = 1000
3.5GB-30days = 2000
5GB-30days = 2500
GLO
80MB-24hrs = 100
210MB-5days = 200
800MB-14days = 500
1.6GB-30days = 1000
3.65GB-30days = 2000
5.75GB-30days = 2500
7GB-30days = 3000

50MB 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#, GLO: *127*0#

CHECK CUSTOMER INFORMATION API (Startimes, DStv/Gotv)

This is required to validate customer before recharging decoder.

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

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

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

Response
Response is a string separated by pipe ( | ).
100|customerName|balance
JSON Sample
{"code":100,"customerName":"Alex Jones ","balance":60}

customerName = customer name
balance = customer balance

Failed Response
101|message
{"code":104,"message":"invalid account"}

GOtv/DStv Successful Reponse
Response string separated with pipe;
100|customerName|decoderStatus|dueDate|invoicePeriod|customerNumber

JSON Response
{"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 = customer number on GOtv or DStv

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

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?userid=xxx&pass=xxx&phone=xxx&amt=xxx&smartno=xxx

Command (JSON):
https://mobileairtimeng.com/httpapi/startimes?userid=xxx&pass=xxx&phone=xxx&amt=xxx&smartno=xxx&jsn=json
amt = amount to recharge
phone = phone number to receive SMS notification
smartno = smart card number

Response
Response is a string separated by pipe ( | ). Below is a typical successful operation;
100|Successful|exchangeReference|responseMessage

JSON Response
{"code":100,"message":"Successful","exchangeReference":"177269","responseMessage":"operation successful"}

message = status message
exchangeReference = Unique reference number generated on Startimes platform
responseMessage = return message from Startimes

GOTV/DSTV RECHARGE API

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

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

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

smartno = decoder number
customer = customer name received during customer check
invoice = invoice number received during customer check
billtype = gotv or dstv
amt = recharge or bouquet in amount.
customernumber = customer number received during customer check

For Gotv;
- 400 = Gotv Lite
- 1250 = Gotv value
- 1900 = Gotv Plus
- 3200 = Gotv Max
You can also use any amount that is available for Gotv.

For Dstv
2000 = Dstv Access
4000 = Dstv Family
6800 = Compact
You can also use any amount that is available for Dstv.

Response:
Successful response;
100|Successful|exchangeReference

JSON Response
{"code":100,"message":"Successful","exchangeReference":"112377269"}
message = status message
exchangeReference = Unique reference number generated on MultiChoice platform

Failed;
101|message
{"code":103,"message":"invalid log in"}

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
normal route = 1
corporate route (Delivery to DND)= 2
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