API Reference Logical Pins

Logical Pins

This service allows you to purchase a Logical PIN using the provided Service ID .

⚠️ Note: The request payload may vary depending on the selected Service ID.

The respective Service IDs can be found in the Service ID table 📋.

Fetch Pins
POST

Service Information

{{baseUrl}}get_avail_pin_packages
POST
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchant’s (public) key
serviceId String M Corresponding service id for the request type 

{
   "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "serviceId": "PO4N"
}
{
    "statusCode": "00",
    "statusDescription": "Successful",
    "pinDetail": {
        "pinValues": [
            {
                "amount": 100
            },
            {
                "amount": 200
            },
            {
                "amount": 500
            },
            {
                "amount": 1000
            },
            {
                "amount": 1500
            }
        ]
    }
}
Logical Pin Vend
POST

Service Information

baseUrl/api/v1/vend_pins
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
serviceId String M Corresponding service id for the request type. See "Services" section for the available services and corresponding service codes for each.
recipient Numeric M Phone number of the merchant
requestId Numeric M Merchants unique id/reference for the transaction
amount Numeric M Face Value of the PIN
key String M Merchants (public) key
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "P06N",
    "amount": 3700,
    "recipient": "08134045387",
    "checksum": "{{checkSum}}",
    "productType" : "WAEC Checker"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
tranxReference String M Creditswitch transaction reference
qty String M Quantity of PINs generated (usually 1)
amount String M The face value of the generated pin
network String M The actual network of the PIN
detail String M Contains array of pin and serial number generated by the network operator 
{
    "statusCode": "00",
    "statusDescription": "successful",
    "detail": {
        "pin": [
            "93493279978110360"
        ],
        "serial_no": [
            "00000012751030955"
        ],
        "network": "Mtn",
        "qty": 1,
        "amount": 100,
        "tranxReference": "0620673001627313563"
    }
}
Validate JAMB
GET

Service Information

{{baseUrl}}verify_jamb_candidate
GET
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
Confirm Code String M Individual Student Code gotten from Jamb Board 

"loginId": "{{loginId}}",
"key": "{{publicKey}}",
"ConfirmCode": "a8h793b4f35f"

{
    "statusCode": "00",
    "statusDescription": "Successful",
    "result": {
    "gsmNo": "08000000000",
    "lastName": "Amunike",
    "firstName": "Emmanuel",
    "middleName": "Michael" }
}
Vend JAMB
POST

Service Information

{{baseUrl}}vend_pins
POST
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
Confirm Code String M Individual Student Code gotten from Jamb Board
RequestId String M Merchants unique id/reference for the transaction
ServiceId String M Merchants id provided during integration
Amount String M Face Value of the pin
Recipients String M Phone number of the merchant
Checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps
email String M Email of the candidate
productType String M Type of Jamb service 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{requestId}}",
    "serviceId": "P07N",
    "amount": 4,
    "recipient": "08012345678",
    "checksum": "{{checkSum}}",
    "email": "xyz@gmail.com",
    "confirmCode": "1375779512",
    "productType": "jambutme"
}

{
    "statusCode": "00",
    "statusDescription": "successful",
    "detail": {
    "pin": "30138820169806991",
    "serial_no": "094089700 1698060076",
    "network": "JAMB",
    "qty": 1,
    "amount": 4,
    "tranxReference": "2310231221161190695" }
}
Vend Other Educational Services
POST

Service Information

{{baseUrl}}vend_pins
POST
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
RequestId String M Merchants unique id/reference for the transaction
ServiceId String M Merchants id provided during integration
Amount String M Face Value of the pin
Recipients String M Phone number of the merchant
Checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps
productType String M Type of Jamb service 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{requestId}}",
    "serviceId": "P06N",
    "amount": 4,
    "recipient": "08012345678",
    "checksum": "{{checkSum}}",
    "productType": "WAEC Checker"
}

{
    "statusCode": "00",
    "statusDescription": "successful",
    "detail": {
    "pin": "30138820169806991",
    "serial_no": "094089700 1698060076",
    "network": "WAEC",
    "qty": 1,
    "amount": 4,
    "tranxReference": "2310231221161190695" }
}