Bill Payments
Use Flutterwave to pay bills in Nigeria.
With the Flutterwave APIs, you can pay for various bills, including Airtime, Cable, Subscriptions, Utilities, and more using your Flutterwave Wallet.
Only Nigerian Billers
Currently, our bill payment APIs support payments only for Nigerian billers. Kindly contact our support team to request more coverage on this feature.
Prerequisites
- Complete your profile and KYC.
- Fund your source balance, which is the balance to be debited for bill payment. You can do this by
- Direct funding your balance.
- Indirect funding it by moving funds from a different balance to your source balance. Refer to the list of supported currencies for intra-wallet transfers.
- Whitelist your server IP's for the API calls.
Supported Bill Types
Flutterwave supports payments for different bills, including Airtime, Data Subscriptions, Cable Payments, Internet Subscriptions e.g. IPNX, Utility Bills, and Tax Payments.
To see the full list of supported bill payments, query the bill category endpoint.
Making bill Payments
To successfully pay bills on Flutterwave, follow these steps:
- Fetch the bill information to display to your customers.
- Collect and validate customer information.
- Initiate the bill payment request.
- Verify the payment status.
Step 1: Fetching Bills and Billers' Information
Understanding the different types of bills is important for helping your customers select the correct one to pay. This process involves three steps:
- First, call the high-level category API. This returns the supported categories for the country.
- With the category code, query the billers API, which returns billers for the selected category and country sent in the request.
- Finally, fetch the bill items (packages) by calling the bill item endpoint.
Each step returns important information for you to display to your customers.
{
"status": "success",
"message": "Categories fetched successfully",
"data": [
{
"id": 1,
"name": "Airtime",
"code": "AIRTIME",
"description": "Airtime",
"country_code": "NG"
},
{
"id": 2,
"name": "Mobile Data Service",
"code": "MOBILEDATA",
"description": "Mobile Data Service",
"country_code": "NG"
},
{
"id": 3,
"name": "Cable Bill Payment",
"code": "CABLEBILLS",
"description": "Cable Bill Payment",
"country_code": "NG"
},
{
"id": 4,
"name": "Internet Service",
"code": "INTSERVICE",
"description": "Internet Service",
"country_code": "NG"
},
{
"id": 5,
"name": "Utility Bills",
"code": "UTILITYBILLS",
"description": "Utility Bills",
"country_code": "NG"
},
{
"id": 6,
"name": "Tax Payment",
"code": "TAX",
"description": "Tax Payment",
"country_code": "NG"
},
{
"id": 7,
"name": "Donations",
"code": "DONATIONS",
"description": "Donations",
"country_code": "NG"
},
{
"id": 8,
"name": "Transport and Logistics",
"code": "TRANSLOG",
"description": "Transport and Logistics",
"country_code": "NG"
},
{
"id": 9,
"name": "Dealer Payments",
"code": "DEALPAY",
"description": "Dealer Payments",
"country_code": "NG"
},
{
"id": 17,
"name": "Religious Institutions",
"code": "RELINST",
"description": "Religious Institutions",
"country_code": "NG"
},
{
"id": 18,
"name": "Schools & Professional Bodies",
"code": "SCHPB",
"description": "Schools & Professional Bodies",
"country_code": "NG"
}
]
}
{
"status": "success",
"message": "Billers fetched successfully",
"data": [
{
"id": 66,
"name": "DSTV",
"logo": null,
"description": "DSTV",
"short_name": "DSTV",
"biller_code": "BIL119",
"country_code": "NG"
},
{
"id": 67,
"name": "GOTV",
"logo": null,
"description": "GOTV",
"short_name": "GOTV",
"biller_code": "BIL120",
"country_code": "NG"
},
{
"id": 68,
"name": "DAARSAT Communications",
"logo": null,
"description": "DAARSAT Communications",
"short_name": "DAARSAT Communications",
"biller_code": "BIL123",
"country_code": "NG"
},
{
"id": 69,
"name": "DSTV BOX OFFICE",
"logo": null,
"description": "DSTV BOX OFFICE",
"short_name": "DSTV BOX OFFICE",
"biller_code": "BIL125",
"country_code": "NG"
},
{
"id": 70,
"name": "MyTV",
"logo": null,
"description": "MyTV",
"short_name": "MyTV",
"biller_code": "BIL128",
"country_code": "NG"
},
{
"id": 71,
"name": "HiTV",
"logo": null,
"description": "HiTV",
"short_name": "HiTV",
"biller_code": "BIL129",
"country_code": "NG"
},
{
"id": 91,
"name": "STARTIMES",
"logo": null,
"description": "STARTIMES",
"short_name": "STARTIMES",
"biller_code": "BIL123",
"country_code": "NG"
}
]
}
Step 2: Collect and validate the customer's information
Integration Tip
No validation is required for airtime and data bills.
After selecting the correct bill to pay for, the customer needs to send their information. We call this the customer parameter, which is an identifier for the customer making the payment:
- For airtime and mobile data bundles, the identifier is the customer's phone number.
- For Wi-Fi Internet bundles, the identifier is the customer's account number on that service.
- For electricity bills, the identifier is the customer's meter number.
- For cable subscriptions, the identifier is the customer's decoder or smart card number.
You don't need to hardcode the identifier field in your code. As shown in the examples (from step 1), the get bills endpoint returns a label_name field that contains a description of the identifier. Simply display this label next to a text box for your customer to enter their information.
Before proceeding with the payment, it's highly recommended to validate the information provided by your customer. To do this quickly, pass the customer identifier and the biller_code into the validate bill API.
{
"status": "success",
"message": "Item validated successfully",
"data": {
"response_code": "00",
"address": null,
"response_message": "Successful",
"name": "Test DSTV Account",
"biller_code": "BIL119",
"customer": "0025401100",
"product_code": "CB141",
"email": null,
"fee": 0,
"maximum": 0,
"minimum": 0
}
}
Step 3: Initiating the Bill Payment
On successful validation, Send the customer and biller create bill endpoint to initiate the payment. The important requirements for this request include:
country: The customer's country. It should match the value specified in the get category request.customer_id: The customer identifier validated in step 2.amount: The amount to be paid for the bill. This must matchdata.amountreturned from the get-bills endpoint.
It's important to also pass a custom reference in your request for easy tracking.
{
"country": "NG",
"customer_id": "45076454185",
"reference": "b1989abb-4167-41ce-b855-67377db12acd" //optional parameter,
"amount": 200,
"callback_url":"https://webhook.site/a2cd20ad-42d5-46f6-8e66-9ef07cbc121f" //optional parameter.
}
Response should look like this:
{
"status": "success",
"message": "Bill payment successful",
"data": {
"phone_number": "+2347065657658",
"amount": 11,
"network": "MTN",
"code": "200",
"tx_ref": "CF-FLYAPI-20240308035516465263",
"reference": "BPUSSD1709913319189093",
"batch_reference": null,
"recharge_token": null,
"fee": 0
}
}
In the response, we will first return the pending status. Once the payments have been processed successfully, we will notify you via webhooks.
Step 4: Checking a Payment's Status
We provide two seamless ways to query a payment's status. You can poll the get status endpoint or receive webhooks for the payment. Using the get status endpoint, you should get a response like this:
{
"status": "success",
"message": "Bill status fetch successful",
"data": {
"currency": "NGN",
"customer_id": "07065657658",
"frequency": "One Time",
"amount": "11.0000",
"fee": 0,
"product": "AIRTIME",
"product_name": null,
"commission": 0,
"transaction_date": "2024-03-08T15:55:16.963Z",
"customer_reference": "d7a004b1-a581-4cd9-89ae-a1ff89c45c9a",
"country": "NG",
"flw_ref": "BPUSSD1709913319189093",
"tx_ref": "CF-FLYAPI-20240308035516465263",
"batch_id": 3387836,
"extra": null,
"product_details": "FLY-API-NG-AIRTIME"
}
}
If you choose to use webhooks to update your transaction's status, you should read the webhook section to make sure you set up your webhook servers properly to get notifications from us.
Managing your Bill Transaction History
Retrieve your payment logs using the transaction history APIs. We provide two different views for historical transactions:
- Bill summary: This API reports the summary view of all the bill payments made in a period.
- Bill histories: This API returns the transaction log of all bill payments made.
Combining both views gives you a 360-degree view of all the payments made on your account.
Testing DSTV
- Collect and validate your customer's information (see required information in this step).
- To validate on test mode, use the DSTV credential.
- Add the credential to your request payload.
- Send the request to the create bill payment endpoint.
- Check your webhook server for the successful bill payment.
- Verify the status using the status endpoint.
Updated 25 days ago