Receive Payments - Bill Payments
Test URL
POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/bills/pay
Live URL
POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/bills/pay
This API Provides Partners the Capability To Initiate Utility Bill Payments For Goods And Services
200 Success Response Schema
Field Name | Field Type | Field Description |
---|---|---|
status | string | bill processing status i.e whether SUCCESS or FAILED |
transactionId | string | payment transaction id. returned only if payment is successful |
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formula
biller.billerCode+bill.amount+payer.reference+partnerId
Request Fields
Field Name | Description | Type | Required |
---|---|---|---|
biller.billerCode | Unique code for the biller | String | Yes |
biller.countryCode | Country code of the biller | String | Yes |
bill.reference | Unique reference for the bill payment | String | Yes |
bill.amount | Amount to be paid for the bill | Number | Yes |
bill.currency | Currency of the payment (e.g., KES) | String | Yes |
payer.name | Name of the person making the payment | String | Yes |
payer.account | Account number of the payer | String | Yes |
payer.reference | Unique reference for the payer | String | Yes |
payer.mobileNumber | Mobile number of the payer | String | Yes |
partnerId | Unique partner identifier | String | Yes |
remarks | Optional remarks about the payment | String | No |
Example Request
curl -X POST \
-d '{
"biller": {
"billerCode": "320320",
"countryCode": "KE"
},
"bill": {
"reference": "10170476767676",
"amount": "111.00",
"currency": "KES"
},
"payer": {
"name": "A. N Other",
"account": "101704",
"reference": "123451000002",
"mobileNumber": "0764555320"
},
"partnerId": "0020100014605",
"remarks": "These are just some remarks"
}' \
-H 'Authorization: Bearer {{token}}' \
-H 'signature: {{signature}}' \
-H 'Content-Type: application/json' \
-L 'https://uat.finserve.africa/v3-apis/transaction-api/v3.0/bills/pay'
Example Response
Example Response
{
"status": true,
"code": 0,
"message": "success",
"reference": "10170476767676",
"data": {
"transactionId": "123451000002",
"status": "SUCCESS"
}
}