Get All Billers
Test URL
Live URL
This web service returns a paginated list of all billers
200 Success Response Schema
| Field Name | Field Type | Field Description |
|---|---|---|
status | bool | Response status |
code | number | Response code |
message | string | Response message |
data | billers | Response object |
data.billers | array | biller array |
billers.name | string | biller name |
billers.code | string | biller code |
Example Request
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
<random_string>URL Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
per_page | int | Number of results per page (pagination) | Optional |
page | int | Page number for pagination | Optional |
curl -X GET \
-H 'Authorization: Bearer {{token}}' \
-L 'https://sandbox.jengahq.io/transaction-test/v3/billers?per_page=3&page=6'Example Response
{
"status":true,
"code":0,
"message":"success",
"data":{
"billers":[
{
"name":"INCULSIVITY",
"code":"642292"
},
{
"name":"I PAY",
"code":"266300"
},
{
"name":"MDUKA ONLINE",
"code":"123456"
},
{
"name":"ECITIZEN",
"code":"967600"
},
{
"name":"KPLC",
"code":"6800001"
},
{
"name":"test biller",
"code":"400000"
},
{
"name":"JAMBO PAY TRUSTEE ACCOUNT",
"code":"147147"
},
{
"name":"I PAY",
"code":"300014"
},
{
"name":"ZUKU",
"code":"320320"
},
{
"name":"WINGS TO FLY",
"code":"344344"
},
{
"name":"VIRTUAL MOBILE LIMITED",
"code":"111111"
},
{
"name":"A.C.K ST JAMES CHURCH BURUBURU",
"code":"303030"
},
{
"name":"MARY WAMBUI KAMANDE",
"code":"389443"
},
{
"name":"SAMUEL THURI GACHO",
"code":"800589"
},
{
"name":"JOHN MUHUNGI THURI",
"code":"017019"
},
{
"name":"BENCHMARK DISTRIBUTORS LIMITED",
"code":"644443"
},
{
"name":"EAZZY PAY ONLINE",
"code":"900900"
},
{
"name":"AZURI TECHNOLOGIES KENYA LIMITED",
"code":"821055"
}
]
}
}Error Responses
400 Bad Request
Missing or invalid parameters in the request body.
{
"status": false,
"code": 400,
"message": "Invalid request parameters",
"error_code": "INVALID_REQUEST"
}401 Unauthorized
Invalid or expired access token.
{
"status": false,
"code": 401,
"message": "Invalid or expired access token",
"error_code": "UNAUTHORIZED"
}403 Forbidden
Valid credentials but invalid signature or insufficient permissions.
{
"status": false,
"code": 403,
"message": "Invalid signature or insufficient permissions",
"error_code": "FORBIDDEN"
}404 Not Found
Account not found or invalid account number.
{
"status": false,
"code": 404,
"message": "Source or destination account not found",
"error_code": "ACCOUNT_NOT_FOUND"
}Transaction Status Errors
| Response Status | Response Code | Response Message |
|---|---|---|
| false | 111102 | Transaction with the passed reference cannot be found |
📖 Step-by-Step Guide
Step 1: 🔑 Set Up Security Keys
Generate your private and public key pair and share your public key with Finserve. See the Security & Signatures Documentation (opens in a new tab) for detailed instructions.
Step 2: 🎫 Authenticate
Obtain an access token using the authentication endpoint. See the Authentication API documentation (opens in a new tab) for details.
Step 3: 📋 Prepare Transaction Details
Gather all required information.
Step 4: ✍️ Generate Signature
Create the signature string by concatenating in this exact order:
<random_string>Sign this string using your private key, then Base64 encode the result.
Step 5: 📝 Set Up Headers
Include the following headers in your request:
Content-Type: application/jsonAuthorization: Bearer [your_access_token]Signature: [your_base64_encoded_signature]
Step 6: 🔧 Construct Request Body
Create a JSON object with all required fields following the structure shown in the example request.
Step 7: 🚀 Send POST Request
Make a POST request to the internal bank transfer endpoint with your headers and body.
🌍 Supported Countries & Currencies
| Country | Country Code | Common Currency Codes |
|---|---|---|
| Kenya | KE | KES |
| Uganda | UG | UGX |
| Tanzania | TZ | TZS |
| Rwanda | RW | RWF |
| South Sudan | SS | USD |
| DRC | DRC | USD |
Best Practices
-
** Security**
- Store your private key securely and never expose it in client-side code or version control
- Always use HTTPS for API requests
- Store access tokens securely
- Regenerate signatures for each request
-
** Signature Generation**
- Ensure exact string concatenation order:
<random_string> - Do not include spaces, separators, or special characters in the concatenated string
- Always Base64 encode the signature before including it in headers
- Verify the values in the signature match exactly with the request body values
- Ensure exact string concatenation order:
-
** Transaction Reference**
- Use unique reference numbers for each transaction
- Implement a reference generation system to avoid duplicates
- Store reference numbers for reconciliation and audit purposes
- Never reuse reference numbers, even for failed transactions
-
Amount Formatting
- Always use decimal format with two decimal places (e.g., "500.00")
- Pass amounts as strings, not numbers
- Ensure the amount is positive and within allowed limits
- Verify amount matches exactly in signature and request body
-
Error Handling
- Implement retry logic with exponential backoff for transient errors
- Log transaction attempts and responses for audit purposes
- Handle signature validation errors by regenerating the signature
-
Testing
- Always test with the UAT endpoint before using the live endpoint
- Use test account numbers provided in the documentation
- Verify signature generation with sample data first
- Test error scenarios to ensure proper handling
-
Data Validation
- Validate all account numbers match the expected format
- Verify country codes are valid and supported
- Ensure transfer dates are in the correct format (YYYY-MM-DD)
- Validate currency codes match the destination country
Troubleshooting
Invalid Signature Error (403)
If you receive a 403 error with "Invalid signature":
- Verify the concatenation order:
<random_string> - Ensure no spaces or separators are included in the concatenated string
- Check that the signature is Base64 encoded
- Verify your public key is correctly registered with us
- Ensure the values in the signature match exactly with the request body values
Common Signature Mistakes
- Using wrong concatenation order
- Adding spaces or separators between values
- Not Base64 encoding the final signature
- Values in signature don't match request body values
Support
For questions or issues with this API:
- Email: support@finserve.africa