JAMB e-PIN API
Integrate using a secure HTTPS GET API. Responses are returned in JSON.
GET
HTTPS
JSON
Your Credentials
UserID
APIKey
********************************
Endpoints
Buy JAMB e-PIN
https://www.nellobytesystems.com/APIJAMBV1.asp?UserID=your_userid&APIKey=your_apikey&ExamType=exam_code&PhoneNo=recipient_phoneno&RequestID=request_id&CallBackURL=callback_url
Query Transaction
https://www.nellobytesystems.com/APIQueryV1.asp?UserID=your_userid&APIKey=your_apikey&OrderID=order_id
https://www.nellobytesystems.com/APIQueryV1.asp?UserID=your_userid&APIKey=your_apikey&RequestID=request_id
Packages / Available Services
Retrieve available ExamType packages in JSON:
APIJAMBPackagesV2.asp
https://www.nellobytesystems.com/APIJAMBPackagesV2.asp?UserID=
Try It (Quick Test)
Build a request URL and test quickly. (Uses browser fetch; CORS depends on server settings.)
You can also fetch available packages via APIJAMBPackagesV2.
Idle
Request Parameters
| Parameter |
Description |
| UserID | Your account UserID. |
| APIKey | Your API key used to authenticate requests. |
| ExamType |
Exam type code:
de = Direct Entry (DE)
utme-mock = UTME PIN (with mock)
utme-no-mock = UTME PIN (without mock)
To retrieve dynamic options, call APIJAMBPackagesV2.
|
| PhoneNo | Recipient phone number to receive the e-PIN. |
| RequestID | Unique request ID (recommended). |
| CallBackURL | Callback URL for asynchronous transaction status updates. |
Examples
Sample: Buy JAMB Checker PIN for PhoneNo 08149659347
Replace credentials with yours
https://www.nellobytesystems.com/APIJAMBV1.asp?UserID=CK123&APIKey=456&ExamType=jamb&PhoneNo=08149659347&CallBackURL=http://www.your-website.com
JSON response (sample)
{
"date": "17th-Mar-2019",
"orderid": "798",
"statuscode": "200",
"status": "ORDER_COMPLETED",
"remark": "TRANSACTION SUCCESSFUL",
"ordertype": "utme",
"carddetails": "Serial No:WRN200343867, pin: 572871474684",
"phoneno": "08149659347",
"amountcharged": "2000",
"walletbalance": "863210.1"
}
Query by OrderID
https://www.nellobytesystems.com/APIQueryV1.asp?UserID=CK123&APIKey=456&OrderID=789
Cancel by OrderID
https://www.nellobytesystems.com/APICancelV1.asp?UserID=CK123&APIKey=456&OrderID=789
Cancel response (sample)
{
"status": "ORDER_CANCELLED",
"orderid": "789"
}
Note: You can only cancel a transaction whose status is ORDER_RECEIVED or ORDER_ONHOLD.
Verify JAMB Profile ID
Validate a JAMB Profile ID before purchase/delivery.
https://www.nellobytesystems.com/APIVerifyJAMBV1.asp?UserID=CK123&APIKey=456&ExamType=jamb&ProfileID=1234567890
Response (success)
{
"customer_name": "BALOGUN SUNDAY LIV LADORITE"
}
Response (error)
{
"customer_name": "INVALID_ACCOUNTNO"
}
Callback (CallBackURL)
After processing, we will call your CallBackURL with the OrderID, StatusCode, OrderStatus, and OrderRemark.
You can also use APIQueryV1 to confirm final status.
Callback example (query string)
https://your_callback_url?orderdate=22th-Jul-2023&orderid=6501321715&statuscode=200&orderstatus=ORDER_COMPLETED&orderremark=TRANSACTION%20SUCCESSFUL
Callback example (JSON)
{
"orderdate": "22th-Jul-2023",
"orderid": "6501321715",
"requestid": "",
"statuscode": "200",
"orderstatus": "ORDER_COMPLETED",
"orderremark": "TRANSACTION SUCCESSFUL"
}
Status Codes
Common responses are listed below. For the full list, use:
View full list of Status Code and Descriptions
| STATUS |
DESCRIPTION |
INVALID_CREDENTIALS | The UserID and API key combination is not correct. |
MISSING_CREDENTIALS | The URL format is not valid. |
MISSING_USERID | UserID is empty. |
MISSING_APIKEY | APIKey is empty. |
MISSING_EXAMTYPE | ExamType is empty. |
INVALID_PHONENO | An invalid phone number was entered. |
ORDER_RECEIVED | Your order has been received. |
Since we use a GET API, responses are returned in JSON.