POST
/
api
/
v3
/
niobi-unified-collections
curl --request POST \
  --url https://dev.users.niobi.co/api/v3/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>"
  }
}'
{
  "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 IdCountryCountry CodeCurrencyPayment Method typeRequired Fields
1Kenya254KESsend moneycountry_id, currency
2Benin229XOFmtn, MOOVcountry_id, currencyNot Supported
3Cote D’Ivoire225XOFmtn, Orangecountry_id, currencyNot Supported
4Cameroon237XAFmtn, Orangecountry_id, currencyNot Supported
8Rwanda250RWFmtn, Airtelcountry_id, currencyNot Supported
9Senegal221XOFOrange, Freecountry_id, currencyNot Supported
10Tanzania255TZSAirtel, Halotel, Tigo, Vodacomcountry_id, currency2 dp - (Airtel)
11Uganda256UGXmtn, Airtelcountry_id, currency2 dp - (MTN)
12Zambia260ZMWZamtel, mtncountry_id, currency2 dp
13Sierra Leone232SLEOrangecountry_id, currency2 dp

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

Response

200
application/json
Success
​
success
boolean
Example:

true

​
message
string
Example:

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

​
data
object