Skip to main content
POST
/
api
/
stk-deposit
Niobi STK Deposit
curl --request POST \
  --url https://sandbox.users.niobi.co/api/stk-deposit \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "integer",
  "country_id": "integer",
  "correspondent": "MTN_MOMO_NGA",
  "currency": "string",
  "mobile": "254123456789",
  "callback_url": "string"
}
'
{
  "success": "true",
  "message": "Verification token was sent to your mobile number. Kindly verify to proceed with payment",
  "data": {
    "MerchantRequestID": "1234-123456789-1",
    "CheckoutRequestID": "ab_XY_*******************",
    "ResponseCode": "0",
    "ResponseDescription": "Success. Request accepted for processing",
    "CustomerMessage": "Success. Request accepted for processing"
  }
}

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.

Authorizations

​
Authorization
string
header
required

Enter token in format (Bearer )

Body

application/json

Deposit STK Payment.

​
amount
integer<amount>
required
Example:

"integer"

​
country_id
integer<country_id>
required
Example:

"integer"

​
correspondent
string<correspondent>
required
Example:

"MTN_MOMO_NGA"

​
currency
string<currency>
required
Example:

"string"

​
mobile
string<mobile>
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"

​
callback_url
string<callback_url>
Example:

"string"

Response

Ok.

​
success
boolean
Example:

"true"

​
message
string
Example:

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

​
data
object