The following table describes the collection properties for the Loyalty microservice:

S. No.AttributeDefault ValueDescription
1minimumRewardsValueForRedemption1Indicates the minimum rewards value where a user can redeem in a single transaciton.
2cycleperiod1Specifies the cycle period (in days).
3defaultlocaleen_USIndicates the default locale of the collection. The locale should be mentioned in the Java standard locale format.
4applicablelocalesen_USIndicates the list of locales applicable to the collection. The locale should be mentioned in the Java standard locale format.
5isRewardApprovalRequiredTRUEIndicates whether the reward approval is required or not.
Enable or disable the status of the property key to mention if the reward approval is required or not.
  • enable the toggle to approve the reward manually. This is default.
  • disable the toggle to approve the reward automatically.
6synchronousRedemptiontrueIndicates whether to redeem the approved points synchronously (if the value is true) or asynchronously (if the value value is false).
  • Synchronous: Before return redemption, removes the approved points.
  • Asynchronous: After return redemption, removes the approved points.
7customActionTypesConfigcustomActionTypesConfig",

      "value": "[{\"name\":\"Earn Points Action\",\"description\":\"Earn Points Action\",\"className\":\"com.skava.loyalty.action.AddRewardsAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"formulaClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"rewardType\",\"displayName\":\"Reward Type\",\"type\":\"select\"},{\"name\":\"formula\",\"displayName\":\"Formula\",\"type\":\"text\"}]},{\"name\":\"Approve Points Action\",\"description\":\"Approve Points Action\",\"className\":\"com.skava.loyalty.action.ApproveCurrentCyclePendingRewards\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"rewardType\",\"displayName\":\"Reward Type\",\"type\":\"select\"}]},{\"name\":\"Tier Update Action\",\"description\":\"Loyalty Tier\",\"className\":\"com.skava.loyalty.action.TierUpdateAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"tier\",\"displayName\":\"Tier Percentage\",\"type\":\"text\",\"validation\":\"^[0-9]*$\"}]},{\"name\":\"Redemption Block / Unblock Action\",\"description\":\"Redemption Block / Unblock Action\",\"className\":\"com.skava.loyalty.action.RedemptionBlockUnblockAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"rewardType\",\"displayName\":\"Reward Type\",\"type\":\"select\"},{\"name\":\"status\",\"displayName\":\"Status\",\"type\":\"select\",\"options\":[{\"displayName\":\"Block\",\"name\":\"Block\",\"description\":\"Block\"},{\"displayName\":\"Unblock\",\"name\":\"Unblock\",\"description\":\"Unblock\"}]}]},{\"name\":\"Transaction Forfeit Action\",\"description\":\"Transaction Forfeit Action\",\"className\":\"com.skava.loyalty.action.ForfeitAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"rewardType\",\"displayName\":\"Reward Type\",\"type\":\"select\"}]},{\"name\":\"Property Update Action\",\"description\":\"Property Update Action\",\"className\":\"com.skava.loyalty.action.UpdateRewardsBankPropertyAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"propertyName\",\"displayName\":\"PropertyName\",\"type\":\"text\"},{\"name\":\"formula\",\"displayName\":\"Formula\",\"type\":\"text\"}]},{\"name\":\"Loyalty Redemption Action\",\"description\":\"Loyalty Redemption Action\",\"className\":\"com.skava.loyalty.action.LoyaltyRedemptionAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":[{\"name\":\"rewardType\",\"displayName\":\"Reward Type\",\"type\":\"select\"},{\"name\":\"formula\",\"displayName\":\"Formula\",\"type\":\"text\"}]},{\"name\":\"Recycle Action\",\"description\":\"Recycle Action\",\"className\":\"com.skava.loyalty.action.RecycleCalculationAction\",\"conditionClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"formulaClasses\":\"com.skava.loyalty.action.model.CustomEvent\",\"params\":null}]
Contains the custom actions of the rule settings. This field is used to customize the action configuration of loyalty rules. This field contains a valid JSON string.
8expirationPeriod365Indicates the loyalty points expiration period (in days).
9roundOffValue2Indicates the number of decimal places.
10loyaltyPropertynullIndicates the default properties of Events APIs to define loyalty event modal attributes. This field contains a valid JSON string.




Revision History
2021-01-21 | SW – Updated the descriptions.
2020-10-08 | HM – Updated content with properties.
2020-05-26 | AN – Updated content for June 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-10-31 | AN – Page created and content uploaded.