Recharge Card 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 Recharge Card API Sandbox Integration page. This guide will help you integrate our Sandbox Recharge Card API into your system.

The minimum quantity per transaction is 10. The minimum quantity of pins you can purchase per purchase request is 10. Therefore enter 10 or above in the quantity postfields

Recharge Card Purchase API Request cURL Init Sample


curl -X POST https://sandbox.vtunaija.com.ng/api/rechargepin/ \ 
 
-H "Authorization: Token YOUR_API_KEY" \ 

-H "Content-Type: application/json" \ 

-d '{ 

    "network": "1", 

    "network_amount": "100", 

    "quantity": "10", 

    "name_on_card": "Boma Enterprise", 

    "request-id": "96286789jk762ur76" 
         
}'

Successful Recharge Card Purchase API Response Example

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


{ 

    "Status": "successful", 

    "status": "success", 

    "api_response": "Transaction Successful",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "1000.00", 

    "transaction_internal_id": "3528" 
 
    "pin": "12345678901234567,23456789012345678,34567890123456789,45678901234567890,56789012345678901,67890123456789012,78901234567890123,89012345678901234,90123456789012345,01234567890123456
", 

    "serial": "98765432101234567,87654321098765432,76543210987654321,65432109876543210,54321098765432109,43210987654321098,32109876543210987,21098765432109876,10987654321098765,09876543210987654
" 
 
}

Failed Recharge Card Purchase API Response Example

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


{ 

    "Status": "failed", 
  
    "status": "fail", 

    "api_response": "failed failed failed. Something went wrong", 

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "0" 
 
}

Processing Recharge Card Purchase API Response Example

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


{ 

    "Status": "processing", 

    "status": "processing", 

    "api_response": "Pending Recharge Card Purchase, transaction pending",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "1000.00", 

    "transaction_internal_id": "3528" 
          
}

Failed Recharge Card 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 recharge card pins. The network field is represented by the values 1, 2, 3, or 4, where 1 corresponds to MTN, 2 to GLO, 3 to T2mobiile(9Mobile), and 4 to Airtel. For a comprehensive list of Sandbox Vtunaija Network IDs and Plan IDs, please refer to the Plan IDs and Pricing Page of the Sandbox Website.

network_amount: This field indicates the recharge amount the user intends to purchase, which must be either ₦100, ₦200, or ₦500. The network_amount field should be set to 100, 200, or 500.

quantity: This field specifies the total number of recharge card pins the user wishes to purchase. The minimum quantity per transaction is 10.

name_on_card: This field must contain the name of the business or individual making the purchase through the API request.

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