post https://api-v3-uat.tanda.africa/io/v3/organizations//consumers//request
Initiates a mobile money deposit to a consumer's wallet.
Deposit Consumer Wallet
Consumer Mobile Money Deposit
This API allows consumers to deposit money into a merchant's account using mobile money. The customer authorizes the payment via a USSD/STK push prompt to enter their mobile money PIN, which completes the transfer of value from their wallet to a business or merchant shortcode. The Tanda I/O RESTful API fully supports this payment channel.
Request Body Parameters
| Parameter | Description | Mandatory |
|---|---|---|
| commandId | Command to execute, must be ConsumerMobileMoneyDeposit | 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 payment details | Yes |
Request Details in request array
request array| id | Description | Mandatory |
|---|---|---|
| amount | Amount to be deposited in Ksh | Yes |
| narration | Description or note for the payment | Yes |
| ipnUrl | URL to receive instant payment notifications | Yes |
Example Request
{
"commandId": "ConsumerMobileMoneyDeposit",
"serviceProviderId": "MPESA",
"reference": "J8SQSOQOP",
"request": [
{
"id": "amount",
"value": "70",
"label": "Amount"
},
{
"id": "narration",
"value": "Payment",
"label": "Narration"
},
{
"id": "ipnUrl",
"value": "https://tanda-tills-ipn.free.beeceptor.com",
"label": "Notification URL"
}
]
}Sample Response
{
"trackingId": "a353acfa-5340-49ac-8f7c-2f807a87fc2f",
"reference": "J8SQSOQOP",
"status": "P202000",
"message": "Successful. Request accepted for processing. You will be notified by Tanda shortly"
}