Vtunaija - Exam Pin API Integration Documentation

(Live Environment)

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

Exam Pin Purchase API Request cURL Init Sample


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

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

-d '{ 

    "exam_name": "2", 

    "quantity": "1", 
    
    "request-id": "46947809asdo98d34" 
          
}'

Successful Exam Pin Purchase API Response Example

This is an example of the response returned for a successful Exam Pin Purchase


{ 

    "Status": "successful", 

    "status": "success", 

    "api_response": "Transaction Successful",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "2700.00", 

    "transaction_internal_id": "5039", 

    "pin": "12345678901234567,23456789012345678,45678901234567890", 

    "serial": "98765432101234567,56789012345678901,78765432109876543" 
 
}

Failed Exam Pin Purchase API Response Example

This is an example of the response returned for a failed Exam Pin Purchase


{ 

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

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

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "0.00", 

    "transaction_internal_id": "5039" 
 
}

Processing Exam Pin Purchase API Response Example

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


{ 

    "Status": "processing", 

    "status": "processing", 

    "api_response": "Pending Exam Pin Purchase, transaction pending",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "2700.00", 

    "transaction_internal_id": "5039" 
          
}

Failed Exam Pin 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

exam_name: This field specifies the network for which the user is purchasing exam pins. The network field is represented by the values 1, 2, 3, or 4, 5 and 6 where 1 corresponds to WAEC, 2 to NECO, 3 to NABTEB,4 to JAMB, 5 to WAECREGISTRATION and 6 to NBAIS. For a comprehensive list of Vtunaija Exam IDs, Network IDs and Plan IDs, please refer to API Documentation Page 1.

quantity: This field specifies the total number of exam result checker or exam result registration pin the user wishes to purchase.

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