Airtime validation notifications

The Airtime API provides optional functionality to validate airtime requests from your application. To receive these notifications you need to setup an airtime validation callback URL. From the dashboard select Airtime -> Airtime Callback URLs -> Validation Callback URL.

Validation Notification Content

Airtime validation notifications are sent as POST requests to the validation callback URL provided and contain the following parameters:

Parameter Description
transactioId
String
The transaction id within Africa's Talking.
phoneNumber
String
The phone number of the mobile subscriber receiving the airtime.
currencyCode
String
The 3-digist ISO format currency for the value of this transaction (e.g KES, UGX, USD, ...)
amount
Decimal
Amount - in the provided currency - that the client will receive.
{
    "transactionId" : "SomeTransactionID",
    "phoneNumber": "+254711XXXYYY",
    "currencyCode": "KES",
    "amount": 500.00"
}

Validation Notification Response

Once you receive a validation callback notification you'll be expected to send back a JSON response that marks the transaction as Validated or Failed. If validated we will proceed to send the airtime, if failed, we will block the airtime transaction.


{
    "status": "Validated" // or "Failed"
}