EXAMINATION PIN API Integration
RESULT CHECKER API Integration
This section contains your RESTful API for Examination PIN API integration..
EXAMINATION PIN API Integration
RESULT CHECKER API Integration
This section contains your RESTful API for Examination PIN API integration..
The VTU Africa API uses API Key for Authentication.
Please use your APIKEY for authentication
Live URL: https://vtuafrica.com.ng/portal/api/exam-pin/
Sansbox: https://vtuafrica.com.ng/portal/api-test/exam-pin/
Parameters: as specified in the parameters below:
| PARAMETERS | Required/Optional | TYPE | DESCRIPTION |
| apikey | R | String | The reseller gateway API key created at vtuafrica.com.ng. |
| service | R | String | The Service provider as specified. These includes, waec, neco, nabteb and jamb |
| product_code | R | String | This is the variation code for either Result Checking PIN or Registration PIN as seen below |
| quantity | R | Number | The quantity of Scratch Card Pins you want to generate. |
| profilecode | O | String | Required only when buying JAMB Registration PINs |
| sender | O | Required only when buying JAMB Registration PINs. This should be the email to receive the JAMB PIN | |
| phone | O | Number | Required only when buying JAMB Registration PINs. This should be the Phone number to receive the JAMB PIN |
| ref | R | String | This is a unique reference with which you can use to execute and query the transaction. |
| webhookURL | R | String | Your webhook URL. We send transaction status and JAMB PIN to it. If not provided, the webhook in your profile will be used. |
SAMPLE CODE
$sandbox = "https://vtuafrica.com.ng/portal/api-test/exam-pin/?apikey=1234&service=waec&product_code=1&quantity=1&ref=8284666332234"; $host = "https://vtuafrica.com.ng/portal/api/exam-pin/?apikey=1234&service=waec&product_code=1&quantity=1&ref=8284666332234"; //Initialize cURL. $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $host); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); $data = curl_exec($ch); //Close the cURL handle. curl_close($ch); $response = json_decode($data);
EXPECTED RESPONSE
{"code":101,
"description":{"Status":"Completed","ProductName":"WAEC Result Checking PIN",
"Quantity":"1","Product_code":"1","UnitPrice":"3500","Amount_Charged":"3500",
"pins":"WR23454<=>456786564","Previous_Balance":"4000","Current_Balance":"500",
"ReferenceID":"828466633","message":"Purchase Successful"}}
Base URL: https://vtuafrica.com.ng/portal/api/merchant-verify/
Parameters: as specified in the parameters below:
| PARAMETERS | Required/Optional | TYPE | DESCRIPTION |
| apikey | R | String | The reseller gateway API key created at vtuafrica.com.ng |
| serviceName | R | String | This is the Name of the service you are verifiying. In this case it is: jamb |
| profilecode | R | number | The profile code to be verified. |
| product_code | R | Number | These includes: 1 for JAMB UTME Registration PIN and 2 for JAMB Direct Entry Registration PIN. As seen more below |
SAMPLE CODE
$host ="https://vtuafrica.com.ng/portal/api/merchant-verify/?apikey=1234&serviceName=jamb&profilecode=6828826915&product_code=2"; //Initialize cURL. $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $host); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); $data = curl_exec($ch); //Close the cURL handle. curl_close($ch); $response = json_decode($data);
EXPECTED RESPONSE
{"code":101,
"description":{"Status":"Completed","Customer":"Sulaiman Olorunwa Akinola","ProfileCode":"6828826915","Service":"JAMB Direct Entry Registration PIN",,"product_code":"2","message":"Candidate Verification Successful."} }
| DESCRIPTION | service | product_code | |
| WAEC Result Checking PIN | waec | 1 | |
| WAEC GCE Registration PIN | waec | 2 | |
| WAEC Verification PIN | waec | 3 | |
| NECO Result Checking Token | neco | 1 | |
| NECO GCE Registration PIN | neco | 2 | |
| NABTEB Result Checking PIN | nabteb | 1 | |
| NABTEB GCE Registration PIN | nabteb | 2 | |
| JAMB UTME Registration PIN | jamb | 1 | |
| JAMB Direct Entry Registration PIN | jamb | 2 |