Deposit Limit Updated

Event Key

ootb_deposit_limit_updated

This event should be fired with every initial set or update of the customer deposit limit.

Event KeyEvent NameType
ootb_deposit_limit_updatedOOTB Deposit Limit UpdatedSimple 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 Updated event:

{
  "context": {
    "ootb_deposit_limit_daily": 1000,
    "ootb_deposit_limit_weekly": 5000,
    "ootb_deposit_limit_monthly": 20000,
    "ootb_deposit_limit_lifetime": 100000,
    "ootb_deposit_limit_change_rate_daily": 25,
    "ootb_deposit_limit_change_rate_weekly": 25,
    "ootb_deposit_limit_change_rate_monthly": 33,
    "ootb_deposit_limit_change_rate_lifetime": 100,
    "ootb_limit_change_reason": "user_requested",
    "ootb_limit_change_source": "user_preferences"
  }
}

 

Parameters

Parameter KeyParameter NameTypeDescription
ootb_deposit_limit_dailyOOTB Deposit Limit DailyNumberDaily deposit limit.
ootb_deposit_limit_weeklyOOTB Deposit Limit WeeklyNumberWeekly deposit limit.
ootb_deposit_limit_monthlyOOTB Deposit Limit MonthlyNumberMonthly deposit limit.
ootb_deposit_limit_lifetimeOOTB Deposit Limit LifetimeNumberLifetime deposit limit.
ootb_deposit_limit_change_rate_dailyOOTB Deposit Limit Change Rate DailyNumberDaily limit change rate (%). Once the limit is updated, this parameter can describe the change rate to support advanced triggering.
ootb_deposit_limit_change_rate_weeklyOOTB Deposit Limit Change Rate WeeklyNumberWeekly limit change rate (%).
ootb_deposit_limit_change_rate_monthlyOOTB Deposit Limit Change Rate MonthlyNumberMonthly limit change rate (%).
ootb_deposit_limit_change_rate_lifetimeOOTB Deposit Limit Change Rate LifetimeNumberLifetime limit change rate (%).
ootb_limit_change_reasonOOTB Limit Change ReasonStringReason for limit change (e.g., user_requested, regulatory_requirement).
ootb_limit_change_sourceOOTB Limit Change SourceStringSource of limit change action (e.g., user_preferences, admin_tool).

Explanation

  • event: Set to ootb_deposit_limit_updated to signify that a customer's deposit limit has been set or changed.
  • context:
    • ootb_deposit_limit_daily, _weekly, _monthly, _lifetime: These parameters capture the new values for the respective deposit limits.
    • ootb_deposit_limit_change_rate_daily, _weekly, _monthly, _lifetime: These parameters capture the percentage change from the previous limit. This is useful for segmentation and triggering (e.g., targeting users who increased their limit vs. users who decreased it).
    • ootb_limit_change_reason: Records why the change was made (e.g., a voluntary change by the user, a mandatory change due to regulation).
    • ootb_limit_change_source: Records where the change was initiated (e.g., from the user's account settings, by a customer support agent).