POST
/
api
/
niobi-payment
curl --request POST \
  --url https://dev.users.niobi.co/api/niobi-payment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 10,
  "customer_identifier": 1234,
  "currency": "KES",
  "payment_reference": "123456789",
  "first_name": "John",
  "last_name": "Doe",
  "mobile": "254123456789",
  "email": "john@doe.com",
  "country": "KE",
  "city": "Nairobi",
  "postal_code": "001001",
  "line1": "abc, xyz",
  "description": "abc, xyz",
  "client_callback_url": "https://your-domain.com/niobi/result",
  "payment_method_type": "send money",
  "MTN": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Orange": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Vodacom": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Airtel": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "AT": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Vodafone": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "TNM": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Zamtel": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Halotel": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Tigo": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "Free": [
    {
      "phone_number": "254123456789",
      "correspondent": "MPESA_KEN"
    }
  ],
  "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"
    }
  ]
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Enter token in format (Bearer <token>)

Body

application/json
<h2>Supported Banks</h2><br><table><thead><th>Name</th><th>Code</th></thead><tbody><tr><td>Kenya Commercial Bank</td><td>01</td></tr><tr><td>Standard Chartered</td><td>02</td></tr><tr><td>Absa Bank Kenya</td><td>03</td></tr><tr><td>Ncba Bank Kenya</td><td>07</td></tr><tr><td>Prime Bank</td><td>10</td></tr><tr><td>Cooperative Bank</td><td>11</td></tr><tr><td>National Bank of Kenya</td><td>12</td></tr><tr><td>Citibank N.A Kenya</td><td>16</td></tr><tr><td>Middle East Bank Kenya</td><td>18</td></tr><tr><td>Bank of Africa Kenya</td><td>19</td></tr><tr><td>Credit Bank Limited</td><td>25</td></tr><tr><td>CFC Stanbic Kenya</td><td>31</td></tr><tr><td>Paramount Bank</td><td>50</td></tr><tr><td>Jamii Bora Bank</td><td>51</td></tr><tr><td>Guaranty Trust Bank</td><td>53</td></tr><tr><td>Guardian Bank</td><td>55</td></tr><tr><td>I&M Bank </td><td>57</td></tr><tr><td>Diamond Trust Bank</td><td>63</td></tr><tr><td>Sidian Bank</td><td>66</td></tr><tr><td>Equity Bank Kenya</td><td>68</td></tr><tr><td>Family Bank Limited</td><td>70</td></tr><tr><td>Gulf African Bank</td><td>72</td></tr><tr><td>First Community Bank</td><td>74</td></tr><tr><td>Kenya Women's Finance Trust</td><td>78</td></tr></tbody></table><br><br>
​
amount
integer
required

This is the Amount of money you wish to transfer. This amount shall always be less than the total value in your Balance

Example:

10

​
currency
string
required

This is the currency of the payouts you are making. At the moment, Niobi Payments supports KES transactions only

Example:

"KES"

​
first_name
string
required

This is the first name of the Payee who is being paid out

Example:

"John"

​
last_name
string
required

This is the last name of the Payee who is being paid out

Example:

"Doe"

​
mobile
string
required

This is the mobile number of the Payee who is being paid out. Use the correct formatting as described in the example

Example:

"254123456789"

​
email
string
required

This is the email of the Payee who is being paid out

Example:

"john@doe.com"

​
country
string
required

This is the country of the Payee who is being paid out

Example:

"KE"

​
city
string
required

This is the city of the Payee who is being paid out

Example:

"Nairobi"

​
postal_code
string
required

This is the postal code of the Payee who is being paid out

Example:

"001001"

​
line1
string
required

This is the street address of the Payee who is being paid out

Example:

"abc, xyz"

​
payment_method_type
enum<string>
required

This is the preferred payment method you want to use to payout the money and what makes the Niobi Payment API really unique as we support all popular mobile money and bank payments

Available options:
MTN,
Orange,
Vodacom,
Airtel,
AT,
Vodafone,
TNM,
Zamtel,
Halotel,
Tigo,
Free,
send money,
till number,
pay bill,
pesalink
Example:

"send money"

​
customer_identifier
integer

This is the Customer Identifier number for sub-wallet.

Example:

1234

​
payment_reference
string

This is the account number associated with Niobi, that holds the value from which a pyaout is being made

Example:

"123456789"

​
description
string

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

Example:

"abc, xyz"

​
client_callback_url
string

You can provide call back URL to get payment confirmation response.

Example:

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

​
MTN
object[]

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

​
Orange
object[]

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

​
Vodacom
object[]

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

​
Airtel
object[]

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

​
AT
object[]

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

​
Vodafone
object[]

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

​
TNM
object[]

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

​
Zamtel
object[]

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

​
Halotel
object[]

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

​
Tigo
object[]

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

​
Free
object[]

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

​
sendmoney
object[]

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

​
paybill
object[]

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

​
tillnumber
object[]

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

​
pesalink
object[]

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

Response

200
application/json

Ok.

The response is of type any.