Skip to main content
POST
/
api
/
v4
/
niobi-unified-payments
Niobi unified payment version-3
curl --request POST \
  --url https://dev.users.niobi.co/api/v4/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>",
    "is_third_party_reference_1_unique": true,
    "is_third_party_reference_2_unique": true,
    "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, Free, Wavecountry_id, currency
10Tanzania255TZSAirtel, Halotel, Tigocountry_id, currency
11Uganda256UGXmtn, Airtelcountry_id, currency
12Zambia260ZMWZamtel, mtn, Airtelcountry_id, currency
13Sierra Leone232SLEOrangecountry_id, currency
16Ghana233GHSmtn, AT, Vodafonecountry_id, currency
17Nigeria234NGNbankcountry_id, currency

​
List of Supported Kenyan Banks

bank_nameniobi_bank_code
Kenya Commercial Bank1
Standard Chartered2
Absa Bank Kenya3
Ncba Bank Kenya7
Prime Bank10
Cooperative Bank11
National Bank of Kenya12
Citibank N.A Kenya16
Middle East Bank Kenya18
Bank of Africa Kenya19
Credit Bank Limited25
CFC Stanbic Kenya31
Paramount Bank50
Jamii Bora Bank51
Guaranty Trust Bank53
Guardian Bank55
I&M Bank57
Diamond Trust Bank63
Sidian Bank66
Equity Bank Kenya68
Family Bank Limited70
Gulf African Bank72
First Community Bank74
Kenya Women’s Finance Trust78

​
List of Supported Nigerian Banks

