Skip to main content
POST
/
api
/
v3
/
withdraw
/
mobile-money
Withdraw Fiat to Mobile Money
curl --request POST \
  --url https://sandbox-api.kotanipay.io/api/v3/withdraw/mobile-money \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_key": "customer-key-123",
  "amount": 10,
  "walletId": "5f9b2c7b9c9d6b0017b4e6b1",
  "callbackUrl": "https://example.com",
  "referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
  "currency": "USD"
}
'
{
  "success": true,
  "message": "Withdrawal has been successfully created.",
  "data": {
    "id": "<string>",
    "message": "<string>",
    "referenceId": "<string>",
    "referenceNumber": 123
  }
}
This API will withdraw fiat from the integrator’s fiat wallet to the customer’s mobile money 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 withdraw

Example:

10

​
walletId
string
required

wallet id

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

​
callbackUrl
string

callback url

Example:

"https://example.com"

​
referenceId
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:

"Withdrawal has been successfully created."

​
data
object