Returns a list of available rewards for a given customer and purchase.

This method returns a list of all rewards available even if they cannot be used by the given customer at the moment.

This method returns two types of rewards: Discounts (Value Discounts and Percent Discounts) or Cashback. Although not common, it is possible to have all types of rewards active at the same time.

Input parameters

• CustomerId The id of the customer. It can be email or document (CPF/CNPJ). If a document use numbers only.
• PurchaseValue Current value of the order. Should NOT contains discounts, return codes (vales) or other promotions.
• DiscountValue If there is another discount in the order (not from BonifiQ) it can be passed here. BonifiQ use this information to return only rewards that can be used with other discounts. If no discount is being used pass null or 0

Main return properties

• HasRewards if this property is false means there are no rewards available. The entire reward flow must be skipped.
• ShouldValidateCustomer if true the flow must follow the Customer Validation Flow where an PIN CODE will be asked from the customer. If false the validation flow must be skipped
• AvailablePoints Returns the amount of points the customer currently have. This is important is Discount Rewards as the customer needs to know how many points he needes to redeem a reward.
• CashbackEnabled If true means there is a Cashback reward in the list. The customer will be able to use it if he had enough cashback
• AvailableCashback The amount of Cashback the customer have. It is important to note that the customer may not be able to use it entirely as there are usage rules (such as minimum purchase value).
• MaxCashbackForCurrentPurchase This is the maximum cashback the customer will be able to use in the current purchase. It maybe different from AvailableCashback as this property take into account usage rules.

Discounts Rewards

A discount reward offers some discount in exchange of an amount of points. The discount can be a Value (R$10,00 discount in exchange of 100 points) or Percent (15% discount in exchange of 1000 points)-

A discount reward cannot be used partially. Customer must either use all the value or don`t use at all.

It is possible (and rather common) to have multiple Discount Rewards active at same time (for instance: R$10,00 for 10 points, R$30,00 for 25 points, 10% for 15 points, etc)

Important properties

Title Represents brief user-friendly description of the reward (such as “R$50,00 de desconto", "10$50,00 em cashback”)

CanUse Despite the fact the API returns all available rewards you have to check the CanUse property to allow the customer to use this reward. The CanUse property will be true when the customer have enought points and the purchase value is within the configured minimum amount.

If the CanUse property is false you can still show the reward to the customer (in a disabled state). This is useful for him to known which rewards he can redeem in the future.

Requirements This is an optional string detailing restrictions regarding the Reward such as: Minimum amount of purchase, percent relative to the purchase, etc. It is a user-friendly string so you can show it to the user alongside the reward name and points.

Points This is the cost in points of this reward. It is useful to the customer to know how many points will be deduct from him when this reward is redeemed.

Value For Value Discount this represents the value in cash (eg: 10.00 for a R$10,00 reward). For Percent Discount this is the percent value (eg: 10.00 for a 10% discount). This property is useful for you to apply the discount in the customer purchase on behalf of BonifiQ.

RewardCanBeCumulative If true the customer can use this reward in conjunction with other discounts. If false the customer can only use this reward if there is no other discount in the order.

Cashback Reward

A Cashback reward also offers an value discount in exchange of points but the amount can be selected by the customer. For instance: the customer can have R$10,00 of cashback balance but decide to use just R$5,00.

As the value can be selected, it is necessary to ask de customer for the value he wants to use and use it in redeem

A Cashback maybe not present in the reward list as it could be disabled.

Important properties

Some properties are the same of Discounts Rewards (see above). A few other are exclusive for Cashback

• CashbackEnabled if true the cashback exist and is active. However the user could not be able to use it as he may not have enough balance.
• AvailableCashback Total amount of cashback the use have.
• MaxCashbackForCurrentPurchase This is the maximum amount of cashback that can be used in the current purchase. The value may differ from AvailableCashback due to purchase rules such as minimum value.
• IsCashback Returns true if this is a cashback reward. If so, we need to ask the customer for the amount he wants to use upon redeeming