Deposit Cancellation

Event Key

ootb_deposit_cancellation

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

Event KeyEvent NameType
ootb_deposit_cancellationOOTB Deposit CancellationSimple 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": {
        "ootb_deposit_timestamp": "2022-04-09T20:15:00.000000Z",
        "ootb_start_balance": 100.00,
        "ootb_deposit_amount": 50.00,
        "ootb_deposit_method": "credit_card",
        "ootb_deposit_status": "cancelled",
        "ootb_ccy_code": "USD",
        "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 KeyParameter NameTypeDescription
ootb_deposit_timestampDeposit Cancellation TimestampStringISO 8601 datetime of the deposit cancellation.
ootb_start_balanceStart BalanceNumberThe user’s balance before the deposit attempt.
ootb_deposit_amountDeposit AmountNumberThe amount that was intended to be deposited.
ootb_deposit_methodDeposit MethodStringThe method intended for the deposit (e.g., credit_card).
ootb_deposit_statusDeposit StatusStringThe status of the deposit, set to "cancelled".
ootb_ccy_codeCurrency CodeStringCurrency code (e.g., USD).
ootb_languageLanguageStringThe language preference (e.g., en).
ootb_countryCountryStringThe country code (e.g., US).
ootb_platformPlatformStringThe platform used (e.g., iOS, Android).
ootb_channelChannelStringThe channel used for the deposit (e.g., mobile, web).
ootb_brandBrandStringThe brand associated with the deposit attempt.
ootb_licenseLicenseStringThe license string associated with the deposit attempt.
ootb_cancel_reason*Cancellation ReasonStringOptional. 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:
    • ootb_deposit_timestamp: Records the date and time of the deposit cancellation, matching the structure in ootb_deposit.
    • ootb_deposit_status: Set to "cancelled" to indicate the deposit was not completed.
    • ootb_cancel_reason: Optionally records the reason for cancellation, if available.