Submit Niobi Unified Payments

POST

api

niobi-unified-payments

curl --request POST \
  --url https://dev.users.niobi.co/api/v3/niobi-unified-payments \
  --header 'Content-Type: application/json' \
  --data '{
  "client_id": "K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr",
  "params": {
    "amount": 1000,
    "customer_identifier": 1234,
    "currency": "KES",
    "payment_reference": "TRANS-123456789",
    "first_name": "John",
    "last_name": "Doe",
    "mobile": "254123456789",
    "email": "john@doe.com",
    "country_id": "1",
    "city": "Nairobi",
    "postal_code": "001001",
    "line1": "abc, xyz",
    "description": "abc, xyz",
    "client_callback_url": "https://your-domain.com/niobi/result",
    "third_party_reference_1": "<string>",
    "third_party_reference_2": "<string>",
    "payment_method_type": "send money",
    "mtn": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Orange": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Vodacom": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Airtel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "at": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Vodafone": [
      {
        "phone_number": "254123456789"
      }
    ],
    "tnm": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Zamtel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Halotel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Tigo": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Free": [
      {
        "phone_number": "254123456789"
      }
    ],
    "sendmoney": [
      {
        "phone_number": "254123456789"
      }
    ],
    "paybill": [
      {
        "paybill_number": "123456",
        "account_number": "123456789"
      }
    ],
    "tillnumber": [
      {
        "till_number": "123456"
      }
    ],
    "pesalink": [
      {
        "bank_name": "ABC",
        "bank_code": "00",
        "branch_name": "ABC",
        "account_name": "ABC",
        "account_number": "123456789"
      }
    ]
  },
  "salt": "justrandomstring",
  "sender": "John.co",
  "timestamp": 1709363033,
  "signature": "2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"
}'

{
  "success": "true",
  "message": "Payment process initiated successfully.",
  "data": "",
  "res": ""
}

Please make sure to generate a new signature whenever you are creating a new payment.

List of Supported Countries

Country Id	Country	Country Code	Currency	Payment Method type	Required Fields
1	Kenya	254	KES	till number, pay bill, pesalink, send money	country_id, currency
2	Benin	229	XOF	mtn, Moov	country_id, currency
3	Cote D’Ivoire	225	XOF	mtn, Orange	country_id, currency
4	Cameroon	237	XAF	mtn, Orange	country_id, currency
8	Rwanda	250	RWF	mtn, Airtel	country_id, currency
9	Senegal	221	XOF	Orange, Free	country_id, currency
10	Tanzania	255	TZS	Airtel, Halotel, Tigo	country_id, currency
11	Uganda	256	UGX	mtn, Airtel	country_id, currency
12	Zambia	260	ZMW	Zamtel, mtn, Airtel	country_id, currency
13	Sierra Leone	232	SLE	Orange	country_id, currency

List of Supported Kenyan Banks

id	bank_name	niobi_bank_code
1	Kenya Commercial Bank	1
2	Standard Chartered	2
3	Absa Bank Kenya	3
4	Ncba Bank Kenya	7
5	Prime Bank	10
6	Cooperative Bank	11
7	National Bank of Kenya	12
8	Citibank N.A Kenya	16
9	Middle East Bank Kenya	18
10	Bank of Africa Kenya	19
11	Credit Bank Limited	25
12	CFC Stanbic Kenya	31
13	Paramount Bank	50
14	Jamii Bora Bank	51
15	Guaranty Trust Bank	53
16	Guardian Bank	55
17	I&M Bank	57
18	Diamond Trust Bank	63
19	Sidian Bank	66
20	Equity Bank Kenya	68
21	Family Bank Limited	70
22	Gulf African Bank	72
23	First Community Bank	74
24	Kenya Women’s Finance Trust	78

Body

application/json

Payload required for initiating a Niobi payment transaction.

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"

params

object

required

params.amount

integer

required

The amount to be transferred. Please note this value should be in standard units(x100)

Example:

1000

params.currency

string

required

Currency of the transaction.

Example:

"KES"

params.payment_reference

string

required

Any information you can use to reference this transaction later.

Example:

"TRANS-123456789"

params.first_name

string

required

First name of the payee.

Example:

"John"

params.last_name

string

required

Last name of the payee.

Example:

"Doe"

params.mobile

string

required

Mobile number of the payee.

Example:

