Standard Deposit

Event Key

ootb_deposit

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

Event Key	Event Name	Type
ootb_deposit	OOTB Deposit	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 Deposit Event:

{
  "context": {
				"ootb_transaction_id":"11228836059",
        "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": "completed",
        "ootb_language": "en",
        "ootb_country": "US",
        "ootb_platform": "iOS",
        "ootb_channel": "mobile",
        "ootb_brand": "brand123",
        "ootb_license": "licenseXYZ"
    }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_transaction_id`	Transaction ID	String/Number	Unique identifier for the transaction that resulted in the balance update.
`ootb_deposit_timestamp`	Deposit Timestamp	String	ISO 8601 datetime of the deposit.
`ootb_start_balance`	Start Balance	Number	The user’s balance before the deposit.
`ootb_deposit_amount`	Deposit Amount	Number	The amount of the deposit.
`ootb_deposit_method`	Deposit Method	String	The method used for the deposit (e.g., credit_card).
`ootb_deposit_status`	Deposit Status	String	The status of the deposit (e.g., completed).
`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 deposit (e.g., mobile, web).
`ootb_brand`	Brand	String	The brand associated with the deposit.
`ootb_license`	License	String	The license string associated with the deposit.

Explanation

event: The event name is set to ootb_deposit, reflecting that a deposit action has occurred.
context: Contains all parameters relevant to the deposit event.
- ootb_transaction_id: Provides a reference to the specific transaction that led to this balance change.
- ootb_deposit_timestamp: The exact date and time when the deposit was made.
- ootb_start_balance: The user's account balance just before this deposit was processed.
- ootb_deposit_amount: The monetary value of the deposit.
- ootb_deposit_method: The payment method used by the customer for the deposit (e.g., credit_card, bank_transfer).
- ootb_deposit_status: The outcome or current status of the deposit transaction (e.g., completed, pending, failed).
- ootb_language: The language preference of the user at the time of the deposit.
- ootb_country: The country code associated with the user or the transaction.
- ootb_platform: The platform (e.g., iOS, Android, Web) from which the deposit was made.
- ootb_channel: The channel (e.g., mobile app, website) used for the deposit.
- ootb_brand: The specific brand or skin under which the deposit was made, if applicable.
- ootb_license: Any relevant gaming or financial license identifier associated with the transaction.