Bills Payment
Internet
This service allow you to purchase internet data for your Customers over BudPay API.
- Call /api/v2/internet to get all the avaliable internet data service providers.
- Call /api/v2/internet/plans/{provider} to fetch available data plans for a specified provider.
- Call /api/v2/internet/data to initialize data purchase transaction.
Internet Providers
Getting all available Internet Providers
Endpoint: /internet
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/internet
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": [
{
"id": 1,
"provider": "AIRTEL",
"providerLogoUrl": "assets/images/bills/Airtel-Data.jpg"
},
{
"id": 2,
"provider": "MTN",
"providerLogoUrl": "assets/images/bills/MTN-Data.jpg"
},
{
"id": 3,
"provider": "GLO",
"providerLogoUrl": "assets/images/bills/GLO-Data.jpg"
},
{
"id": 4,
"provider": "9MOBILE",
"providerLogoUrl": "assets/images/bills/9mobile-Data.jpg"
},
{
"id": 5,
"provider": "SMILE4G",
"providerLogoUrl": "assets/images/bills/Smile-Payment.jpg"
}
]
}
Internet Data Plans
Getting all available Internet Data Plans
Endpoint: /internet/plans/{provider}
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/internet/plans/{provider}
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "Internet Data Plans Fetched successfully",
"data": [
{
"id": 1,
"name": "MTN N100 100MB - (24 Hours)",
"amount": "100"
},
{
"id": 2,
"name": "MTN N25 20MB - (24 Hours)",
"amount": "25"
},
{
"id": 3,
"name": "MTN N200 200MB - 2 days",
"amount": "200"
},
...
{
"id": 43,
"name": "SME Data Share N50,000 150GB",
"amount": "50000"
}
]
}
Internet Data Purchase
To Initiate a Internet Data Purchase Transaction
Endpoint: /internet/data
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 | please use the provide param of the provider as returned in internet providers (e.g. for Airtel, use AIRTEL) |
| number | string | Yes | Customer's/beneficiary's mobile number to subscribe on |
| plan_id | string | Yes | id of the data plan you are subscribing to |
| 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/internet/data
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{ "provider": "MTN",
"number": "07036218209",
"plan_id": "238",
"reference": "2459392959593939"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "SUCCESSFUL",
"data": {
"orderNo": "211104130931335009",
"reference": "25696593r9622",
"status": "Delivered",
"errorMsg": null
}
}