Standard Withdrawal

Event Key

ootb_withdrawal

This event should be sent when a user conducts a withdrawal.

Event Key	Event Name	Type
`ootb_withdrawal`	OOTB Withdrawal	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 Standard Withdrawal Event:

{
    "context": {
        "withdrawal_timestamp": "2022-04-09T20:01:51.887000Z",
        "start_balance": 200.00,
        "withdrawal_amount": 50.00,
        "withdrawal_method": "bank_transfer",
        "withdrawal_status": "pending",
        "language": "en",
        "country": "US",
        "platform": "iOS",
        "channel": "mobile",
        "brand": "skin123",
        "license": "licenseXYZ"
    }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`withdrawal_timestamp`	Withdrawal Timestamp	String	ISO 8601 datetime of the withdrawal request.
`start_balance`	Start Balance	Number	The user’s balance before the withdrawal.
`withdrawal_amount`	Withdrawal Amount	Number	The amount of the withdrawal.
`withdrawal_method`	Withdrawal Method	String	The method used for the withdrawal (e.g., bank_transfer).
`withdrawal_status`	Withdrawal Status	String	The status of the withdrawal (e.g., pending).
`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 skin ID associated with the withdrawal.
`license`	License	String	The license string associated with the withdrawal.

Explanation

event: The event name is set to ootb_withdrawal, reflecting the nature of the withdrawal event.
context:
- withdrawal_timestamp: Records the date and time of the withdrawal request.
- withdrawal_amount: The amount being withdrawn.
- withdrawal_status: Indicates the status of the withdrawal, such as "pending", "completed", or "failed".