Niobi Unified Payment v2

curl --request POST \
  --url https://dev.users.niobi.co/api/v2/niobi-payment \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr",
  "params": {
    "amount": 1000,
    "currency": "KES",
    "payment_reference": "TRANS-123456789",
    "first_name": "John",
    "last_name": "Doe",
    "mobile": "254123456789",
    "email": "[email protected]",
    "country": "KE",
    "city": "Nairobi",
    "postal_code": "001001",
    "line1": "abc, xyz",
    "client_callback_url": "https://your-domain.com/niobi/result",
    "payment_method_type": "send money",
    "customer_identifier": 1234,
    "description": "abc, xyz",
    "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": "waqassharif00494",
  "sender": "ApexVim",
  "timestamp": 1709363033,
  "signature": "2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"
}
'

POST

api

niobi-payment

curl --request POST \
  --url https://dev.users.niobi.co/api/v2/niobi-payment \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr",
  "params": {
    "amount": 1000,
    "currency": "KES",
    "payment_reference": "TRANS-123456789",
    "first_name": "John",
    "last_name": "Doe",
    "mobile": "254123456789",
    "email": "[email protected]",
    "country": "KE",
    "city": "Nairobi",
    "postal_code": "001001",
    "line1": "abc, xyz",
    "client_callback_url": "https://your-domain.com/niobi/result",
    "payment_method_type": "send money",
    "customer_identifier": 1234,
    "description": "abc, xyz",
    "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": "waqassharif00494",
  "sender": "ApexVim",
  "timestamp": 1709363033,
  "signature": "2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"
}
'

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

Show child attributes

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:

"[email protected]"

params.country

string

required

Country of the payee.

Example:

"KE"

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.MTN

object[]

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

Show child attributes

params.MTN.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Orange

object[]

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

Show child attributes

params.Orange.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Vodacom

object[]

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

Show child attributes

params.Vodacom.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Airtel

object[]

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

Show child attributes

params.Airtel.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.AT

object[]

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

Show child attributes

params.AT.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Vodafone

object[]

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

Show child attributes

params.Vodafone.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.TNM

object[]

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

Show child attributes

params.TNM.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Zamtel

object[]

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

Show child attributes

params.Zamtel.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Halotel

object[]

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

Show child attributes

params.Halotel.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Tigo

object[]

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

Show child attributes

params.Tigo.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.Free

object[]

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

Show child attributes

params.Free.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.sendmoney

object[]

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

Show child attributes

params.sendmoney.phone_number

string

required

Enter the recipient's mobile number. Be sure to use the right fomatting

Example:

"254123456789"

params.paybill

object[]

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

Show child attributes

params.paybill.paybill_number

string<paybill_number>

required

paybill number

Example:

"123456"

params.paybill.account_number

string<account_number>

required

Niobi account number

Example:

"123456789"

params.tillnumber

object[]

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

Show child attributes

params.tillnumber.till_number

string<till_number>

required

Till number

Example:

"123456"

params.pesalink

object[]

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

Show child attributes

params.pesalink.bank_name

string<bank_name>

required

your respective bank name

Example:

"ABC"

params.pesalink.bank_code

string<bank_code>

required

your respective bank code

Example:

"00"

params.pesalink.branch_name

string<branch_name>

required

your respective branch name

Example:

"ABC"

params.pesalink.account_name

string<account_name>

required

your respective account name

Example:

"ABC"

params.pesalink.account_number

string<account_number>

This is the account number associated with the recipient that will receive the payout

Example:

"123456789"

salt

string

required

Salt for security.

Example:

"waqassharif00494"

sender

string

required

Identifier of the sender.

Example:

"ApexVim"

timestamp

integer

required

Timestamp of the request.

Example:

1709363033

signature

string

required

Signature for verifying the request.

Example:

"2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807"

Response

Ok.

Submit M-Pesa STK Push Get Account Balance

⌘I

API Documentation

Authentication

Accept Payments

Make Payments

Account Balance

Niobi Unified Payment v2

Body

Response