Airtime

Web-hooks for airtime transactions

Sample request for airtime vending

{
  "amount": "5",
  "network": "MTN",
  "phonenumber": "08102300455",
  "transaction_id": "XXXXX-XXXXXXXX-XXXX-XXXXXX-XXX"
}

Endpoint to vend single airtime

POST {{baseUrl}}//service/api/single_airtime_direct_vending

Headers

Name	Type	Description
x-api-key*	String	The X-API key is a unique key that must be passed to the header before any request and can be found in the dashboard.
client-id*	String	This is a unique id for customers that can also be found in the dashboard when login

Request Body

Name	Type	Description
transaction_id*	String	The transaction reference
amount*	String	Amount of airtime vend in Naira
phonenumber*	String	The customers' phone number
network*	String	The customers' network(9Mobile, MTN, GLO, AIRTEL)

200: OK Successful

Sample Response

{
    "status_code": "200",
    "transaction_id": null,
    "reference": "80kjd-689269942-test-v74214-n21",
    "phonenumber": "08023445612",
    "network": "MTN",
    "message": "successful"
}

300: Multiple Choices Duplicate

Sample response

{
    "status_code": "300",
    "transaction_id": null,
    "reference": "80kjd-689269942-test-v74214-n21",
    "phonenumber": "08023445612",
    "network": "MTN",
    "message": "is duplicate"
}

500: Internal Server Error failedStatus

Sample response

{
    "status_code": "500",
    "transaction_id": "166272313399778110",
    "reference": "80kjd-612269142-test-n21",
    "phonenumber": "08169653167",
    "network": "MTN",
    "message": "unsuccessful"
}

501 Pending

Sample response

{
    "status_code": "501",
    "message": "Pending"
}

100: Continue others

Sample response

{
    "status_code": "100",
    "message": Any other error message
}

404: Not Found 3

Sample response

{
   
    "status_code": "3",
    "message": "not found"
    "result": null

}

Endpoint to requery pending transaction

An endpoint to requery pending transaction. This endpoint is called whenever single_airtime_direct_vending returns pending response

POST {{baseUrl}}/check_transaction_status

Headers

Name	Value
Content-Type	application/json
x-api-key	The X-API key is a unique key that must be passed to the header before any request and can be found in the dashboard.
client-id	This is a unique id for customers that can also be found in the dashboard when login

Body

Name	Type	Description
service_code	string	The service code for airtime is 100
transaction_id	string	The transaction_id of the transaction

Response

200

{
    "status_code": "200",
    "message": "Successful",
    "result": {
        "status_code": "200",
        "message": "Successful",
        "phonenumber": "08187270012",
        "amount": "30000",
        "network": "MTN",
        "transaction_id": "206917193991624259",
        "transaction_date": "2003-06-26 11:52:51.013"
    }
}

400

{
    "status_code": "3",
    "message": "not found"
    "result": null
}