Getting Started with Rewards Catalog

Note : Rewards catalog is based on API first architecture, so brands can directly use the APIs to create, update and view the rewards.

To create rewards on the Marvel UI, perform the following:

1. Go to the old UI of Capillary and type Marvel in the search bar.

2. Click on Marvel Rewards. You will be redirected to the below page for your org

3. To create a new reward, click on the + icon on the top right corner. Enter all the fields mentioned below:

❗️

Note:

Ensure that an external points system (e.g., Bonus Link) is configured when enabling external points redemption at the organization level. If external points APIs are not configured, the "Create Reward" option in the UI will remain disabled.

a. Type - Select the type of reward you want to create (e.g., points, voucher, free voucher). This is just a metadata.

1. Vouchers: Digital coupons generated against redeeming customer points. For example, redeem 50 points for a 10% off coupon.
2. Physical voucher: Physical coupons generated against redeeming customer points. For example, redeem 150 points for a flat 150 off coupon.
3. Free voucher: Digital coupons generated without any points redemption.

b. Priority - Set the priority level for the reward (e.g., high, medium, low or 1, 2, 3, 4 and so on). This is a metadata for the reward.

c. Category - Select the category for the reward (e.g., fashion, electronics, groceries). You can create the categories in the category section in Marvel. This is a metadata for the reward.

d. Subscription - This is not working and to be ignored while creating a reward.

e. Advanced Filtering - Use filters such as tier, group, or label to specify the target audience for the reward. This is a metadata for the reward.

f. Intouch Points - Define the number of intouch points required to purchase a reward.

g. Redemption type - Define the redemption type if it is intouch reward or vendor reward or cart promotion.

1. InTouch only rewards: These are points or coupons created in Capillary and uses Capillary APIs.
2. Vendor only rewards: These are either points or coupons created at the vendor end. Capillary uses vendor specific APIs directly to identify and issue rewards. In this case, there will be no data at the Intouch side and redemption doesn’t happen in Capillary.I
3. Vendor Intouch reward:

🚧

Attention

It is not recommended to use the Vendor Intouch rewardredemption type. Instead, you can use the Vendor only reward redemption type to issue coupons directly through the vendor API.

Here, the system will use the vendor specific API to issue vendor coupons and after receiving a successful response from the API, the system will use the capillary issue coupon API to issue coupons and retrieve the coupon codes. This redemption type helps to track the number of coupons issued to customers through the vendor system.

4. Cart Promotion rewards: These are promotions created in Capillary.

h. Vendor and vendor redemption

In Vendor redemption, you can configure rewards linked to a particular vendor. You can also configure multiple actions in a single vendor redemption, for example, one to check if the customer has points and another to issue the reward.

❗️

Note:

Ensure that an external points system (e.g., Bonus Link) is configured when enabling external points redemption at the organization level. If external points APIs are not configured, the "Create Reward" option in the UI will remain disabled.

Begin by creating the reward partners. Navigate to the rewards vendor section

1. Click on the plus icon and assign a name to your reward partner, such as "target". Assign key-value pairs to the target. These will be used in all vendor redemptions created in subsequent steps. You can add frequently used fields as key-value pairs here. Then, click on save and create the vendor.

2. With the vendor created, select "target" and create vendor redemptions. Vendor redemption under vendor means specific APIs for the target will be called, created as a partner reward, and later linked to the catalog item.

3. Click on the plus icon and assign a name to your vendor redemption. Choose the type of reward, such as miles, cash wallet, cashback card, discount, charity games, vouchers, sweepstakes, auction, etc.

4. Actions are the APIs that will be called to issue this particular reward. Assign an execution order to the actions.

5. Provide the API URL for the vendor and specify the API type.

6. Add the request body. Specify the redemption value and mobile number as variable here which will be passed in the request of issue reward call.

7. API headers contain authentication details and content-type. Enter the authorization in the API headers and save them by clicking on the + icon. Add more API headers as needed and save them.

8. Context keys contain the response of the vendor. Specify the fields to return in the response. Enter "voucher" as a mandatory param if storing any code or unique id. Provide the path of the response as value for that particular field.

9. Select the response value needed in the issue reward response block and click on save to save the vendor redemption.

10. Create as many vendor redemptions as needed under a particular reward vendor.

11. Once the vendor redemptions are created, return to the reward creation and create a new reward and select the vendor and vendor redemption to be linked to this reward.

👍

Note

There is no limit on the number of rewards you can create.

Example 1 for vendor redemptions

Example 2 for vendor redemptions

i. start and end date of the redemption period. While creating the reward, start date must be in the future.

j. Geographies - Select the country where the reward is applicable. This is a metadata for the reward. You can define these in the Geography section in Marvel.

k. Name - Enter a unique name for the reward.

l. Description - Provide a brief description of the reward and its benefits.

m. Reward Image - Upload an image that represents the reward. Only one reward image can be linked to a reward in a single language.

n. Thumbnail Image - Upload a thumbnail image for the reward. Only one thumbnail image can be linked to a reward in a single language.

o. Terms and Conditions - Provide the terms and conditions associated with the reward.

4. You can also define the name, description, reward image, thumbnail image, terms and conditions in multiple languages for a particular reward. Create the languages in the languages section of Marvel and use them while creating a reward.

5. Points Vendor: Brands can either use Capillary as the points vendor or use their own loyalty platform or partnered platform and do the configuration here in the Points vendor section of Marvel. This allows brands to use rewards catalog even if they don’t use Capillary as their loyalty product.

6. Enable this option to define third party vendors for points redemption in the Points vendor section of Marvel.

7. Once you have filled in all the required fields, click on the Save button to create the reward.

Use cases

1. Intouch Rewards - Coupons & Cart Promotions

• Get a 20% discount upto 100 on your next transactions.
• Redeem 500 points and get this offer

2. External or Vendor based rewards

• Get 10 AirCap miles for every 10000 points you redeems
• Get a recharge of 100 for 500 points

Points to Note

1. If a reward is enabled, then it will be returned in the get call. To filter out the rewards which are enabled but start date is in future, app layer can control this.
2. In case of vendor rewards, vendors should support the reversal of rewards issued.
3. Subscription section is present in Marvel UI but it is not functional.

API documentation for Rewards Catalog

You can find the API documentation here