Skip to main content
POST
/
api
/
v3
/
deposit
/
mobile-money
Deposit via mobile money
curl --request POST \
  --url https://preview.kotanipay.com/api/v3/deposit/mobile-money \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_key": "customer-key-123",
  "amount": 10,
  "wallet_id": "5f9b2c7b9c9d6b0017b4e6b1",
  "callback_url": "https://example.com",
  "customer_redirect_url": "https://example.com/success",
  "reference_id": "5f9b2c7b9c9d6b0017b4e6b1",
  "currency": "USD"
}
'
{
  "success": true,
  "message": "Deposit has been successfully created.",
  "data": {
    "id": "<string>",
    "message": "<string>",
    "reference_id": "<string>",
    "reference_number": 123,
    "customer_key": "<string>",
    "redirect_url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://manual.kotanipay.com/llms.txt

Use this file to discover all available pages before exploring further.

An integrator’s customers can initiate a deposit from their respective mobile money wallets. An STK push will be sent to the customer and the respective amount will be deducted from their mobile money wallets and deposited into the integrator’s fiat wallet.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
customer_key
string
required

Customer key

Example:

"customer-key-123"

​
amount
number
required

amount to deposit

Example:

10

​
wallet_id
string
required

deposit id

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

​
callback_url
string

callback url

Example:

"https://example.com"

​
customer_redirect_url
string

customer redirect url

Example:

"https://example.com/success"

​
reference_id
string

reference id

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

​
currency
string

Override transaction currency (e.g. USD for USD mobile money in Congo/Zambia). When provided and matches the wallet currency, phone-country currency validation is skipped.

Example:

"USD"

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Deposit has been successfully created."

​
data
object