Make Payments

This section explains how to execute payouts using Niobi’s Payment API, covering various payment channels and the payout process.

This page covers Version 3 of the API. For the latest samples and integration flow, refer to the updated Make Payments v4 page.

To start making payments using these methods, ensure that your Niobi account is set up and verified. Refer to the ‘Setting up a Niobi Account’ section in the Getting Started section for detailed steps on account creation and setup.

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 should 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.
Email	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.
Address Line 1	String	Yes	The address line 1 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 recipient’s phone number for the selected payment method type.

You will then generate a signature using the parameters above and proceed to make an api request using the payload. On successful payment, you will receive a callback response with the transaction details. Please find a detailed description of the callback response under Callback URL Section.

Please note that all live transactions made through our API are subject to a transaction fee.