Using the API
The unified-payments api endpoint is used for making payments across the supported countries. Please find the full API reference here. You will be required to pass in the following parameters.Parameter | Type | Required | Description |
---|---|---|---|
Amount | Number | Yes | The amount to be paid from your account. This is in absolute form (e.g. 100 KES to be passed as 100). |
Currency | String | Yes | The currency in which the payment will be made. |
Payment Reference | String | Yes | Information you will use to refer to the transaction later. |
First Name | String | Yes | The first name of the recipient. |
Last Name | String | Yes | The last name of the recipient. |
Mobile | String | Yes | The phone number of the recipient. |
String | Yes | The email of the recipient. | |
Country ID | String | Yes | The ID of the country the payment will be made to. The full list can be found here. |
City | String | Yes | The city of the recipient. |
Postal Code | String | Yes | The postal code of the recipient. |
Line1 | String | Yes | The address line of the recipient. |
Description | String | No | A description or message from the payer who is making the payment. |
Client Callback URL | String | Yes | The callback URL for payment confirmation response. |
Third Party Reference | String | No | Information you’d like to use to refer to the deposit later. |
Payment Method Type | String | Yes | The payment channel that will be used for the payment. |
Payment Method Object | Object | Yes | An object containing the phone number of the recipient, associated with the selected payment method type. |
Please note that all live transactions made through our API are subject to a transaction fee.
Sample Flow
This section provides a high-level overview of how to integrate with the Disbursements API.1
Initiating the Unified Disbursements API Request
To begin, generate a signature for your api request using the generate signature api endpoint and initiate a payout transaction by making an API request.
Sample API Request
2
Handling Transaction Status
Once the transaction has been processed, you have two options for managing the transaction status:
- Receiving a Callback.
A callback response containing the transaction details will be sent to your configured URL. You can set up an endpoint on your front end to handle this callback and update the user interface accordingly, such as displaying success or failure messages based on the transaction outcome. See more about callback responses here
Sample Callback Response
- Constantly Querying Transaction Status. Alternatively, you can query the transaction status endpoint periodically (recommended for 2 minutes) to check for updates on the transaction status.