Withdrawal Cancellation
Event Key
ootb_withdrawal_cancellation
This event should be sent when a withdrawal is canceled before it is completed.
Event Key | Event Name | Type |
---|---|---|
ootb_withdrawal_cancellation | OOTB Withdrawal Cancellation | Simple event |
Event Structure
The mandatory properties (tenant
, timestamp
, event
, and customer
) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Withdrawal Cancellation Event:
{
"context": {
"ootb_withdrawal_cancel_timestamp": "2022-04-09T20:01:51.887000Z",
"ootb_end_balance": 150.00,
"ootb_withdrawal_amount": 50.00,
"ootb_withdrawal_method": "bank_transfer",
"ootb_withdrawal_status": "cancelled",
"ootb_language": "en",
"ootb_country": "US",
"ootb_platform": "iOS",
"ootb_channel": "mobile",
"ootb_brand": "brand123",
"ootb_license": "licenseXYZ",
"ootb_cancel_reason": "user_initiated"
}
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
ootb_withdrawal_cancel_timestamp | Withdrawal Cancellation Timestamp | String | ISO 8601 datetime of the withdrawal cancellation. |
ootb_end_balance | End Balance | Number | The user’s balance after the withdrawal cancellation. |
ootb_withdrawal_amount | Withdrawal Amount | Number | The amount that was intended to be withdrawn. |
ootb_withdrawal_method | Withdrawal Method | String | The method that was to be used for the withdrawal (e.g., bank_transfer). |
ootb_withdrawal_status | Withdrawal Status | String | The status of the withdrawal, set to "cancelled" . |
ootb_language | Language | String | The language preference (e.g., en). |
ootb_country | Country | String | The country code (e.g., US). |
ootb_platform | Platform | String | The platform used (e.g., iOS, Android). |
ootb_channel | Channel | String | The channel used for the withdrawal (e.g., mobile, web). |
ootb_brand | Brand | String | The brand associated with the withdrawal. |
ootb_license | License | String | The license string associated with the withdrawal. |
ootb_cancel_reason * | Cancellation Reason | String | Optional. Reason for the withdrawal cancellation (e.g., "user_initiated" , "system_decline" ). |
Explanation
- event: The event name is set to
ootb_withdrawal_cancellation
, reflecting the nature of the withdrawal cancellation. - context:
- ootb_withdrawal_cancel_timestamp: Records the date and time of the withdrawal cancellation.
- ootb_withdrawal_status: Set to
"cancelled"
to indicate the withdrawal was not completed. - ootb_cancel_reason: Optionally records the reason for cancellation, if available.
Updated 14 days ago