JAMB

JAMB API

Before sending any request, ensure that:

Users must provide an email and a phone number to be used for vending.

Users must also provide all server IPs that will connect to this system which has to be allowed for vending by Payvantage.

Jamb Candidate Profile Request

A candidiate’s profile is to be requested before vending. This is to ensure that the candidate being vend for is the right candidate

POST {{baseUrl}}/api2/merchant/profreq/

Sample Request

{ "profilerequest": { "user": "user", "password": "password", "designate_id": "345789000-2019", "mocktype": "mock", "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } }

This method would be used to vend jamb pin details using allowed IP addresses, username

Request Body

Name	Type	Description
user*	String	This username should be passed at the time of connection to ensure that the User is a valid user.
password*	String	This password should be passed at the time of connection to ensure that the User is a valid user.
designate_id*	String	This is the unique profile code to be used for vending.
hash*	String	SHA512 hash of the parameters.
mocktype*	String	‘mock’ or ‘non mock’. Candidate doing mock exam or not doing mock exam.

200: OK Successful

{
    "profileResponse": 
    {
        "designate_id": "345789000-2019",
        "firstname": "Abiola",
        "lastname": "Ashiru",
        "middlename": "Ayinde"
        "phonenos": "08033310835",
        "statuscode":"0",
        "statusmessage":"Successful",
        "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
}

Jamb Pin Request

Jamb Pin Sample Request

// Some code
{
 "airtimeRequest": 
    {
        "user": "user",
        "password": "password",
        "prodid": "88",
        "jambtype": "UTME",
        "mocktype": "mock",
        "amount": "7700",
        "utransid": "234RRTERW1AS788PN4",
        "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
}

Request Method and body parameters

Jamb pin request

POST {{baseUrl]}/api2/merchant/airtimereq/

Request Body

Name	Type	Description
user*	String	This username should be passed at the time of connection to ensure that the User is a valid user.
password*	String	This password should be passed at the time of connection to ensure that the User is a valid user.
prodid*	String	This is the unique product id to be used for vending. Note ids in the Product Table below.
amount*	String	This is the amount for the pin purchased.
jambtype*	String	DE or UTME
mocktype*	String	mock’ or ‘non mock’. Candidate doing mock exam or not doing mock exam
utransid*	String	Unique transaction id from vendor end. Preferably not less than 16 characters and not more than 25 characters
hash *	String	SHA512 hash of the parameters

200: OK Jamb Pin Response

{
  {
    "airtimeResponse": {
    "utransid": "234RRTERW1AS788PN4",
    "auditid": "K21345666344455556",
    "pinnos": "6988775",
    "airtimeStatus": "Success"
    "statusMessage": "Transaction Successful",
    "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Jamb Pin Response

Sample Response

{
  {
    "airtimeResponse": {
    "utransid": "234RRTERW1AS788PN4",
    "auditid": "K21345666344455556",
    "pinnos": "6988775",
    "airtimeStatus": "Success"
    "statusMessage": "Transaction Successful",
    "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Parameters

Field	Required/Optional	Data Type	Description
utransid	Required	String	Unique transaction id as sent from vendor. Preferably not less than 16 characters and not more than 25 characters.
auditid	Required	String	Return ID generated from Payvantage. For audit purposes.
pinnos	Required	String	Pin number from JAMB
airtimeStatus	Required	String	This is status of the payment. ‘Success’ or ‘Failed’.
statusMessage	Optional	String	A description of the status.
hash	Required	String	SHA512 hash of all parameters in the order.