Bills Payment
Tv
This service allow you to subscribe or renew your Cable TV for your Customers over BudPay API.
- Call /api/v2/tv to get all the avaliable Tv service providers.
- Call /api/v2/tv/packages/{provider} to get all the avaliable packages of a specific Tv service providers.
- Call /api/v2/tv/validate to fetch Smartcard or UIC Number Account information.
- Call /api/v2/tv/pay to initialize Tv payment.
Tv Providers
Getting all available Tv Providers
Endpoint: /tv
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/tv
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": [
{
"provider": "DSTV",
"providerLogoUrl": "assets/images/bills/Pay-DSTV-Subscription.jpg"
},
{
"provider": "GOTV",
"providerLogoUrl": "assets/images/bills/Gotv-Payment.jpg"
},
{
"provider": "STARTIMES",
"providerLogoUrl": "assets/images/bills/Startimes-Subscription.jpg"
},
{
"provider": "SHOWMAX",
"providerLogoUrl": "assets/images/bills/ShowMax.jpg"
}
]
}
Tv Packages (Bouquet)
Getting all available Tv Packages (Bouquet) of a Provider
Endpoint: /tv/packages/{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/tv/packages/{provider}
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-X GET
Sample Response
{
"success": true,
"code": "00000",
"message": "CableTv Packages Fetched successfully",
"data": [
{
"id": 34,
"name": "GOtv Max N3,600",
"code": "gotv-max",
"amount": "3600"
},
{
"id": 35,
"name": "GOtv Jolli N2,460",
"code": "gotv-jolli",
"amount": "2460"
},
{
"id": 36,
"name": "GOtv Jinja N1,640",
"code": "gotv-jinja",
"amount": "1640"
},
{
"id": 37,
"name": "GOtv Smallie - monthly N800",
"code": "gotv-smallie",
"amount": "800"
},
{
"id": 38,
"name": "GOtv Smallie - quarterly N2,100",
"code": "gotv-smallie-3months",
"amount": "2100"
},
{
"id": 39,
"name": "GOtv Smallie - yearly N6,200",
"code": "gotv-smallie-1year",
"amount": "6200"
},
{
"id": 56,
"name": "GOtv Supa - monthly N5,500",
"code": "gotv-supa",
"amount": "5500.00"
}
]
}
Tv Validate
To perform a Tv UIC Number Validation
Endpoint: /tv/validate
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 |
Body Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| provider | string | Yes | please use the id of the provider as returned in internet providers (e.g. for Airtel, use 1) |
| number | string | Yes | Customer's/beneficiary's Smartcard or IUC number to subscribe on |
Sample Post
curl https://api.budpay.com/api/v2/tv/validate
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{"provider":"GOTV",
"number": "2019505346"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "SUCCESSFUL",
"data": {
"orderNo": "211104130931335009",
"reference": "25696593r9622",
"status": "Delivered",
"errorMsg": null
}
}
Tv Subscription
To Initiate a Tv Subscription Payment
Endpoint: /tv/pay
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 id of the provider as returned in Tv providers (e.g. for Airtel, use 1) |
| number | string | Yes | Customer's/beneficiary's smartcard/IUC number to subscribe on |
| plan_id | string | Yes | id of the TV Package (Bouquet) 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/tv/pay
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{"provider":"GOTV",
"number": "2019505346",
"code": "gotv-max",
"reference": "20220511035554758"
}'
-X POST
Sample Response
{
"success": true,
"code": "00000",
"message": "SUCCESSFUL",
"data": {
"orderNo": "211104130931335009",
"reference": "20220511035554758",
"status": "Delivered",
"errorMsg": null
}
}