Airtime Providers
Getting all available Airtime Providers
Endpoint: /airtime
Method: GET
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
Sample Post
curl https://api.budpay.com/api/v2/airtime
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": [
{
"provider": "AIRTEL",
"providerLogoUrl": "assets/images/bills/Airtel-Airtime.jpg",
"minAmount": "5",
"maxAmount": ""
},
{
"provider": "MTN",
"providerLogoUrl": "assets/images/bills/MTN-Airtime.jpg",
"minAmount": "5",
"maxAmount": ""
},
{
"provider": "GLO",
"providerLogoUrl": "assets/images/bills/GLO-Airtime.jpg",
"minAmount": "5",
"maxAmount": ""
},
{
"provider": "9MOBILE",
"providerLogoUrl": "assets/images/bills/9mobile-Airtime.jpg",
"minAmount": "5",
"maxAmount": ""
}
]
}
Airtime Topup
To Initiate an Airtime Topup Transaction
Endpoint: /airtime/topup
Method: POST
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
| Encryption | string | Yes | Set value to your {Signature_HMAC-SHA-512} output |
Body Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| provider | string | Yes | use the provider returned in airtime-providers |
| number | string | Yes | Customer's/beneficiary's phone number to recharge/topup |
| amount | string | Yes | Amount to Topup |
| reference | string | Yes | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. |
Sample Post
curl https://api.budpay.com/api/v2/airtime/topup
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{ "provider": "MTN",
"number": "07036218209",
"amount": "100",
"reference": "2459392959593939"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "SUCCESSFUL",
"data": {
"orderNo": "211104130931335009",
"reference": "25696593r9622",
"status": "Delivered",
"errorMsg": null
}
}