VTU, Mobile Airtime & Data Top-up API for Developers

Developers API

Overview
Requirements
URL Format
Authentication
Request Method
Response Format
Test API Credentails
Sample Code (PHP)
Check Wallet Balance
Query Transaction Status
Fetch Data Plan List
Query Phone Number Operator
Topup
Fetch Transaction Records

Convert your excess airtime to cash instantly

Overview

Mobilevtu.com Topup API is designed for developers to easily and seamlesly integrate mobile data and airtime topup functionality on any application using any software programing technology or development platform

The API allow you to programmatically interact with Mobilevtu.com services such as

Mobile Airtime recharge

Mobile Data subscription

Transaction Status Query

Transaction Search

Balance Query

Our API attempts to conform to the RESTful design principles. You interact with the resources exposed through the API by accessing resource collection and element URIs using the HTTP POST.

You will likely need access to a web developer or programmer (if you’re not one) to get the most use out of Mobilevtu.com API.

Access to Mobilevtu.com API is Freely available to all Mobilevtu.com customers

Requirements

In order to interact with Mobilevtu.com Topup API, you must fulfil all of the following requirements;

Have an Active Customer account with Mobilevtu.com

Enabled API Access on your Mobilevtu.com account

Once you have setup an account, simply Login to Mobilevtu.com Portal, navigate to Developers from the main menu to enable API access on your account and access your API credentials

URL Format

Mobilevtu.com API URL is made up of the base URL, the resource URI and an API key. A complete API URL will look like this; https://api.mobilevtu.com/v1/‹API Key›/‹resource URI›

Authentication

All requests to Mobilevtu.com API requires authentication. Our API Authentication is implemented as HTTP Header Authentication over TLS (HTTPS).

To authenticate your request, you need to pass the following parameters as part of your HTTP request headers;

Api-Token: Your account API token
Request-Id: A unique identifier of your current request (must be unique for each request)

Sample Authentication using CURL

       curl --request POST \
         --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/topup' \
         --header 'Api-Token: 33tdg37egsbxyube' \
         --header 'content-type: application/x-www-form-urlencoded'

Request Method

Mobilevtu.com API accept only Form Encoded HTTP POST requests (Array). Any other request method will not be recognized by our API

Response Format

Mobilevtu.com API response (success or error) is returned in JSON data. Response codes are sent via the normal HTTP Response Code,

Sample Success Response

    {
        "request": "check_balance",
        "status":"success",
        "data":{
                "balance": "123",
                "currency": "NGN"
              }
    }

Sample Error Response

    {
        "request":"fetch_data_plans",
        "status":"error",
        "message":"API access not not allowed on this account"
    }

Test API Credentails

The following API credentails can be used for development and test purpose only. Transactions done using these credentails are not treated as live

Test API Key: 8yGf4Ri3UeuwaA44LX1oo0000wDc
Test API Token: HHaBgvjx9gwE88uy66zJjhey8lfd

Sample Code

Below is a PHP example showing how to implement MobileVTU top-up API using cURL. Download Complete Source Code