"254123456789"

params.email

string

required

Email of the payee.

Example:

"john@doe.com"

params.country_id

integer

required

Country Id can be used from above table.

Example:

"1"

params.city

string

required

City of the payee.

Example:

"Nairobi"

params.postal_code

string

required

Postal code of the payee.

Example:

"001001"

params.line1

string

required

Street address of the payee.

Example:

"abc, xyz"

params.client_callback_url

string

required

Callback URL for payment confirmation response.

Example:

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

params.payment_method_type

enum<string>

required

Preferred payment method.

Available options:

mtn,

Orange,

Vodacom,

Airtel,

at,

Vodafone,

tnm,

Zamtel,

Halotel,

Tigo,

Free,

send money,

till number,

pay bill,

pesalink

Example:

"send money"

params.customer_identifier

integer

Customer identifier for sub-wallet.

Example:

1234

params.description

string

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

Example:

"abc, xyz"

params.third_party_reference_1

string

customer internal transaction reference

params.third_party_reference_2

string

customer external transaction reference

params.mtn

object[]

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

params.Orange

object[]

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

params.Vodacom

object[]

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

params.Airtel

object[]

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

params.at

object[]

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

params.Vodafone

object[]

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

params.tnm

object[]

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

params.Zamtel

object[]

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

params.Halotel

object[]

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

params.Tigo

object[]

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

params.Free

object[]

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

params.sendmoney

object[]

Details for the send money payment method.

params.paybill

object[]

Details for the pay bill payment method.

params.tillnumber

object[]

Details for the till number payment method.

params.pesalink

object[]

Details for the pesalink payment method.

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 created through our app.

Example:

"John.co"

timestamp

integer

required

Timestamp of the request.

Example:

1709363033

signature

string

required

Signature for verifying the request.

Example:

"2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"

Response

200

application/json

Payment process initiated successfully.

success

boolean

Example:

"true"

message

string

Example:

"Payment process initiated successfully."

data

object

Example:

""

res

object

Example:

""

Get Payment Links Get Account Balance

curl --request POST \
  --url https://dev.users.niobi.co/api/v3/niobi-unified-payments \
  --header 'Content-Type: application/json' \
  --data '{
  "client_id": "K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr",
  "params": {
    "amount": 1000,
    "customer_identifier": 1234,
    "currency": "KES",
    "payment_reference": "TRANS-123456789",
    "first_name": "John",
    "last_name": "Doe",
    "mobile": "254123456789",
    "email": "john@doe.com",
    "country_id": "1",
    "city": "Nairobi",
    "postal_code": "001001",
    "line1": "abc, xyz",
    "description": "abc, xyz",
    "client_callback_url": "https://your-domain.com/niobi/result",
    "third_party_reference_1": "<string>",
    "third_party_reference_2": "<string>",
    "payment_method_type": "send money",
    "mtn": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Orange": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Vodacom": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Airtel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "at": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Vodafone": [
      {
        "phone_number": "254123456789"
      }
    ],
    "tnm": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Zamtel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Halotel": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Tigo": [
      {
        "phone_number": "254123456789"
      }
    ],
    "Free": [
      {
        "phone_number": "254123456789"
      }
    ],
    "sendmoney": [
      {
        "phone_number": "254123456789"
      }
    ],
    "paybill": [
      {
        "paybill_number": "123456",
        "account_number": "123456789"
      }
    ],
    "tillnumber": [
      {
        "till_number": "123456"
      }
    ],
    "pesalink": [
      {
        "bank_name": "ABC",
        "bank_code": "00",
        "branch_name": "ABC",
        "account_name": "ABC",
        "account_number": "123456789"
      }
    ]
  },
  "salt": "justrandomstring",
  "sender": "John.co",
  "timestamp": 1709363033,
  "signature": "2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"
}'

{
  "success": "true",
  "message": "Payment process initiated successfully.",
  "data": "",
  "res": ""
}

Niobi Payments API

Authentication

Collections

Disbursements

Account Balance

Transaction Status

Submit Niobi Unified Payments

List of Supported Countries

List of Supported Kenyan Banks

Body

Response

Niobi Payments API

Authentication

Collections

Disbursements

Account Balance

Transaction Status

​List of Supported Countries

​List of Supported Kenyan Banks

Body

Response

List of Supported Countries

List of Supported Kenyan Banks