API Docs

Edu Pins Endpoint

Purchase educational examination pins.

Endpoint

URL: /api/edu

Methods: POST, GET

Description

This API endpoint allows users to purchase educational examination pins like waec, neco, etc.

Authentication

To access this endpoint, users must include their API key and secret key in the request headers.

Request Headers

  • api-key (string, required): The API key of the user.
  • secret-key (string, required): The secret key of the user.

Request Body (POST)

  • phone (string, required): The phone number of the recipient.
  • firstLevel (string, required): The name of the examination.
  • secondLevel (string, required): The type of the examination pin.
  • number (string, optional): The exam number of the recipient, if applicable.
  • requestId (string, optional): The unique request identifier. 5-50 characters long.

Usage Example

POST request to purchase education pins:

Content-Type: application/json
api-key: your-api-key
secret-key: your-secret-key

{
  "phone": "08032566178",
  "firstLevel": "NECO", // value of this key can either be firstLevel or fId, e.g. "neco" fId is more accurate
"secondLevel": "Resut checker", // value of this key can either be secondLevel or sId, e.g. "result-checker" sId is more accurate
  "requestId": "yourreference"
}

Response:

{
  "message": "Transaction successful",
    "data": {
        "email": "user@example.com",
        "transactionId": "202403021250s56bxh3mz5",
        "activity": "NECO",
        "message": "Resut checker",
        "status": "Successful",
        "recipient": "08032566178",
        "number": 52665324546565,
        "token": "555555123355533",
        "amount": 10000,
        "initialBalance": 1264,
        "finalBalance": 264,
        "Method": "API",
    }
}

Failed Response Format

{
  "message": "Transaction failed",
    "data": {
        "email": "user@example.com",
        "transactionId": "202403021259avdzv2xt2c9",
        "activity": "NECO",
        "message": "Resut checker",
        "status": "Failed",
        "recipient": "08032566178",
        "number": 52665324546565,
        "amount": 1000,
        "initialBalance": 1167,
        "finalBalance": 1167,
        "Method": "API",
    }
}

GET Request

Get the list of available firstLevel:

Content-Type: application/json
api-key: your-api-key
secret-key: your-secret-key

Response:

[
  {
    "available": true,
    "firstLevel": "Waec",
    "fId": "waec",
    "amounts": [null],
    "secondLevels": [
      {
        "available": true,
        "secondLevel": "Result Checker",
        "sId": "result-checker",
        "amounts": [50]
      }
    ]
  },
  {
    "available": true,
    "firstLevel": "NECO",
    "fId": "neco",
    "amounts": [0],
    "secondLevels": [
      {
        "available": true,
        "secondLevel": "Result Checker",
        "sId": "result-checker",
        "amounts": [10]
      }
    ]
  }
]
IABCONCEPT