Skip to main content
POST
/
api
/
v3
/
niobi-unified-payments
Niobi unified payment version-3
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 IdCountryCountry CodeCurrencyPayment Method typeRequired Fields
1Kenya254KEStill number, pay bill, pesalink, send moneycountry_id, currency
2Benin229XOFmtn, Moovcountry_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, mtn, Airtelcountry_id, currency
13Sierra Leone232SLEOrangecountry_id, currency

​
List of Supported Kenyan Banks

idbank_nameniobi_bank_code
1Kenya Commercial Bank1
2Standard Chartered2
3Absa Bank Kenya3
4Ncba Bank Kenya7
5Prime Bank10
6Cooperative Bank11
7National Bank of Kenya12
8Citibank N.A Kenya16
9Middle East Bank Kenya18
10Bank of Africa Kenya19
11Credit Bank Limited25
12CFC Stanbic Kenya31
13Paramount Bank50
14Jamii Bora Bank51
15Guaranty Trust Bank53
16Guardian Bank55
17I&M Bank57
18Diamond Trust Bank63
19Sidian Bank66
20Equity Bank Kenya68
21Family Bank Limited70
22Gulf African Bank72
23First Community Bank74
24Kenya Women’s Finance Trust78

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
​
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

Payment process initiated successfully.

​
success
boolean
Example:

"true"

​
message
string
Example:

"Payment process initiated successfully."

​
data
object
Example:

""

​
res
object
Example:

""