Standard Deposit Initiated

Event Key

ootb_deposit

This event should be sent each time a user initiates a deposit.

Event KeyEvent NameType
ootb_depositOOTB DepositSimple 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 OOTB Deposit Initiated event:

{
  "context": {
    "ootb_deposit_timestamp": "2022-04-09T20:01:51.887000Z",
    "ootb_start_balance": 100.00,
    "ootb_deposit_amount": 50.00,
    "ootb_deposit_method": "credit_card",
    "ootb_deposit_status": "initiated",
    "ootb_language": "en",
    "ootb_country": "US",
    "ootb_platform": "iOS",
    "ootb_channel": "mobile",
    "ootb_brand": "brand123",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

Parameter KeyParameter NameTypeDescription
ootb_deposit_timestampDeposit TimestampStringISO 8601 datetime of when the deposit was initiated.
ootb_start_balanceStart BalanceNumberThe user's balance before initiating the deposit.
ootb_deposit_amountDeposit AmountNumberThe amount of the intended deposit.
ootb_deposit_methodDeposit MethodStringThe method intended to be used for the deposit (e.g., credit_card, bank_transfer).
ootb_deposit_statusDeposit StatusStringThe status of the deposit (e.g., initiated, pending, completed, failed). For this event, it would typically be "initiated".
ootb_languageLanguageStringThe language preference of the user at the time of deposit (e.g., en, es).
ootb_countryCountryStringThe country code of the user at the time of deposit (e.g., US, GB).
ootb_platformPlatformStringThe platform used to initiate the deposit (e.g., iOS, Android, Web).
ootb_channelChannelStringThe channel used for initiating the deposit (e.g., mobile, web, app).
ootb_brandBrandStringThe brand or skin associated with the deposit transaction.
ootb_licenseLicenseStringThe gaming license under which the deposit is being made.

Explanation

  • event: Set to ootb_deposit to signify a deposit event. In this specific context, it represents the initiation of a deposit.
  • context:
    • ootb_deposit_timestamp: Records the precise date and time when the user started the deposit process.
    • ootb_start_balance: Shows the user's account balance just before they attempted this deposit.
    • ootb_deposit_amount: The monetary value the user intends to deposit.
    • ootb_deposit_method: Specifies the payment method chosen by the user for the deposit.
    • ootb_deposit_status: Indicates the current state of this deposit attempt; for this event, it should reflect an initial status like "initiated" or "pending".
    • ootb_language, ootb_country, ootb_platform, ootb_channel, ootb_brand, ootb_license: Standard metadata providing context about the user's environment and the transactional details, useful for segmentation, regulatory compliance, and analytics.