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 Sandbox Webhook API Sandbox
× Homepage Get User Balance API Sandbox Documentation Airtime API Sandbox Documentation Data API Sandbox Documentation Fetch Data Plans List API Sandbox Documentation Cable TV API Sandbox Documentation Cable TV Verification API Sandbox DocumentationI Fetch Cable TV Plans List API Sandbox Documentation Electricity API Sandbox Documentation Electricity Verification API Sandbox Documentation Fetch Electricty Plan IDs API Sandbox Documentation Bulk SMS API Sandbox Documentation Data Pin API Sandbox Documentation Exam Pin API Sandbox Documentation Recharge Card API Sandbox Documentation Internet Bundle API Sandbox Documentation Fetch Internet Bundles List API Sandbox Documentation Transaction Query API Sandbox Documentation Webhook API Sandbox Documentation

Data Pin API Integration

(Sandbox Environment) Register and Login on the Sandbox Website to get your Sandbox API Key for the Sandbox Integration Click Here

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

DataCard Pin Purchase API Request cURL Init Sample

curl -X POST https://sandbox.vtunaija.com.ng/api/datapin/ \
-H "Authorization: Token YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"network": "1",
"quantity": "3",
"data_plan": "2",
"businessname": "Boma Enterprise",
"request-id": "878753234"
}'

Successful DataCard Purchase API Response Example

This is an example of the response returned for a successful DataCard Purchase.

{
"Status": "successful",
"status": "success",
"api_response": "Data Card Printing Successful",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "3000.00",
"transaction_internal_id": "2217"
"pin": "3487746837,3475987844,3579789874",
"serial": "5344587876,3987647598,94876765456"
}

Failed DataCard Purchase API Response Example

This is an example of the response returned for a failed DataCard Purchase.

{
"Status": "failed",
"status": "fail",
"api_response": "Transaction Fail",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "0.00",
"transaction_internal_id": "2217"
}

Processing DataCard Purchase API Response Example

This is an example of the response returned for a pending DataCard Purchase.

{
"Status": "processing",
"status": "processing",
"api_response": "Pending DataCard Purchase, transaction pending",
"id": "78977865523",
"ident": "78977865523",
"plan_amount": "3000.00",
"transaction_internal_id": "2217"
}

Failed DataCard Purchase API Response Example

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 field specifies the network for which the user is purchasing data pins. The *network* field is represented by the numbers 1, 2, 3, or 4, where 1 corresponds to MTN, 2 to GLO, 3 to T2mobile(9Mobile), and 4 to Airtel. For a complete list of Sandbox Vtunaija Network IDs and Plan IDs, please refer to the Plan IDs and Pricing Page of the Sandbox Website.

quantity: This field indicates the total number of data pins the user wishes to purchase.

data_plan: This field specifies the particular data pin plan the user wants to purchase. Data pin plans are identified by Plan IDs. For the full list of Sandbox Vtunaija Network IDs and Plan IDs, please refer to the Plan IDs and Pricing Page of the Sandbox Website.

businessname: This field should contain the name of the business or user purchasing the data pins through the API request.

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