Skip to main content
POST
/
api
/
v3
/
payment-link-api
/
create
Create Payment Link v3
curl --request POST \
  --url https://sandbox.users.niobi.co/api/v3/payment-link-api/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr",
  "salt": "justrandomstring",
  "sender": "John.co",
  "params": {
    "business_name": "my business",
    "item_name": "item name",
    "callback_url": "https://webhook.site/unique-id",
    "redirection_url": "https://webhook.site/unique-id",
    "currency": "KES",
    "amount": "5000",
    "logo": "This is brand logo. Use the base64 format to upload a file of maximum 2MB size.",
    "country_id": "This is integer value. You can get country id from supported country table attached here.",
    "currency_country_id": "This is integer value which represent country user is making deposit from and corresponds to the selected currency. You can get country id from supported country table attached here.",
    "first_name": "KES",
    "last_name": "KES",
    "email": "KES",
    "phone": "KES"
  },
  "timestamp": 1709363033,
  "signature": "2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"
}
'
{
  "success": true,
  "message": "Payment link created successfully.",
  "data": {}
}
Please make sure to generate a new signature whenever you are creating a new balance request.

Currency Country ID (Optional)

currency_country_id identifies the country of the payer (customer), 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. For backward compatibility, this field is optional; if omitted the system will infer the country from currency and country_id where possible.

​
List of Supported Countries

Country IdCountryCountry CodeCurrencyPayment Method typeRequired Fields
1Kenya254KEStill number, pay bill, pesalink, send moneycountry_id, currency
2Benin229XOFmtncountry_id, currency
3Cote D’Ivoire225XOFmtn, Orangecountry_id, currency
4Cameroon237XAFmtn, Orangecountry_id, currency
9Senegal221XOFOrange, Freecountry_id, currency
10Tanzania255TZSAirtel, Halotel, Tigocountry_id, currency
11Uganda256UGXmtn, Airtelcountry_id, currency
12Zambia260ZMWZamtel, mtncountry_id, currency
13Sierra Leone232SLEOrangecountry_id, currency
16Ghana233GHSmtn, AT, Vodafonecountry_id, currency
17Nigeria234NGNbankcountry_id, currency
For Senegal Orange deposits, the end user receives an SMS with a shortcode after the deposit is initiated. They dial the shortcode, triggering a USSD prompt where they input their PIN to approve the transaction.

Body

application/json

Payload for creating a payment link for API

​
client_id
string
required

The Client id is your public key which is generated when you are creating a new API integration from our app.

Example:

"K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr"

​
salt
string
required

Salt is used for security purposes. This is a random string and can be unique value for each request or always the same.

Example:

"justrandomstring"

​
sender
string
required

The Sender is the title of the API Integration which was created through our app. you can just copy this title and use it whenever making a new signature

Example:

"John.co"

​
params
object
required
​
timestamp
integer

this is the current timestamp when the request is being made

Example:

1709363033

​
signature
string
Example:

"2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"

Response

Success

​
success
boolean
Example:

true

​
message
string
Example:

"Payment link created successfully."

​
data
object