bank_namebank_code
AL-Barakah Microfinance Bank090133
9 Payment Service Bank120001
AB Microfinance Bank090270
Abbey Mortgage Bank070010
Above Only Microfinance Bank090260
ABU Microfinance Bank090197
Access Bank Nigeria044
Access Bank Plc (Diamond)063
ACCESS MOBILE323
Access Money927
Access Yello & Beta100052
Accion Microfinance Bank090134
Addosser Microfinance Bank090160
Adeyemi College Staff Microfinance Bank090268
AG Mortgage Bank100028
Al-Hayat Microfinance Bank090277
Alekun Microfinance Bank090259
Alert MFB090297
Allworkers Microfinance Bank090131
Alpha Kapital Microfinance Bank090169
AMJU Unique Microfinance Bank090180
AMML Micro-finance Bank914
Apeks Microfinance Bank090143
Arise MFB MFB090282
Aso Savings and Loans401
Astrapolaris Microfinance Bank090172
Auchi Microfinance Bank090264
Baines Credit Microfinance Bank090188
Balogun Gambari MFB090326
Bayero MICROFINANCE BANK090316
BC Kash Microfinance Bank090127
BIPC MICROFINANCE BANK090336
BOCTrust Micro-finance Bank952
Bosak Microfinance Bank090176
Bowen Microfinance Bank090148
Brent Mortgage Bank070015
BRETHREN MICROFINANCE BANK090293
BRIDGEWAY MICROFINANCE BANK090393
Brightway MFB090308
Cellulant919
CEMCS Microfinance Bank090154
Chams Mobile929
Chikum Microfinance Bank090141
CIT Microfinance Bank090144
Citi Bank023
Consumer Microfinance Bank090130
Contec Global Infotech Limited (NowNow)100032
Coronation Merchant Bank559
Covenant Micro-finance Bank949
Credit Afrique Microfinance Bank090159
Daylight Microfinance Bank090167
e-Barcs Microfinance Bank090156
Eagle Flight MFB090294
Eartholeum935
Ecobank050
EcoBank Express Account922
Ecobank Mobile307
Edfin MFB090310
Ekondo MFB090097
Emeralds Microfinance Bank090273
Empire Trust Micro-finance Bank913
Enterprise Bank084
Esan Microfinance Bank090189
Eso-E Microfinance Bank090166
eTRANZACT920
Evangel MFB090304
Evergreen MICROFINANCE BANK090332
Eyowo MFB090328
FAST Microfinance Bank090179
FBN MOBILE309
FBN Mortgages Limited090107
FBNQuest Merchant Bank911
FCMB Easy Account100031
FCMB Plc214
FCT MFB090290
FEDERAL UNIVERSITY DUTSE MICROFINANCE BANK090318
FederalPoly NasarawaMFB090298
FETS915
FFS Microfinance Bank090153
Fidelity Bank070
Fidelity Mobile933
Fidfund Microfinance Bank090126
FINATRUST MICROFINANCE BANK090111
Firmus MFB090366
First Bank of Nigeria011
First Generation Mortgage Bank070014
First Multiple MFB090163
First Option MFB090285
First Royal Microfinance Bank090164
First Trust Mortgage Bank Plc910
FirstMonie Wallet928
Flutterwave Technology Solutions Limited110002
Fortis Micro-finance Bank948
Fortis Mobile930
FSDH Merchant Bank601
Fullrange Microfinance Bank090145
Futo Microfinance Bank090158
Gashua Microfinance Bank090168
Gateway Mortgage Bank070009
Globus Bank103
Glory MFB090278
GoMoney100022
GOODNEWS MICROFINANCE BANK090495
Gowans Microfinance Bank090122
GreenBank Microfinance Bank090178
Greenville Microfinance Bank090269
Greenwich Merchant Bank060004
Grooming Microfinance Bank090195
GT MOBILE923
GTBank Mobile Money315
GTBank Plc058
Hackman Microfinance Bank090147
Haggai Mortgage Bank Limited070017
Hala MFB090291
Hasal Micro-finance Bank958
Hedonmark931
Heritage Bank030
IBILE Microfinance Bank090118
IKENNE MFB090324
Ikire MFB090279
Imo State Microfinance Bank090258
Imperial Homes Mortgage Bank938
Infinity Microfinance Bank090157
Infinity Trust Mortgage Bank070016
Innovectives Kesh100029
Intellfin941
IRL Microfinance Bank090149
JAIZ Bank301
Jubliee Life906
Kadick Integration Limited110008
Kadpoly MICROFINANCE BANK090320
KCMB Microfinance Bank090191
Kegow100015
Keystone Bank082
Kontagora MFB090299
Kuda Micro-finance Bank50211
La Fayette Microfinance Bank090155
Lagos Building Investment Company070012
Lapo Microfinance Bank090177
Lavender Microfinance Bank090271
Letshego MFB090420
Lovonus Microfinance Bank090265
M36100035
Mainland MICROFINANCE BANK090323
Mainstreet Micro-finance Bank014
Malachy Microfinance Bank090174
Manny Microfinance bank090383
MAUTECH Microfinance Bank090423
Mayfair MFB090321
MayFresh Mortgage Bank070019
Megapraise Microfinance Bank090280
Meridian MFB090275
Microcred Microfinance Bank090136
Midland Microfinance Bank090192
Mint-Finex Micro-finance Bank50304
Mkudi100011
Money Trust Micro-finance Bank963
MoneyBox934
Mutual Benefits Microfinance Bank090190
Mutual Trust Microfinance Bank090151
Nagarta Microfinance Bank090152
Navy Microfinance Bank090263
Ndiorah Microfinance Bank090128
New Dawn Microfinance Bank090205
New Prudential Bank090108
NIP Virtual Bank999999
NIRSAL Microfinance Bank090194
Nnew women MFB090283
Nova Merchant Bank637
NPF Micro-finance Bank947
Oche MFB090333
Ohafia Microfinance Bank090119
Okpoga Microfinance Bank090161
Olabisi Onabanjo University Microfinance Bank090272
Omiye MFB090295
Omoluabi Mortgage Bank Plc950
One Finance940
PAGA916
Page Micro-finance Bank951
PALMPAY100033
PARALLEX BANK526
Parkway311
ParkWay-ReadyCash917
Parralex Microfinance bank090004
PatrickGold Microfinance Bank090317
PayAttitude Online943
PAYCOM305
PecanTrust Microfinance Bank090137
Pennywise Microfinance Bank090196
Personal Trust Microfinance Bank090135
Petra Microfinance Bank090165
Pillar MFB090289
Platinum Mortgage Bank070013
Polaris Bank076
Polyuwanna MFB090296
Prestige Microfinance bank090274
Providus Bank101
Purplemoney MFB090303
Quickfund Microfinance Bank090261
Rahama MFB090170
Rand Merchant Bank502
Refuge Mortgage Bank070011
Regent Micro-finance Bank955
Reliance Microfinance Bank090173
RenMoney Microfinance Bank090198
Rephidim MICROFINANCE BANK090322
Richway Microfinance Bank090132
Royal Exchange Microfinance Bank090138
Rubies Micro-finance Bank125
Safe Haven MFB090286
SafeTrust909
Sagamu Micro-finance Bank966
Seed Capital Micro-finance Bank609
Sparkle090325
Stanbic IBTC @ease Wallet921
Stanbic IBTC Bank221
Stanbic Mobile304
Standard Chartered Bank068
Stanford Microfinance Bak090162
Stellas Microfinance Bank090262
Sterling Bank232
Sterling Mobile936
Sulsap MFB090305
Suntrust Bank Nigeria Limited100
TAGPAY937
Taj Bank302
TCF Micro-finance Bank567
Teasy MOBILE924
Titan Trust Bank102
Trident Microfinance Bank090146
Trust MFB090327
Trustbond Mortgage Bank090005
Trustfund Microfinance Bank090276
U AND C MFB090315
UNAAB MFB090331
Uniben Microfinance Bank090266
Unical Microfinance Bank090193
Union Bank032
United Bank for Africa033
Unity Bank215
UNN MFB090251
Verite Microfinance Bank090123
VFD Micro-finance Bank566
Virtue Microfinance Bank090150
Visa Microfinance Bank090139
VT Networks926
Wema Bank035
WetLand Micro-finance Bank954
Xslnce Microfinance Bank090124
Yes Microfinance Bank090142
Zenith Bank Plc057
ZENITH Mobile322
ZINTERNET - KONGAPAY939

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:

""