post https://api-v3-uat.tanda.africa/io/v3/organizations//consumers//request/b2c
Initiates a mobile money Withdrawal from a consumer's wallet.
Consumer Wallet Withdrawal API
Consumer Mobile Money Withdrawal
This API lets consumers withdraw money from a merchant's account to a mobile number using mobile money, authorized similarly via USSD/STK prompts.
Request Body Parameters
| Parameter | Description | Mandatory |
|---|---|---|
| commandId | Command to execute, must be ConsumerMobileMoneyWithdrawal | Yes |
| serviceProviderId | Mobile money service provider, e.g., MPESA | Yes |
| reference | Unique identifier for the transaction (recommended: UUID or Alphanumeric) | Yes |
| request | Array of key-value pairs specifying withdrawal details | Yes |
Request Details in request Array for Withdrawal
request Array for Withdrawal| id | Description | Mandatory |
|---|---|---|
| amount | Amount to be withdrawn in Ksh | Yes |
| narration | Description or note for the payment | Yes |
| accountNumber | Mobile number to receive the funds (format: country code + number) | Yes |
| ipnUrl | URL to receive instant payment notifications | Yes |
Example Request - Withdrawal
{
"commandId": "ConsumerMobileMoneyWithdrawal",
"serviceProviderId": "MPESA",
"reference": "AQOKJ38Q1",
"request": [
{
"id": "amount",
"value": "1",
"label": "Amount"
},
{
"id": "narration",
"value": "Payment",
"label": "Send to mobile number"
},
{
"id": "accountNumber",
"value": "254793875319",
"label": "Account Number"
},
{
"id": "ipnUrl",
"value": "https://tanda-tills-ipn.free.beeceptor.com",
"label": "Notification URL"
}
]
}Example Response
{
"trackingId": "a353acfa-5340-49ac-8f7c-2f807a87fc2f",
"reference": "AQOKJ38Q1",
"status": "P202000",
"message": "Successful. Request accepted for processing. You will be notified by Tanda shortly"
}