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": {
        "withdrawal_cancel_timestamp": "2022-04-09T20:01:51.887000Z",
        "end_balance": 150.00,
        "withdrawal_amount": 50.00,
        "withdrawal_method": "bank_transfer",
        "withdrawal_status": "cancelled",
        "language": "en",
        "country": "US",
        "platform": "iOS",
        "channel": "mobile",
        "brand": "brand123",
        "license": "licenseXYZ",
        "cancel_reason": "user_initiated"
    }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`withdrawal_cancel_timestamp`	Withdrawal Cancellation Timestamp	String	ISO 8601 datetime of the withdrawal cancellation.
`end_balance`	End Balance	Number	The user’s balance after the withdrawal cancellation.
`withdrawal_amount`	Withdrawal Amount	Number	The amount that was intended to be withdrawn.
`withdrawal_method`	Withdrawal Method	String	The method that was to be used for the withdrawal (e.g., bank_transfer).
`withdrawal_status`	Withdrawal Status	String	The status of the withdrawal, set to `"cancelled"`.
`language`	Language	String	The language preference (e.g., en).
`country`	Country	String	The country code (e.g., US).
`platform`	Platform	String	The platform used (e.g., iOS, Android).
`channel`	Channel	String	The channel used for the withdrawal (e.g., mobile, web).
`brand`	Brand	String	The brand associated with the withdrawal.
`license`	License	String	The license string associated with the withdrawal.
`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:
- withdrawal_cancel_timestamp: Records the date and time of the withdrawal cancellation.
- withdrawal_status: Set to "cancelled" to indicate the withdrawal was not completed.
- cancel_reason: Optionally records the reason for cancellation, if available.