WAEC Registration API
This section contains the recommended flow for integrating WAEC registration services on the VTpass RESTful API.
Authentication
Learn about authentication from here.
Available Endpoints
To integrate the VTpass WAEC registration RESTful API, the endpoints below applies:
- Get Variation Codes: this returns variation codes for various WAEC registration plans
- Purchase Product (Using the variation code gotten in the first step)
- Query transaction status
GET VARIATION CODES
Using a GET method, the VTpass variation codes for WAEC registration plans can be accessed with the endpoint below:
Live: https://vtpass.com/api/service-variations?serviceID=waec-registration
Sandbox: https://sandbox.vtpass.com/api/service-variations?serviceID=waec-registration
FIELDS | Mandatory/Optional | TYPE | DESCRIPTION |
N/A | N/A | N/A | N/A |
EXPECTED RESPONSE
{ "response_description":"000", "content":{ "ServiceName":"WAEC Registration PIN", "serviceID":"waec-registration", "convinience_fee":"N0.00", "varations":[ { "variation_code": "waec-registration", "name": "WASSCE for Private Candidates - Second Series (2019)", "variation_amount": "14450.00", "fixedPrice": "Yes" }, ... ] } }
PURCHASE PRODUCT
Using a POST method, WAEC registration pin can with the endpoint below:
Live: https://vtpass.com/api/pay
Sandbox: https://sandbox.vtpass.com/api/pay
ServiceID: waec-registration
FIELDS | Mandatory/Optional | TYPE | DESCRIPTION |
request_id | M | String | This is a unique reference with which you can use to identify and query the status of a given transaction after the transaction has been executed. |
serviceID | M | String | Service ID as specified by VTpass. In this case, it is waec-registration |
variation_code | M | String | The code of the variation (as specified in the GET VARIATIONS method as variation_code). |
amount | O | Number | The amount of the variation (as specified in the GET VARIATIONS endpoint as variation_amount)
This amount will be ignored as the variation code determine the price of the data bundle. |
quantity | O | Number | The quantity of the result checker PIN you wish to purchase.
This quantity will be defaulted to 1 if it is not passed in your request. |
phone | M | Number | The phone number of the customer or recipient of this service |
EXPECTED RESPONSE
{ "code": "000", "content": { "transactions": { "status": "delivered", "product_name": "WAEC Registration PIN", "unique_element": "08011111111", "unit_price": 14450, "quantity": 1, "service_verification": null, "channel": "api", "commission": 150, "total_amount": 14300, "discount": null, "type": "Education", "email": "sandbox@vtpass.com", "phone": "07061933309", "name": null, "convinience_fee": 0, "amount": 14450, "platform": "api", "method": "api", "transactionId": "1582290782154" } }, "response_description": "TRANSACTION SUCCESSFUL", "requestId": "3476we129909djd", "amount": "14450.00", "transaction_date": { "date": "2020-02-21 14:13:02.000000", "timezone_type": 3, "timezone": "Africa/Lagos" }, "purchased_code": "Token: 0100070365657400875", "tokens": [ "0100070365657400875" ] }
QUERY TRANSACTION STATUS
Using a POST method, transaction status can be queried with the endpoint below:
Live: https://vtpass.com/api/requery
Sandbox: https://sandbox.vtpass.com/api/requery
FIELDS | Mandatory/Optional | TYPE | DESCRIPTION |
request_id | M | String |
This is the reference with which you sent when purchasing a transaction after the transaction has been executed. |
EXPECTED RESPONSE
{ "code": "000", "content": { "transactions": { "status": "delivered", "product_name": "WAEC Registration PIN", "unique_element": "08011111111", "unit_price": 14450, "quantity": 1, "service_verification": null, "channel": "api", "commission": 150, "total_amount": 14300, "discount": null, "type": "Education", "email": "sandbox@vtpass.com", "phone": "07061933309", "name": null, "convinience_fee": 0, "amount": 14450, "platform": "api", "method": "api", "transactionId": "1582290782154" } }, "response_description": "TRANSACTION SUCCESSFUL", "requestId": "3476we129909djd", "amount": "14450.00", "transaction_date": { "date": "2020-02-21 14:13:02.000000", "timezone_type": 3, "timezone": "Africa/Lagos" }, "purchased_code": "Token: 0100070365657400875", "tokens": [ "0100070365657400875" ] }