> ## Documentation Index
> Fetch the complete documentation index at: https://docs.niobi.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Submit Niobi Unified Payments
> Handles payment processing for Niobi, supporting multiple payment methods.
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 |
| 5 | DRC | 243 | CDF | Airtel, Orange, Vodacom | country\_id, currency |
| 8 | Rwanda | 250 | RWF | mtn, Airtel | country\_id, currency |
| 9 | Senegal | 221 | XOF | Orange, Free, Wave | 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 |
| 15 | South Africa | 27 | ZAR | bank | country\_id, currency |
| 16 | Ghana | 233 | GHS | mtn, AT, Vodafone | country\_id, currency |
| 17 | Nigeria | 234 | NGN | bank | country\_id, currency |
### List of Supported Kenyan Banks
| bank\_name | niobi\_bank\_code |
| --------------------------- | ----------------- |
| Kenya Commercial Bank | 1 |
| Standard Chartered | 2 |
| Absa Bank Kenya | 3 |
| Ncba Bank Kenya | 7 |
| Prime Bank | 10 |
| Cooperative Bank | 11 |
| National Bank of Kenya | 12 |
| Citibank N.A Kenya | 16 |
| Middle East Bank Kenya | 18 |
| Bank of Africa Kenya | 19 |
| Credit Bank Limited | 25 |
| CFC Stanbic Kenya | 31 |
| Paramount Bank | 50 |
| Jamii Bora Bank | 51 |
| Guaranty Trust Bank | 53 |
| Guardian Bank | 55 |
| I\&M Bank | 57 |
| Diamond Trust Bank | 63 |
| Sidian Bank | 66 |
| Equity Bank Kenya | 68 |
| Family Bank Limited | 70 |
| Gulf African Bank | 72 |
| First Community Bank | 74 |
| Kenya Women's Finance Trust | 78 |
### List of Supported Nigerian Banks
| bank\_name | bank\_code |
| --------------------------------------------- | ---------- |
| AL-Barakah Microfinance Bank | 090133 |
| 9 Payment Service Bank | 120001 |
| AB Microfinance Bank | 090270 |
| Abbey Mortgage Bank | 070010 |
| Above Only Microfinance Bank | 090260 |
| ABU Microfinance Bank | 090197 |
| Access Bank Nigeria | 044 |
| Access Bank Plc (Diamond) | 063 |
| ACCESS MOBILE | 323 |
| Access Money | 927 |
| Access Yello & Beta | 100052 |
| Accion Microfinance Bank | 090134 |
| Addosser Microfinance Bank | 090160 |
| Adeyemi College Staff Microfinance Bank | 090268 |
| AG Mortgage Bank | 100028 |
| Al-Hayat Microfinance Bank | 090277 |
| Alekun Microfinance Bank | 090259 |
| Alert MFB | 090297 |
| Allworkers Microfinance Bank | 090131 |
| Alpha Kapital Microfinance Bank | 090169 |
| AMJU Unique Microfinance Bank | 090180 |
| AMML Micro-finance Bank | 914 |
| Apeks Microfinance Bank | 090143 |
| Arise MFB MFB | 090282 |
| Aso Savings and Loans | 401 |
| Astrapolaris Microfinance Bank | 090172 |
| Auchi Microfinance Bank | 090264 |
| Baines Credit Microfinance Bank | 090188 |
| Balogun Gambari MFB | 090326 |
| Bayero MICROFINANCE BANK | 090316 |
| BC Kash Microfinance Bank | 090127 |
| BIPC MICROFINANCE BANK | 090336 |
| BOCTrust Micro-finance Bank | 952 |
| Bosak Microfinance Bank | 090176 |
| Bowen Microfinance Bank | 090148 |
| Brent Mortgage Bank | 070015 |
| BRETHREN MICROFINANCE BANK | 090293 |
| BRIDGEWAY MICROFINANCE BANK | 090393 |
| Brightway MFB | 090308 |
| Cellulant | 919 |
| CEMCS Microfinance Bank | 090154 |
| Chams Mobile | 929 |
| Chikum Microfinance Bank | 090141 |
| CIT Microfinance Bank | 090144 |
| Citi Bank | 023 |
| Consumer Microfinance Bank | 090130 |
| Contec Global Infotech Limited (NowNow) | 100032 |
| Coronation Merchant Bank | 559 |
| Covenant Micro-finance Bank | 949 |
| Credit Afrique Microfinance Bank | 090159 |
| Daylight Microfinance Bank | 090167 |
| e-Barcs Microfinance Bank | 090156 |
| Eagle Flight MFB | 090294 |
| Eartholeum | 935 |
| Ecobank | 050 |
| EcoBank Express Account | 922 |
| Ecobank Mobile | 307 |
| Edfin MFB | 090310 |
| Ekondo MFB | 090097 |
| Emeralds Microfinance Bank | 090273 |
| Empire Trust Micro-finance Bank | 913 |
| Enterprise Bank | 084 |
| Esan Microfinance Bank | 090189 |
| Eso-E Microfinance Bank | 090166 |
| eTRANZACT | 920 |
| Evangel MFB | 090304 |
| Evergreen MICROFINANCE BANK | 090332 |
| Eyowo MFB | 090328 |
| FAST Microfinance Bank | 090179 |
| FBN MOBILE | 309 |
| FBN Mortgages Limited | 090107 |
| FBNQuest Merchant Bank | 911 |
| FCMB Easy Account | 100031 |
| FCMB Plc | 214 |
| FCT MFB | 090290 |
| FEDERAL UNIVERSITY DUTSE MICROFINANCE BANK | 090318 |
| FederalPoly NasarawaMFB | 090298 |
| FETS | 915 |
| FFS Microfinance Bank | 090153 |
| Fidelity Bank | 070 |
| Fidelity Mobile | 933 |
| Fidfund Microfinance Bank | 090126 |
| FINATRUST MICROFINANCE BANK | 090111 |
| Firmus MFB | 090366 |
| First Bank of Nigeria | 011 |
| First Generation Mortgage Bank | 070014 |
| First Multiple MFB | 090163 |
| First Option MFB | 090285 |
| First Royal Microfinance Bank | 090164 |
| First Trust Mortgage Bank Plc | 910 |
| FirstMonie Wallet | 928 |
| Flutterwave Technology Solutions Limited | 110002 |
| Fortis Micro-finance Bank | 948 |
| Fortis Mobile | 930 |
| FSDH Merchant Bank | 601 |
| Fullrange Microfinance Bank | 090145 |
| Futo Microfinance Bank | 090158 |
| Gashua Microfinance Bank | 090168 |
| Gateway Mortgage Bank | 070009 |
| Globus Bank | 103 |
| Glory MFB | 090278 |
| GoMoney | 100022 |
| GOODNEWS MICROFINANCE BANK | 090495 |
| Gowans Microfinance Bank | 090122 |
| GreenBank Microfinance Bank | 090178 |
| Greenville Microfinance Bank | 090269 |
| Greenwich Merchant Bank | 060004 |
| Grooming Microfinance Bank | 090195 |
| GT MOBILE | 923 |
| GTBank Mobile Money | 315 |
| GTBank Plc | 058 |
| Hackman Microfinance Bank | 090147 |
| Haggai Mortgage Bank Limited | 070017 |
| Hala MFB | 090291 |
| Hasal Micro-finance Bank | 958 |
| Hedonmark | 931 |
| Heritage Bank | 030 |
| IBILE Microfinance Bank | 090118 |
| IKENNE MFB | 090324 |
| Ikire MFB | 090279 |
| Imo State Microfinance Bank | 090258 |
| Imperial Homes Mortgage Bank | 938 |
| Infinity Microfinance Bank | 090157 |
| Infinity Trust Mortgage Bank | 070016 |
| Innovectives Kesh | 100029 |
| Intellfin | 941 |
| IRL Microfinance Bank | 090149 |
| JAIZ Bank | 301 |
| Jubliee Life | 906 |
| Kadick Integration Limited | 110008 |
| Kadpoly MICROFINANCE BANK | 090320 |
| KCMB Microfinance Bank | 090191 |
| Kegow | 100015 |
| Keystone Bank | 082 |
| Kontagora MFB | 090299 |
| Kuda Micro-finance Bank | 50211 |
| La Fayette Microfinance Bank | 090155 |
| Lagos Building Investment Company | 070012 |
| Lapo Microfinance Bank | 090177 |
| Lavender Microfinance Bank | 090271 |
| Letshego MFB | 090420 |
| Lovonus Microfinance Bank | 090265 |
| M36 | 100035 |
| Mainland MICROFINANCE BANK | 090323 |
| Mainstreet Micro-finance Bank | 014 |
| Malachy Microfinance Bank | 090174 |
| Manny Microfinance bank | 090383 |
| MAUTECH Microfinance Bank | 090423 |
| Mayfair MFB | 090321 |
| MayFresh Mortgage Bank | 070019 |
| Megapraise Microfinance Bank | 090280 |
| Meridian MFB | 090275 |
| Microcred Microfinance Bank | 090136 |
| Midland Microfinance Bank | 090192 |
| Mint-Finex Micro-finance Bank | 50304 |
| Mkudi | 100011 |
| Money Trust Micro-finance Bank | 963 |
| MoneyBox | 934 |
| Mutual Benefits Microfinance Bank | 090190 |
| Mutual Trust Microfinance Bank | 090151 |
| Nagarta Microfinance Bank | 090152 |
| Navy Microfinance Bank | 090263 |
| Ndiorah Microfinance Bank | 090128 |
| New Dawn Microfinance Bank | 090205 |
| New Prudential Bank | 090108 |
| NIP Virtual Bank | 999999 |
| NIRSAL Microfinance Bank | 090194 |
| Nnew women MFB | 090283 |
| Nova Merchant Bank | 637 |
| NPF Micro-finance Bank | 947 |
| Oche MFB | 090333 |
| Ohafia Microfinance Bank | 090119 |
| Okpoga Microfinance Bank | 090161 |
| Olabisi Onabanjo University Microfinance Bank | 090272 |
| Omiye MFB | 090295 |
| Omoluabi Mortgage Bank Plc | 950 |
| One Finance | 940 |
| PAGA | 916 |
| Page Micro-finance Bank | 951 |
| PALMPAY | 100033 |
| PARALLEX BANK | 526 |
| Parkway | 311 |
| ParkWay-ReadyCash | 917 |
| Parralex Microfinance bank | 090004 |
| PatrickGold Microfinance Bank | 090317 |
| PayAttitude Online | 943 |
| PAYCOM | 305 |
| PecanTrust Microfinance Bank | 090137 |
| Pennywise Microfinance Bank | 090196 |
| Personal Trust Microfinance Bank | 090135 |
| Petra Microfinance Bank | 090165 |
| Pillar MFB | 090289 |
| Platinum Mortgage Bank | 070013 |
| Polaris Bank | 076 |
| Polyuwanna MFB | 090296 |
| Prestige Microfinance bank | 090274 |
| Providus Bank | 101 |
| Purplemoney MFB | 090303 |
| Quickfund Microfinance Bank | 090261 |
| Rahama MFB | 090170 |
| Rand Merchant Bank | 502 |
| Refuge Mortgage Bank | 070011 |
| Regent Micro-finance Bank | 955 |
| Reliance Microfinance Bank | 090173 |
| RenMoney Microfinance Bank | 090198 |
| Rephidim MICROFINANCE BANK | 090322 |
| Richway Microfinance Bank | 090132 |
| Royal Exchange Microfinance Bank | 090138 |
| Rubies Micro-finance Bank | 125 |
| Safe Haven MFB | 090286 |
| SafeTrust | 909 |
| Sagamu Micro-finance Bank | 966 |
| Seed Capital Micro-finance Bank | 609 |
| Sparkle | 090325 |
| Stanbic IBTC @ease Wallet | 921 |
| Stanbic IBTC Bank | 221 |
| Stanbic Mobile | 304 |
| Standard Chartered Bank | 068 |
| Stanford Microfinance Bak | 090162 |
| Stellas Microfinance Bank | 090262 |
| Sterling Bank | 232 |
| Sterling Mobile | 936 |
| Sulsap MFB | 090305 |
| Suntrust Bank Nigeria Limited | 100 |
| TAGPAY | 937 |
| Taj Bank | 302 |
| TCF Micro-finance Bank | 567 |
| Teasy MOBILE | 924 |
| Titan Trust Bank | 102 |
| Trident Microfinance Bank | 090146 |
| Trust MFB | 090327 |
| Trustbond Mortgage Bank | 090005 |
| Trustfund Microfinance Bank | 090276 |
| U AND C MFB | 090315 |
| UNAAB MFB | 090331 |
| Uniben Microfinance Bank | 090266 |
| Unical Microfinance Bank | 090193 |
| Union Bank | 032 |
| United Bank for Africa | 033 |
| Unity Bank | 215 |
| UNN MFB | 090251 |
| Verite Microfinance Bank | 090123 |
| VFD Micro-finance Bank | 566 |
| Virtue Microfinance Bank | 090150 |
| Visa Microfinance Bank | 090139 |
| VT Networks | 926 |
| Wema Bank | 035 |
| WetLand Micro-finance Bank | 954 |
| Xslnce Microfinance Bank | 090124 |
| Yes Microfinance Bank | 090142 |
| Zenith Bank Plc | 057 |
| ZENITH Mobile | 322 |
| ZINTERNET - KONGAPAY | 939 |
## OpenAPI
````yaml post /api/v4/niobi-unified-payments
openapi: 3.0.0
info:
title: Niobi Application API
description: Niobi List API
version: 1.0.0
servers:
- url: https://sandbox.users.niobi.co
description: Live API Server
security: []
tags:
- name: Niobi
description: API Endpoints of Niobi
paths:
/api/v4/niobi-unified-payments:
post:
tags:
- payment
summary: Niobi unified payment version-3
description: >-
Handles payment processing for Niobi, supporting multiple payment
methods.
operationId: V3NiobiUnifiedPayments
requestBody:
description: Payload required for initiating a Niobi payment transaction.
required: true
content:
application/json:
schema:
required:
- client_id
- params
- salt
- sender
- timestamp
- signature
properties:
client_id:
description: >-
The Client id is your public key which is generated when you
are creating a new API integration from our app.
type: string
example: K1PoY1WYricSpXh6Wm24twnk6ecPJOWrHGsqiKJr
params:
required:
- amount
- currency
- payment_reference
- first_name
- last_name
- mobile
- email
- country_id
- city
- postal_code
- line1
- client_callback_url
- payment_method_type
properties:
amount:
description: >-
The amount to be transferred. Please note that this
value should be in absolute form. e.g. 1000 KES should
be passed as 1000.
type: integer
example: 1000
customer_identifier:
description: Customer identifier for sub-wallet.
type: integer
example: 1234
currency:
description: Currency of the transaction.
type: string
example: KES
payment_reference:
description: >-
Any information you can use to reference this
transaction later.
type: string
example: TRANS-123456789
first_name:
description: First name of the payee.
type: string
example: John
last_name:
description: Last name of the payee.
type: string
example: Doe
mobile:
description: Mobile number of the payee.
type: string
example: '254123456789'
email:
description: Email of the payee.
type: string
example: john@doe.com
country_id:
description: Country Id can be used from above table.
type: integer
example: '1'
city:
description: City of the payee.
type: string
example: Nairobi
postal_code:
description: Postal code of the payee.
type: string
example: '001001'
line1:
description: Street address of the payee.
type: string
example: abc, xyz
description:
description: >-
This is the description or message from payer who is
paying out
type: string
example: abc, xyz
client_callback_url:
description: Callback URL for payment confirmation response.
type: string
example: https://your-domain.com/niobi/result
third_party_reference_1:
description: customer internal transaction reference
type: string
format: string
third_party_reference_2:
description: customer external transaction reference
type: string
format: string
is_third_party_reference_1_unique:
description: >-
External reference check to prevent processing of
duplicate payouts with the same third party reference 1
field(Optional)
type: boolean
format: boolean
is_third_party_reference_2_unique:
description: >-
External reference check to prevent processing of
duplicate payouts with the same third party reference 2
field(Optional)
type: boolean
format: boolean
payment_method_type:
description: Preferred payment method.
type: string
enum:
- mtn
- Orange
- Vodacom
- Airtel
- at
- Vodafone
- tnm
- Zamtel
- Halotel
- Tigo
- Free
- send money
- till number
- pay bill
- pesalink
example: send money
mtn:
description: >-
Using mtn method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Orange:
description: >-
Using Orange method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Vodacom:
description: >-
Using Vodacom method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Airtel:
description: >-
Using Airtel method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
at:
description: >-
Using at method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Vodafone:
description: >-
Using Vodafone method needs a recipient's phone number
of payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
tnm:
description: >-
Using tnm method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Zamtel:
description: >-
Using Zamtel method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Halotel:
description: >-
Using Halotel method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Tigo:
description: >-
Using Tigo method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
Free:
description: >-
Using Free method needs a recipient's phone number of
payment method
type: array
items:
required:
- phone_number
properties:
phone_number:
description: >-
Enter the recipient's mobile number. Be sure to
use the right fomatting
type: string
format: phone_number
example: '254123456789'
type: object
sendmoney:
description: Details for the send money payment method.
type: array
items:
required:
- phone_number
properties:
phone_number:
description: Recipient's mobile number for send money method.
type: string
example: '254123456789'
type: object
paybill:
description: Details for the pay bill payment method.
type: array
items:
required:
- paybill_number
- account_number
properties:
paybill_number:
description: Paybill number for the transaction.
type: string
example: '123456'
account_number:
description: Account number for the transaction.
type: string
example: '123456789'
type: object
tillnumber:
description: Details for the till number payment method.
type: array
items:
required:
- till_number
properties:
till_number:
description: Till number for the transaction.
type: string
example: '123456'
type: object
pesalink:
description: Details for the pesalink payment method.
type: array
items:
required:
- bank_name
- bank_code
- branch_name
- account_name
- account_number
properties:
bank_name:
description: Bank name for the pesalink transfer.
type: string
example: ABC
bank_code:
description: Bank code for the pesalink transfer.
type: string
example: '00'
branch_name:
description: Branch name for the pesalink transfer.
type: string
example: ABC
account_name:
description: Account name for the pesalink transfer.
type: string
example: ABC
account_number:
description: Account number for the pesalink transfer.
type: string
example: '123456789'
type: object
type: object
salt:
description: >-
Salt is used for security purposes. This is a random string
and can be unique value for each request or always the same.
type: string
example: justrandomstring
sender:
description: >-
The Sender is the title of the API Integration created
through our app.
type: string
example: John.co
timestamp:
description: Timestamp of the request.
type: integer
example: 1709363033
signature:
description: Signature for verifying the request.
type: string
example: >-
2193d01d50d4bd5da234ac0e0add5d4ccb40907a1b1ab27a12d2c1d88a5d5807
type: object
responses:
'200':
description: Payment process initiated successfully.
content:
application/json:
schema:
properties:
success:
type: boolean
example: 'true'
message:
type: string
example: Payment process initiated successfully.
data:
type: object
example: ''
res:
type: object
example: ''
type: object
'400':
description: >-
Country was not found or Niobi user not found or Payment process
initiation failed.
content:
application/json:
schema:
properties:
success:
type: boolean
example: false
message:
type: string
example: >-
Country was not found or Niobi user not found or Payment
process initiation failed.
type: object
'403':
description: >-
Entity integration record not found or Client id not matched or
Request was not verified.
content:
application/json:
schema:
properties:
success:
type: boolean
example: false
message:
type: string
example: >-
Entity integration record not found or Client id not
matched or Request was not verified.
type: object
'404':
description: User not found
content:
application/json:
schema:
properties:
success:
type: boolean
example: false
message:
type: string
example: User not found.
type: object
'500':
description: Internal Server Error
````