Deposit Cancellation

Event Key

ootb_deposit_cancellation

This event should be sent when a deposit is canceled before it is completed.

Event Key	Event Name	Type
`ootb_deposit_cancellation`	OOTB Deposit 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 Deposit Cancellation Event:

{
    "context": {
        "deposit_timestamp": "2022-04-09T20:15:00.000000Z",
        "start_balance": 100.00,
        "deposit_amount": 50.00,
        "deposit_method": "credit_card",
        "deposit_status": "cancelled",
        "ccy_code": "USD",
        "language": "en",
        "country": "US",
        "platform": "iOS",
        "channel": "mobile",
        "brand": "brand123",
        "license": "licenseXYZ",
        "cancel_reason": "user_initiated"
    }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`deposit_timestamp`	Deposit Cancellation Timestamp	String	ISO 8601 datetime of the deposit cancellation.
`start_balance`	Start Balance	Number	The user’s balance before the deposit attempt.
`deposit_amount`	Deposit Amount	Number	The amount that was intended to be deposited.
`deposit_method`	Deposit Method	String	The method intended for the deposit (e.g., credit_card).
`deposit_status`	Deposit Status	String	The status of the deposit, set to "cancelled".
`ccy_code`	Currency Code	String	Currency code (e.g., USD).
`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 deposit (e.g., mobile, web).
`brand`	Brand	String	The brand associated with the deposit attempt.
`license`	License	String	The license string associated with the deposit attempt.
`cancel_reason`*	Cancellation Reason	String	Optional. Reason for the deposit cancellation (e.g., `user_initiated`, `system_decline`).

Explanation

event: The event name is set to ootb_deposit_cancellation to indicate a canceled deposit attempt.
context:
- deposit_timestamp: Records the date and time of the deposit cancellation, matching the structure in ootb_deposit.
- deposit_status: Set to "cancelled" to indicate the deposit was not completed.
- cancel_reason: Optionally records the reason for cancellation, if available.