Custom Payment Reactions Advanced Setting – BriteCore Support

Overview: The custom-payment-reactions advanced setting allows administrators to create custom rules for how BriteCore handles payments that are less than or greater than the amount due. This feature enables specific actions based on the payment amount relative to the policy balance, payoff amount, and other factors.

How It Works: With this setting, you can define custom payment rules using conditions (predicates) and actions (effects). The conditions specify when the rule should apply, and the actions determine what happens when those conditions are met.

Components:

Predicate: This is the condition that must be true for the action to be triggered. It involves comparing the payment_amount against other variables, such as the due_amount or payoff_amount.
Effects: These are the actions that BriteCore will take when the predicate condition is met, such as setting the payment distribution or handling underpayments.

Example Rules:

When the payment is greater than the amount due but less than or equal to the payoff amount:

Predicate:
- payment_amount > due_amount
- payment_amount <= payoff_amount
Effect: Set the distribution to "remain on policy."

{
  "predicate": {
    "$and": [
      {"payment_amount": {"$gt": "$due_amount"}},
      {"payment_amount": {"$lte": "$payoff_amount"}}
    ]
  },
  "effects": [
    {"name": "set-distribution", "action": "remain-on-policy"}
  ]
}

When the payment exceeds the payoff amount:

Predicate:
- payment_amount > payoff_amount
Effect: Move the difference between the payment and the payoff amount to the return premium.

{
  "predicate": {
    "$and": [
      {"payment_amount": {"$gt": "$payoff_amount"}}
    ]
  },
  "effects": [
    {"name": "set-distribution", "action": "move-payoff-diff-to-return-premium"}
  ]
}

When the payment exceeds the payoff amount and remains on the policy:

Predicate:
- payment_amount > payoff_amount
Effect: Set the distribution to "remain on policy."

{
  "predicate": {
    "$and": [
      {"payment_amount": {"$gt": "$payoff_amount"}}
    ]
  },
  "effects": [
    {"name": "set-distribution", "action": "remain-on-policy"}
  ]
}

When the payment is less than the amount due:

Predicate:
- payment_amount < due_amount
Effect: Allow the underpayment.

{
  "predicate": {
    "$and": [
      {"payment_amount": {"$lt": "$due_amount"}}
    ]
  },
  "effects": [
    {"name": "set-distribution", "action": "allow-underpayment"}
  ]
}

Setting Up Custom Payment Reactions:

Navigate to the Settings section in BriteCore.
Locate the Advanced Settings page and search for custom-payment-reactions.
Add or modify the existing JSON rules based on your organization’s needs.
Save the changes, and the system will automatically apply the new rules when processing payments.

Use Cases:

Prevent overpayments from affecting the policy balance by moving excess amounts to the return premium.
Allow partial payments below the due amount to be accepted without triggering an error.
Set policies to remain active even with payments above the due amount but below the payoff amount.

For further customization or assistance, please contact BriteCore support.

Related articles