Deposit Limit Exceeded

Event Key

ootb_deposit_limit_exceeded

This event should be fired once the user has crossed or exceeded one or more of their deposit limits.

Event Key	Event Name	Type
`ootb_deposit_limit_exceeded`	OOTB Deposit Limit Exceeded	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 OOTB Deposit Limit Exceeded event:

{
  "context": {
    "ootb_is_deposit_limit_exceeded_daily": true,
    "ootb_is_deposit_limit_exceeded_weekly": false,
    "ootb_is_deposit_limit_exceeded_monthly": false,
    "ootb_is_deposit_limit_exceeded_lifetime": false,
    "ootb_limit_check_source": "deposit_attempt",
    "ootb_limit_check_reason": "pre_deposit_validation"
  }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_is_deposit_limit_exceeded_daily`	OOTB Is Deposit Limit Exceeded Daily	Boolean	Indicates if the daily deposit limit was exceeded.
`ootb_is_deposit_limit_exceeded_weekly`	OOTB Is Deposit Limit Exceeded Weekly	Boolean	Indicates if the weekly deposit limit was exceeded.
`ootb_is_deposit_limit_exceeded_monthly`	OOTB Is Deposit Limit Exceeded Monthly	Boolean	Indicates if the monthly deposit limit was exceeded.
`ootb_is_deposit_limit_exceeded_lifetime`	OOTB Is Deposit Limit Exceeded Lifetime	Boolean	Indicates if the lifetime deposit limit was exceeded.
`ootb_limit_check_source`	OOTB Limit Check Source	String	The context or trigger for checking the deposit limit (e.g., `deposit_attempt`).
`ootb_limit_check_reason`	OOTB Limit Check Reason	String	Reason for the deposit limit check being performed (e.g., `pre_deposit_validation`).

Explanation

event: Set to ootb_deposit_limit_exceeded to signify that a customer has hit one or more of their set deposit limits.
context:
- ootb_is_deposit_limit_exceeded_daily, _weekly, _monthly, _lifetime: These boolean flags indicate which specific limit(s) the user has crossed. At least one must be true for this event to be sent.
- ootb_limit_check_source: Records what action triggered this limit check (e.g., a deposit_attempt).
- ootb_limit_check_reason: Records why the check was performed (e.g., as part of pre_deposit_validation before allowing a transaction).