API Documentation
Homepage Get User Balance API Airtime API Data API Fetch Data Plans List Cable TV API Cable TV Verification API Fetch Cable TV Plans List Electricity API Electricity Verification API Fetch Electricty Plan IDs Bulk SMS API Data Pin API Exam Pin API Recharge Card API Internet Bundle API Fetch Internet Bundles List Transaction Query API Webhook API
× Homepage Get User Balance API Documentation Airtime API Documentation Data API Documentation Fetch Data Plans List API Documentation Cable TV API Documentation Cable TV Verification API Documentation Fetch Cable TV Plans List API Documentation Electricity API Documentation Electricity Verification API Documentation Fetch Electricty Plan IDs List API Documentation Bulk SMS API Documentation Data Pin API Documentation Exam Pin API Documentation Recharge Card API Documentation Internet Bundle API Documentation Fetch Internet Bundles List API Documentation Transaction Query API Documentation Webhook API Documentation

Data API Integration

(Live Environment)

Welcome to the Data API Integration page. This guide will help you integrate our Data API into your system.

cURL Init Sample

curl -X POST https://vtunaija.com.ng/api/data/ \
-H "Authorization: Token YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"network": "1",
"mobile_number": "08012345678",
"Ported_number": "true",
"request-id": "78977865523",
"plan": "2"
}'

Successful API Response

{
"Status": "successful",
"status": "success",
"api_response": "Dear Customer, You have successfully shared 1GB Data to 2348012345678.",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "260.00",
"transaction_internal_id": "18989"
}

Failed API Response

{
"Status": "failed",
"status": "fail",
"api_response": "Failed Failed Failed. Something went wrong",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "0.00",
"transaction_internal_id": "18989"
}

Processing API Response

{
"Status": "processing",
"status": "processing",
"api_response": "Pending data purchase for 2348012345678.",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "260.00",
"transaction_internal_id": "18989"
}

Failed API Response

This is an example of a failed API response caused by factors such as an insufficient wallet balance, an incorrect API key, missing POST fields and so on.

{
"Status": "failed",
"status": "fail",
"message": "Insufficient wallet balance",
}

Post Terms Defined and Interpreted

network: This identifies the specific network for which the user is purchasing data. The network post field is represented by the numbers 1, 2, 3, or 4: 1 indicates MTN, 2 indicates GLO, 3 indicates 9Mobile, and 4 indicates Airtel. For the complete list of Vtunaija Network IDs and Plan IDs, check the API Documentation Page 1.

mobile_number: This is the phone number for which the user wants to purchase data.

Ported_number: This field is used to bypass the mobile number validator. Setting this field to 'true' means the validator is bypassed, while 'false' means it is not bypassed. This field is optional and defaults to 'true' if not provided during API data integration.

request-id: This is the unique ID you send as the Request ID.

plan: This is the particular data plan that the user wants to buy. The data plans are represented by Plan IDs. For the complete list of Vtunaija Network IDs and Plan IDs, check the API Documentation Page 1.