Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.niobi.co/llms.txt

Use this file to discover all available pages before exploring further.

Release Date: 03/2026

​
Overview

This release includes updates to the Payment Link v3 request payload, a development environment base URL change, South Africa flow enhancements, updated transaction limits for UGX and RWF, XAF Cameroon payout requirements, and a new Orange sandbox flow.

​
Breaking Changes

The following changes require immediate updates to your integration. Failure to update may result in rejected or failed transactions.
The Payment Link v3 API request payload now supports an optional currency_country_id field. This field identifies the country of the payer (customer) making the payment, based on the selected currency. It is used to support multi-country currency scenarios and ensures payments are routed correctly depending on the payer’s location. Sample Request Payload (Payment Link v3) 
{
    "client_id": "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxz",
    "salt": "justrandomstring",
    "timestamp": xxxxxxxxx,
    "signature": "2193dxxxxxxxxxxxxxxxxxx5d5807",
    "params": {
        "amount": 500,
        "currency": "KES",
        "currency_country_id": 1, //represent the actual country of collection
        "description": "Payment for Order #1234",
        "email": "customer@example.com",
        "first_name": "Jane",
        "last_name": "Doe",
        "payment_reference": "ORDER1234",
        "business_name": "my business",
        "item_name": "item name",
        "callback_url": "https://webhook.site/unique-id",
        "redirection_url": "https://webhook.site/unique-id",
        "logo": null,
        "country_id": 2, //represents current location of payer
        "phone": "25471xxxxxxx"
    }
}
currency_country_id — Optional. The numeric ID representing the country associated with the transaction currency. Refer to the Countries reference for the full list of IDs. You can find more details on the request payload here
If omitted, the system will infer the country from currency and country_id.

​
2. Sandbox Environment Base URL Change

The base URL for the sandbox environment has been updated. Please update all sandbox API calls and webhook configurations immediately. Previous base URL: 
https://dev.users.niobi.co
New base URL: 
https://sandbox.users.niobi.co
The previous URL will be deprecated. Please migrate as soon as possible.

​
3. XAF Cameroon Payouts - Sender Name & Sender Number Now Required

XAF payouts to Cameroon now require sender_firstname, sender_lastname and sender_phone_number in the payout request to comply with local regulatory requirements. 
{
    "params": {
        "country_id": 4,
        "currency": "XAF",
        "sender_firstname": "John",
        "sender_lastname": "Doe",
        "sender_phone_number": "2376XXXXXXXX",
        "amount": 5000
        ...
    }
}
  • sender_firstname, sender_lastname — Full name of the sender initiating the payout.
  • sender_phone_number — Phone number of the sender in international format.
  • Refer to the full request payload here
Requests submitted without these fields will fail.

​
New Features & Updates

​
4. South Africa Flow - successful_url and failure_url

The South Africa payment flow now supports successful_url and failure_url redirect parameters, allowing you to redirect customers to custom pages upon payment completion or failure. 
{
    "params": {
        "country_id": 15,
        "currency": "ZAR",
        "successful_url": "https://yoursite.com/payment/success",
        "failure_url": "https://yoursite.com/payment/failure"
        ...
    }
}
  • successful_url — The URL to redirect the customer to upon a successful payment.
  • failure_url — The URL to redirect the customer to if the payment fails or is cancelled.
Both fields are required. You can find more details on the request payload here

​
5. Updated UGX Transaction Limits

We have updated the transaction limits for UGX (Ugandan Shilling) payouts. These new limits are now in effect and apply to all UGX transactions. Please review and adjust your integration accordingly to ensure compliance and avoid failed transactions. For full details on the updated limits, refer to the transaction limits page.

​
6. New Ivory Coast Orange Sandbox Flow

The Ivory Coast Orange Flow is now supported on the sandbox environment to simulate the full production flow, allowing for more accurate pre-production validation. Refer to the Ivory Coast Orange Flow for full setup instructions and testing phone numbers for numbers you can use to test the flow on sandbox.

​
7. Portal IP Whitelisting Management

A new portal feature is live allowing users to manage IP whitelisting directly in the dashboard. In Workspace > IP Whitelisting, you can add, edit, or delete IP entries without contacting support.
  • Add new IP addresses using the “Add New” button.
  • Modify existing entries with “Edit”.
  • Remove entries with “Delete”.
This feature streamlines secure API access setup and speeds up environment transitions. You can view more details here