Skip to main content
POST
/
api
/
v3
/
deposit
/
mobile-money
Deposit via mobile money
curl --request POST \
  --url https://sandbox-api.kotanipay.io/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",
  "reference_id": "5f9b2c7b9c9d6b0017b4e6b1",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "errorUrl": "https://example.com/error",
  "customer_redirect_url": "https://example.com/success"
}
'
{
  "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>"
  }
}
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"

​
reference_id
string

reference id

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

​
successUrl
string

success redirect url where customer is redirected after successful payment

Example:

"https://example.com/success"

​
cancelUrl
string

cancel redirect url where customer is redirected if payment is cancelled

Example:

"https://example.com/cancel"

​
errorUrl
string

error redirect url where customer is redirected on payment error

Example:

"https://example.com/error"

​
customer_redirect_url
string

customer redirect url

Example:

"https://example.com/success"

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Deposit has been successfully created."

​
data
object