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 that a previously initiated withdrawal has been canceled.
context: Contains all parameters relevant to the withdrawal cancellation event.
- ootb_withdrawal_cancel_timestamp: The exact date and time when the withdrawal was canceled.
- ootb_end_balance: The user's account balance after the cancellation of the withdrawal (funds are typically returned to the balance).
- ootb_withdrawal_amount: The monetary value of the withdrawal that was intended but subsequently canceled.
- ootb_withdrawal_method: The payment method that was originally selected for the withdrawal.
- ootb_withdrawal_status: The final status of this withdrawal attempt, which will be "cancelled".
- ootb_language: The language setting of the user or platform at the time of the cancellation.
- ootb_country: The country associated with the user or the transaction.
- ootb_platform: The platform (e.g., iOS, Android, Web) from which the withdrawal was initiated or canceled.
- ootb_channel: The channel (e.g., mobile app, website) used for the withdrawal process.
- ootb_brand: The specific brand or skin associated with the user's account or the transaction.
- ootb_license: Any relevant gaming or financial license identifier associated with the transaction.
- ootb_cancel_reason: An optional field specifying the reason why the withdrawal was canceled (e.g., initiated by the user before processing, or system-related reasons).