‹?php
$API_KEY = "your mobile vtu api key";
$API_TOKEN = "your mobile vtu api token";
$body = array('operator'=>'9mobile','type'=>'airtime','value'=>'300','phone'=>'2348012345678');
foreach($body as $key=>$value) { 
	$fields_string .= $key.'='.$value.'&';
}
rtrim($fields_string, '&');
$ch = curl_init();
curl_setopt($ch,CURLOPT_URL,"https://api.mobilevtu.com/v1/".$API_KEY."/topup");
curl_setopt($ch,CURLOPT_POST, count($fields));
curl_setopt($ch,CURLOPT_POSTFIELDS, $fields_string);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_SSL_VERIFYPEER, false);
$headers = array (
	'Api-Token: '.$API_TOKEN,
	'Request-Id: '.time(),
	'content-type: application/x-www-form-urlencoded'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$server_output = curl_exec ($ch); error_log($server_output) ;
curl_close ($ch);
$json_output = json_decode($server_output,true);
if($json_output['status']=="success") {
	//topup was successful. 
} else {
	//something went wrong
}

We have put together a couple of sample scripts with explanation to help you get started with integrating MobileVTU API on your application.

This sample scripts are written in PHP and cURL. Click Here to download the sample PHP code

POST - Check Wallet Balance /check_balance

This API allows you to check your Mobilevtu.com current wallet balance.

Request Parameters

Parameter	Description
currency Optional	Currency to return ballance in (Default value is NGN)

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/check_balance' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'currency=NGN'

Sample Success Response

                {
                    "request": "check_balance",
                    "status":"success",
                    "data":[
                            {"balance": "123",
                            "currency": "NGN"
                          }
                    ]
                }

POST - Query Transaction Status /transaction_status

This API allows you to check the network status of a transaction at Mobilevtu.com using the transaction reference.

Request Parameters

Parameter	Description
transaction_id Required	The full transaction reference to query status

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/transaction_status' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'transaction_id=DJTIG85859H9H5DUYTWFB7'

Sample Success Response

                {
                    "request": "transaction_status",
                    "status":"success",
                    "transaction_id": "DJTIG85859H9H5DUYTWFB7",
                    "transaction_status": "ORDER_COMPLETED"
                }

POST - Fetch Data Plan List /fetch_data_plans

This API allows you to fetch the list of supported Mobilevtu.com data plans for a specific operator using the operator ID.

Request Parameters

Parameter	Description
operator Required	The unique identifier for the operator. This is Case Sensitive (MTN, Airtel, 9mobile or Glo)

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/fetch_data_plans' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'operator=MTN'

Sample Success Response

                {
                    "request": "fetch_data_plans",
                    "status":"success",
                    "data":[
                            {"plan": "1000",
                            "label": "1GB",
                            "operator": "MTN",
                            "validity": "30",
                            "price": "600",
                            "currency": "NGN"
                          },
                          {"plan": "2000",
                            "label": "2GB",
                            "operator": "MTN",
                            "validity": "30",
                            "price": "1100",
                            "currency": "NGN"
                          }
                          ,
                          {"plan": "10000.01",
                            "label": "10GB",
                            "operator": "MTN",
                            "validity": "30",
                            "price": "2000",
                            "currency": "NGN"
                          }
                    ]
                }

POST - Query Phone Number Operator /check_balance

This API allows you to check the correct network operator of a phone number. a 50 kobo per look-up charge apply.

Request Parameters

Parameter	Description
phone Required	The phone number to fetch operator for (include country code)

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/number_operator' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'phone=2347012345678'

Sample Success Response

                {
                    "request": "number_operator",
                    "status":"success",
                    "operator_code":"MTN",
                    "operator_name":"MTN Nigeria"
                }

POST - Topup /topup

This API allows you to initiate new airtime or data topup on Mobilevtu.com. The topup will be charged from your wallet balance

Request Parameters

Parameter	Description
operator Required	The unique operator identifier for the recipient number (MTN, 9mobile, Glo or Airtel)
type Required	The toup transaction type (airtime or data)
value Required	This will be the correct Data Plan ID for data topup or Airtime Amount for airtime topup. Clisk Here to see all supported data plan values
phone Required	This is the mobile phone number to topup (e.g. 08031234567 or 2348031234567)
custom_message Optional	This is any Custom SMS Message (not more than 160 characters) to be sent to the top=up recipient's number on successful top-up. This will be charged at N4 per SMS
sms_sender_id Optional	THis is the branded Alpha-numeric Sender ID (not more than 11 characters) you want to use for the message. This is required if a custom message is set

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/topup' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'operator=MTN&type=airtime&value=1000&phone=08031234567'

Sample Success Response

                {
                    "request": "topup",
                    "status":"success",
                    "transaction_id": "DJTIG85859H9H5DUYTWFB7",
                    "transaction_status": "completed"
                }

POST - Fetch Transaction Records/list_transactions

This API allows you to fetch all transaction on your Mobilevtu.com wallet.

Request Parameters

Parameter	Description
none

Sample Request using CURL

                   curl --request POST \
                     --url 'https://api.mobilevtu.com/v1/GGiet8506Rlglhglbfj7/list_transactions' \
                     --header 'Api-Token: 33tdg37egsbxyube' \
                     --header 'content-type: application/x-www-form-urlencoded'
                     --data 'limit=0'

Sample Success Response

                {
                    "request": "list_transactions",
                    "status":"success",
                    "data":[
                            {"transaction_id": "TT3036HYTIFJUY82RT",
                            "description": "1GB MTN Data",
                            "datetime": "2024-11-21 06:57:22",
                            "phone": "2348031234567",
                            "operator": "MTN",
                            "status": "completed"
                          },
                          {"transaction_id": "2GH6855RE996W000TR",
                            "description": "2000 Glo Airtime",
                            "datetime": "2024-11-21 06:57:22",
                            "phone": "2345098765432",
                            "operator": "Glo",
                            "status": "failed"
                          }
                    ]
                }

Start Using Mobilevtu.com API

Create a Free account with us now and enjoy access to all our top-up e-Wallet and API

Supported Data Plan Values

Operator	Plan	API Value/Code	Validity	Price (NGN)
9mobile	50MB	50	30 Days	15 NGN
9mobile	100 MB	100	30 Days	25 NGN
9mobile	500 MB	500	30 Days	110 NGN
9mobile	1 GB (SME)	1000	30 Days	200 NGN
9mobile	5 GB (SME)	5000	30 Days	900 NGN
9mobile	1.5GB	1500.01	30 Days	1,050 NGN
9mobile	2GB	2000.01	30 Days	1,250 NGN
9mobile	7GB	3000.01	7 Days	1,600 NGN
9mobile	10 GB	10000	30 Days	1,800 NGN
9mobile	4.5GB	4500.01	30 Days	2,050 NGN
9mobile	11GB	11000.01	30 Days	4,000 NGN
9mobile	15GB	15000.01	30 Days	5,200 NGN
9mobile	40GB	40000.01	30 Days	10,500 NGN
9mobile	75GB	75000.01	30 Days	16,000 NGN
Airtel	300MB	300	7 Days	120 NGN
Airtel	500MB	500	30 Days	200 NGN
Airtel	1GB	1000	30 Days	500 NGN
Airtel	750MB	499.00	14 Days	600 NGN
Airtel	1.5GB	999.00	30 Days	1,000 NGN
Airtel	2GB	2000	30 Days	1,200 NGN
Airtel	3GB	1499.01	30 Days	1,600 NGN
Airtel	4.5GB	5000	30 Days	2,000 NGN
Airtel	6GB	2499.01	30 Days	2,520 NGN
Airtel	10GB	10000	30 Days	3,000 NGN
Airtel	8GB	2999.02	30 Days	3,200 NGN
Airtel	15GB	15000	30 Days	4,000 NGN
Airtel	20GB	20000	30 Days	5,000 NGN
Airtel	40GB	9999.00	30 Days	10,100 NGN
Airtel	75GB	14999.00	30 Days	16,000 NGN
Airtel	110GB	19999.02	30 Days	20,500 NGN
Glo	500 MB	500	30 Days	200 NGN
Glo	1GB	1050.01	15 Days	500 NGN
Glo	3.7GB	2500.01	30 Days	1,050 NGN
Glo	6 GB	5000	30 Days	1,500 NGN
Glo	7GB	5800.01	30 Days	2,200 NGN
Glo	9GB	7700.01	30 Days	2,750 NGN
Glo	11GB	10000.01	30 Days	3,500 NGN
Glo	19GB	13250.01	30 Days	4,000 NGN
Glo	14GB	13250.01	30 Days	4,350 NGN
Glo	23GB	18250.01	30 Days	5,000 NGN
Glo	18GB	18250.01	30 Days	5,200 NGN
Glo	30GB	29500.01	30 Days	8,000 NGN
Glo	50GB	50000.01	30 Days	10,000 NGN
Glo	50GB	50000.01	30 Days	10,000 NGN
Glo	93GB	93000.01	30 Days	14,900 NGN
Glo	120GB	119000.01	30 Days	17,900 NGN
Glo	140GB	138000.01	30 Days	19,900 NGN
MTN	150MB	150.00	30 Days	50 NGN
MTN	250MB	250.00	30 Days	110 NGN
MTN	500MB	500.0	30 Days	200 NGN
MTN	1GB (SME)	1000.0	30 Days	320 NGN
MTN	2GB (SME)	2000.0	30 Days	650 NGN
MTN	3GB (SME)	3000.0	30 Days	1,200 NGN
MTN	5GB (SME)	5000.0	30 Days	1,500 NGN
MTN	GB+2GB YouTube Night+200MB YouTub	750.01	7 Days	1,650 NGN
MTN	GB+2GB YouTube Night+200MB YouTub	750.01	7 Days	1,650 NGN
MTN	4GB+2GB YouTube Night + 10mins	1000.02	30 Days	2,050 NGN
MTN	10GB (SME)	10000.0	30 Days	3,000 NGN
MTN	13GB Monthly Plan + 25mins	6000.02	30 Days	4,000 NGN
MTN	2GB Monthly Plan + 25mins	10000.01	30 Days	5,450 NGN
MTN	27GB Monthly Plan + 25mins	40000.01	30 Days	6,500 NGN
MTN	25GB	25000.00	30 Days	7,000 NGN
MTN	50GB	50000.00	30 Days	14,000 NGN
MTN	75GB Monthly Plan + 40mins	120000.01	30 Days	15,100 NGN
MTN	120GB Monthly Plan + 80mins	3000.06	30 Days	21,560 NGN
MTN	100GB	100000.00	30 Days	27,000 NGN

Sign-Up

First Name

Last Name

Company

Country

Phone

Password

Confirm Password

Mobilevtu.com offers mobile airtime and data top-up packages at wholesale price.

Services

Contact us

Ynet Technology Ltd
No. 22 Koforidua Street
Wuse Zone 2, Abuja. Nigeria.
+234-201-887-0200
help@mobilevtu.com
8:30am - 5:30pm (Work days)

Developers API

Table of Contents

Overview

Requirements

URL Format

Authentication

Request Method

Response Format

Test API Credentails

Sample Code

POST - Check Wallet Balance /check_balance

POST - Query Transaction Status /transaction_status

POST - Fetch Data Plan List /fetch_data_plans

POST - Query Phone Number Operator /check_balance

POST - Topup /topup

POST - Fetch Transaction Records/list_transactions

Start Using Mobilevtu.com API

Supported Data Plan Values

Sign-Up

Services

Contact us