Skip to main content
POST
createPaymentLink

Authorizations

Authorization
string
header
required

Enter token in format (Bearer )

Body

application/json

Create payment link.

business_name
string<business_name>
required

This is your business name. Example: ABC Ltd

Example:

"ABC Ltd"

item_name
string<item_name>

This is the name of the item billed and to be paid. Example: xyz

Example:

"xyz"

callback_url
string<callback_url>

This is the callback url where you wish to receive the response. Example: https://your-domain.com/niobi/result

Example:

"https://your-domain.com/niobi/result"

redirection_url
string<redirection_url>

This is the redirection url. Example: https://your-domain.com/niobi/result

Example:

"https://your-domain.com/niobi/result"

This is brand logo. Use the base64 format to upload a file of maximum 2MB size.

Example:

"image.png"

amount
integer<amount>

This is the amount of money to be paid by your customer. It should be in unit case i.e. *100 (e.g. Kes 10 should be input as Kes 1000)

Example:

"integer"

country_id
integer<integer>

This is integer value. You can get country list from Niobi get-countries API

currency
string<string>

This is the currency in which the payment is to be made. Example: KES

correspondent
string<string>

This is the correspondent to be used for the payment. Example: MTM_MOMO_UGA

Response

Ok.

success
boolean
Example:

"true"

message
string
Example:

"Verification token was sent to your mobile number. Kindly verify to proceed with payment"

data
object