You are here:
Understand How Escrow Points Work
Before you escrow members’ points, find out more about the workflows that configure escrows for currencies and automate the process of releasing points to members' balances. Also, learn about how points are kept in escrow and correctly rolled over to the members' points balances.
Required Editions
| Available in: Lightning Experience in Enterprise, Performance, Unlimited, and Developer Editions |
| Available in: Orgs that have the B2C - Loyalty, B2C - Loyalty Plus, B2B - Loyalty, Loyalty Management - Growth, or Loyalty Management - Advanced license enabled |
How Do I Configure Escrow Points for Currencies in My Loyalty Program?
To escrow points for a loyalty program, complete these steps:
| Sequence | Task | Description |
|---|---|---|
| 1 | Specify the escrow period for your loyalty program. | Sets the escrow period for your loyalty program. You can't define unique escrow periods for your currencies. |
| 2 | Select Has Escrow on the Loyalty Program Currency record if you want to hold members' points for this currency in escrow. | Indicates which currencies in your program are escrowed for members. |
| 3 | Copy the Roll Over Escrow Points to Members Data Processing Engine template definition and activate it. | Rolls over points from a member's escrow points balance to the member’s points balance. |
| 4 | Run the copy of the Roll Over Escrow Points to Members definition in Flows. Specify the name of the loyalty program as the input variable value of the definition. | Runs the definition at a frequency of your choice. Points aren’t rolled over in real time. |
What Happens When Points Are Credited to a Member for a Currency That Has Escrow?
When the Credit Points Flow action processes transaction journals, it credits points to the member's points balance. If a currency has escrow, points are credited to the member's escrow points balance rather than to the member's points balance.
To credit points to the member's escrow points balance, a Loyalty Ledger record is created. The Escrow Points Credit Date field on the Loyalty Ledger record is automatically populated with the date that points roll over to the member's points balance. The escrow points credit date is calculated by adding the escrow period to the activity date of the transaction journal for which the ledger is created. If the transaction’s activity date is Jan 5 and the escrow period is 15 days, then the escrow points credit date is automatically set to Jan 20 in the ledger. If you want to override the automatically calculated escrow points credit date, see Override the Escrow Date for Transactions.
On the Loyalty Member Currency related list of a member's Loyalty Program Member record, track the member's escrow points balance for the member's associated currencies.
How Are Escrow Points Rolled over to a Member's Points Balance?
The Roll Over Escrow Points to Members Data Processing Engine definition rolls points over at time intervals that you specify. This definition processes all the ledgers created between the date the escrow points were last processed and the date of the run. The definition filters out ledgers that don't have a value for the Escrow Points Credit Date field. If the date specified in Escrow Points Credit Date field is less than or equal to the run's date, the points in those ledgers are rolled over to the associated member's points balance.
Which Calculations Are Used to Manage Escrow Points?
After the Roll Over Escrow Points to Members definition writes back the results, here's how a member's points balance and escrow points balance are calculated:
- Escrow Points Balance: TotalEscrowPointsAccrued - TotalEscrowRolloverPoints
- Points Balance: TotalPointsAccrued - TotalPointsRedeemed - TotalPointsExpired + TotalEscrowRolloverPoints
What Are the Other Changes If a Currency Has Escrow?
- The Get Member Points action provides the member's escrow points balance as output.
- If a transaction is canceled using the Reverse Transaction quick action on the Transaction Journal list view or on the Transaction Journal record, the escrow points are also canceled.
- Fixed non-qualifying currency points that have escrow expire based on when points are rolled over to the member rather than the activity date of the associated transaction.
- The Credit Non-Qualifying Points to Members and the Credit Qualifying Points to Members
Data Processing Engine definitions ignore ledgers that have the Escrow Credit Date field
populated.
The Roll Over Escrow Points to Members definition processes Loyalty Ledger records with escrow credit dates.
How to Manage Points Expiration Processes for Currencies that have Escrow?
- When scheduling points expiration processes for currencies with escrow, make sure the
Roll Over Escrow Points to Members Data Processing Engine definition runs before the
before the points expiration process.
This ensures that points expiration processes consider members' latest point balance when calculating which points to expire.
- When designing a process to credit points to members, make sure that the escrow points credit date is on or before the expiration date of the credited points.
