POST
/
api
/
niobi-payment

Authorizations

Authorization
string
header
required

Enter token in format (Bearer <token>)

Body

application/json
amount
integer
required

This is the Amount of money you wish to transfer. This amount shall always be less than the total value in your Balance

city
string
required

This is the city of the Payee who is being paid out

country
string
required

This is the country of the Payee who is being paid out

currency
string
required

This is the currency of the payouts you are making. At the moment, Niobi Payments supports KES transactions only

email
string
required

This is the email of the Payee who is being paid out

first_name
string
required

This is the first name of the Payee who is being paid out

last_name
string
required

This is the last name of the Payee who is being paid out

line1
string
required

This is the street address of the Payee who is being paid out

mobile
string
required

This is the mobile number of the Payee who is being paid out. Use the correct formatting as described in the example

payment_method_type
enum<string>
required

This is the preferred payment method you want to use to payout the money and what makes the Niobi Payment API really unique as we support all popular mobile money and bank payments

Available options:
mtn,
Orange,
Vodacom,
Airtel,
at,
Vodafone,
tnm,
Zamtel,
Halotel,
Tigo,
Free,
send money,
till number,
pay bill,
pesalink
postal_code
string
required

This is the postal code of the Payee who is being paid out

Airtel
object[]

Using Airtel method needs a recipient's phone number and correspondent of payment method

at
object[]

Using at method needs a recipient's phone number and correspondent of payment method

client_callback_url
string

You can provide call back URL to get payment confirmation response.

customer_identifier
integer

This is the Customer Identifier number for sub-wallet.

description
string

This is the description or message from payer who is paying out

Free
object[]

Using Free method needs a recipient's phone number and correspondent of payment method

Halotel
object[]

Using Halotel method needs a recipient's phone number and correspondent of payment method

mtn
object[]

Using mtn method needs a recipient's phone number and correspondent of payment method and correspondent of payment method

Orange
object[]

Using Orange method needs a recipient's phone number and correspondent of payment method

paybill
object[]

Using M-Pesa PayBill method needs A Paybill Number and Account Number

payment_reference
string

This is the account number associated with Niobi, that holds the value from which a pyaout is being made

Niobi Payments also allows payouts via Bank Transfers using Pesalink. This transfer needs the following information

sendmoney
object[]

Using M-Pesa Send Money method needs a recipient's phone number

Tigo
object[]

Using Tigo method needs a recipient's phone number and correspondent of payment method

tillnumber
object[]

Using M-Pesa till number method needs the recipient's Till Number

tnm
object[]

Using tnm method needs a recipient's phone number and correspondent of payment method

Vodacom
object[]

Using Vodacom method needs a recipient's phone number and correspondent of payment method

Vodafone
object[]

Using Vodafone method needs a recipient's phone number and correspondent of payment method

Zamtel
object[]

Using Zamtel method needs a recipient's phone number and correspondent of payment method

Response

200 - application/json

The response is of type any.