Learn about the Debit Points from Members process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
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 |
What Does the Template Contain?
The template contains a rule and set of parameters. The Debit Points from Members rule has only one rule step: Debits Points. The parameters store values that the rule uses to debit points.
| Rule Step Name | What Does the Rule Step Do? | Parameters used in the Step | What Does the Parameter Do? | Examples of Customization |
|---|---|---|---|---|
| Debit Points | Redeems points for transactions and debits points from the points balance of the Loyalty Program Member based on the details provided in the input parameters. | CurrencyName | The input parameter stores the loyalty program currency in which points are debited from the member for redeeming their transactions. | If you have multiple currencies such as Non-Qualifying Points and Qualifying Points and when you want to debit points calculated in external systems, you can clone the template and select the currency to debit. This creates a separate API for each currency. In the payload for the API, you can specify the precalculated points from the external system to be debited from the member’s points balance in Loyalty Management. |
| PointsToDebit | The input parameter stores the number of points to be debited from the member. | |||
| PointsDebited | The output parameter stores the number of points debited from the member. |
How Can You Execute the Processes Created Using the Debit Points from Member Process Template?
You can clone the Debit Points from Members process template to debit points from members for redeeming their points.
Loyalty Management provides a Business API to execute processes created by cloning loyalty program process templates. The DebitPointsFromMember API can be integrated with an external system to ensure that it’s executed when a member redeems precalculated points in an external system. If members redeems points on your ecommerce site, integrate the site with the API when members’ redeem points.
In the API, you must specify these values before executing the API for your cloned process:
- In the API endpoint, specify the API name of your cloned process.
- In the API request, specify the values for the parameters that are used in the Debit Points
rule.
Ensure that you specify the Loyalty Program Currency in which points must be debited from the member and the date from which the rule must start processing transaction journals and debit points.
When you execute the API, it runs the loyalty program process and updates the Points Balance using the values provided in the API request.
Examples of How You Can Use the Template
You can clone and extend the template based on your requirements. Here are a few ways you can use the template:
| Use Case | How to Achieve the Use Case? |
|---|---|
| A loyalty program has Reward Points as Non-Qualified Points and Tier Points as Qualified Points. The Loyalty Program Admin wants to create separate APIs for debiting Reward Points and Tier Points. |
From the cloned process, go to the Debit Points rule and select the Currency as Reward Points.
|