How It Works
BillPay API
The BillPay API enables you to create BillPay Control Numbers for orders and customers to receive payments from mobile money wallets and bank accounts
Prerequisites
- API Keys Create an Application to generate Client ID and API Keys for API access.
- Authorization Token Use API Keys to Generate Authorization Token.
How It Works
Step 1 – Create BillPay Control Number
Create Order BillPay Control Number
This endpoint creates an Order Control Number for a specific transaction or invoice.
You can specify the amount, payment mode (full or partial), a custom reference, and other metadata.
Create Customer BillPay Control Number
This endpoint creates a Customer Control Number for a specific customer.
You can include customer name, bill description, amount, and payment mode.
Multiple control numbers can be generated per customer for different bills or purposes.
Step 2 – Share BillPay Control Number
Share BillPay Control Number
Once created, the BillPay Control Number can be shared with customers via:
- SMS or WhatsApp message with the control number and payment instructions.
- Email with bill details and the control number.
- Embedded in invoices or payment links on your website.
Step 3 – Verify Payment
Query Payment Status via API
Query Payment Status
You can check the payment status using the payment’s Order Reference by querying the API.
This allows you to retrieve real-time payment information for reconciliation or reporting.
Receive Webhook Notifications
Webhook Notifications
Alternatively, set up a webhook to automatically receive callbacks whenever a payment is completed or updated.
Step 4 – Fetch BillPay Details (Optional)
Query BillPay Control Number Details
Use this endpoint to retrieve full details of a BillPay Control Number, including, amount, reference, linked customer and invoice details.
This is useful for displaying bill details to customers or performing audits.