Purchase Airtime
Test URL
POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/airtime
Live URL
POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/airtime
This gives an application the ability to purchase airtime from any telco :iphone: in East and Central Africa.
Field Descriptions
| Field Name | Description | Example |
|---|---|---|
customer.countryCode | The country code in ISO Alpha-2 format where the customer resides e.g. "UG", for Uganda "TZ" for Tanzania "RW" for Rwanda "SS" for South Sudan or "KE" for Kenya etc. | "KE" |
customer.mobileNumber | The customer’s mobile phone number (without the country code). | "0765555131" |
customer.accountNumber | The merchant’s source account number from which the airtime cost is deducted. | "0440192329480" |
airtime.amount | The amount of airtime being purchased, specified in the local currency. | "100" |
airtime.reference | A unique reference number for tracking this specific airtime transaction. | "212194600777" |
airtime.telco | The telecommunications provider for the airtime purchase e.g. Safaricom, Airtel | "Safaricom" |
HTTPS Request Headers
| Header Name | Type | Description | Example |
|---|---|---|---|
Authorization | string | The Bearer token used for authenticating the request. | Bearer {token} |
Content-Type | string | Specifies the format of the data being sent in the request. | application/json |
signature | string | Generate signature using specified request payload data from the Signature Formula. | {signature} |
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formula
airtime.telco+airtime.amount+airtime.referenceExample Request
curl -X POST \
-d '{
"customer": {
"countryCode": "KE",
"mobileNumber": "0765555131",
"accountNumber: "0440192329480"
},
"airtime": {
"amount": "100",
"reference": "212194600777",
"telco": "Safaricom"
}
}' \
-H 'Authorization: Bearer {{token}}' \
-H 'Content-Type: application/json' \
-H 'signature: {{signature}}' \
-L 'https://uat.finserve.africa/v3-apis/airtime'200 Success Response Schema
| Field Name | Field Type | Field Description |
|---|---|---|
status | bool | Response status |
code | number | Response code |
message | string | Response message |
data | object | Response data |
referenceNumber | string | reference number for the transaction |
status | string | status of transaction |
Example Response
Example Response
{
"status": true,
"code": 0,
"message": "success",
"reference": "212194600777",
"data": {
"referenceNumber": "212194600777",
"status": "SUCCESS"
}
}