Submit Niobi Unified Collections

curl --request POST \
  --url https://dev.users.niobi.co/api/v4/niobi-unified-collections \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "<string>",
  "sender": "<string>",
  "timestamp": 123,
  "salt": "<string>",
  "signature": "<string>",
  "params": {
    "amount": 123,
    "mobile": "<string>",
    "country_id": 123,
    "currency": "<string>",
    "payment_method_type": "<string>",
    "callback_url": "<string>",
    "third_party_reference_1": "<string>",
    "third_party_reference_2": "<string>",
    "name": "<string>",
    "account_name": "<string>"
  }
}
'

{
  "success": true,
  "message": "Verification token was sent to your mobile number. Kindly verify to proceed with payment.",
  "data": {}
}

POST

api

niobi-unified-collections

Submit Niobi Unified Collections

curl --request POST \
  --url https://dev.users.niobi.co/api/v4/niobi-unified-collections \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "<string>",
  "sender": "<string>",
  "timestamp": 123,
  "salt": "<string>",
  "signature": "<string>",
  "params": {
    "amount": 123,
    "mobile": "<string>",
    "country_id": 123,
    "currency": "<string>",
    "payment_method_type": "<string>",
    "callback_url": "<string>",
    "third_party_reference_1": "<string>",
    "third_party_reference_2": "<string>",
    "name": "<string>",
    "account_name": "<string>"
  }
}
'

{
  "success": true,
  "message": "Verification token was sent to your mobile number. Kindly verify to proceed with payment.",
  "data": {}
}

Please make sure to generate a new signature whenever you are creating a collection request.

List of Supported Countries

Country Id	Country	Country Code	Currency	Payment Method type	Required Fields
1	Kenya	254	KES	send money	country_id, currency
2	Benin	229	XOF	mtn, MOOV	country_id, currency	Not Supported
3	Cote D’Ivoire	225	XOF	mtn, Orange	country_id, currency	Not Supported
4	Cameroon	237	XAF	mtn, Orange	country_id, currency	Not Supported
5	DRC	243	CDF	Orange, Airtel	country_id, currency	3 dp
7	Malawi	265	MWK	Airtel, tnm	country_id, currency	2 dp
9	Senegal	221	XOF	Orange, Free, Wave	country_id, currency	Not Supported
10	Tanzania	255	TZS	Airtel, Halotel, Tigo, Vodacom	country_id, currency	2 dp - (Airtel)
11	Uganda	256	UGX	mtn, Airtel	country_id, currency	2 dp - (MTN)
12	Zambia	260	ZMW	Zamtel, mtn	country_id, currency	2 dp
13	Sierra Leone	232	SLE	Orange	country_id, currency	2 dp
16	Ghana	233	GHS	mtn, AT, Vodafone	country_id, currency
17	Nigeria	234	NGN	bank	country_id, currency, name, account_name

For Senegal Orange deposits, the end user receives an SMS with a shortcode after the deposit is initiated. They dial the shortcode, triggering a USSD prompt where they input their PIN to approve the transaction.

Body

application/json

Data needed for niobi unified collection

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.

sender

string

required

The Sender is the title of the API Integration which was created through our app. you can just copy this title and use it whenever making a new signature

timestamp

integer

required

this is the current timestamp when the request is being made

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.

signature

string

required

this is the signature which was generated after signing the request. you can copy it from the response we provide from the api/niobi-signature endpoint

params

object

required

Show child attributes

params.amount

number<float>

required

Amount to be charged

params.mobile

string

required

Mobile number to be charged

params.country_id

integer<country_id>

required

Country id to payment

params.currency

string<currency>

required

Currency in which to be charged

params.payment_method_type

string<string>

required

Use proper payment method type i.e. Airtel, Tigo, Free

params.callback_url

string<uri>

Callback URL for the payment notification

params.third_party_reference_1

string<string>

customer internal transaction reference

params.third_party_reference_2

string<string>

customer external transaction reference

params.name

string<string>

customer's name. Only required for Nigerian bank deposits

params.account_name

string<string>

customer's bank account name. Only required for NGN bank deposits

Response

Success

success

boolean

Example:

true

message

string

Example:

"Verification token was sent to your mobile number. Kindly verify to proceed with payment."

data

object

Verify Signature Create Payment Link

⌘I

Authentication

Collections

Disbursements

Account Balance

Transaction Status

Submit Niobi Unified Collections

List of Supported Countries

Body

Response

Authentication

Collections

Disbursements

Account Balance

Transaction Status

​List of Supported Countries

Body

Response

List of Supported Countries