Payout
Mobile money
Webhook payload for mobile money payout transactions
When your mobile money payouts are confirmed, details about the transaction are sent in a payload that provides essential information for record-keeping and reconciliation.
This payload applies to payouts with method set to mobile_money. These payouts are available for KES, UGX, TZS, XOF, and GHS.
The payload has the same shape as the payloads for the other currencies. A mobile money payout has no bank account, so Blaaiz puts the mobile money details in the bank fields.
recipient.account_numbercontains the phone number of the recipient.recipient.bank_namecontains the name of the mobile money operator.
The webhook does not include recipient.bank_code. The API responses include it. In these responses, recipient.bank_code contains the code of the operator.
Parameter overview
| Parameter | Description |
|---|---|
message | Indicates the status of the transaction. |
transaction_id | A unique identifier for the transaction. |
transaction_reference | A unique identifier for the transaction. |
merchant_reference | The reference that you supplied on the payout. It is null if you supplied no reference. |
transaction_status | The status of the transaction (e.g., SUCCESSFUL). |
transaction_fee | The fee charged for the transaction. |
transaction_amount_without_fee | The amount sent excluding fees. |
transaction_amount | The total amount including fees. |
transaction_currency | The currency of the wallet that paid for the transaction (e.g., USD). |
customer_id | The customer associated with the transaction |
recipient | Details of the recipient, including: |
recipient.account_number | The phone number of the recipient's mobile money account. |
recipient.account_name | The name on the recipient's mobile money account. |
recipient.bank_name | The name of the mobile money operator. |
recipient.amount | The amount that the recipient received, in the destination currency (e.g., KES). |
event_id | A unique identifier for the event. |
type | The type of transaction (e.g., payout). |
Example payload
{
"message": "Transaction Completed",
"transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
"transaction_reference": "90980e50-0b83-40a6-aa46-ac8e795b1acd",
"merchant_reference": "ORDER-1001",
"transaction_status": "SUCCESSFUL",
"transaction_fee": 5.0,
"transaction_amount_without_fee": 100.0,
"transaction_amount": 105.0,
"transaction_currency": "USD",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"recipient": {
"account_number": "+254712345678",
"account_name": "Jane Wanjiru",
"bank_name": "M-Pesa",
"amount": 12890.0
},
"event_id": "9d46b957-0cf5-4743-847a-254d92de6a85",
"type": "payout"
}