Reward Bank Configuration Guide

Prerequisites

Before configuring the Reward Bank, ensure the following requirements are met:

Integration Steps

Reward Bank Extension Configuration

1. Install the Reward Bank Extension:

   • Navigate to the Partners page > Extensions in your Extole account
   • Locate and install the Reward Bank Extension
   
   

2. Add and Configure Collectible Rewards:

   Collectible rewards are set up and managed only within the Reward Bank extension. If a reward supplier is removed from the system, any rewards issued by that supplier will no longer be available for customers to redeem. Existing rewards can be updated, or new ones can be added as needed.

   You will use these rewards later on in your campaigns to link them to the rewardable events. See the "Update Program" section for more details on how to integrate these rewards into your promotional strategies.

   • Assign a unique name to each reward; Include the reward value to differentiate (e.g., "Collectible Reward $15")
   • Add value and choose the denomination that aligns with your program flow.
   • Enable the reward by toggling the "Enable" switch
   • Dynamic Value (Optional):
     Enable the dynamic toggle for percentage-based rewards (e.g., earning a 10% gift card commission on a purchase).
     Configure the cashback percentage, and set the minimum and maximum dynamic reward amounts that a user can earn per transaction. Please ensure the maximum is set to a valid amount—if it stays at the default value of 0, the user will receive a reward of 0.
     The reward value will be rounded to two decimal places.

   

   
   

3. Select Redemption Options:

   Choose previously configured dynamic rewards for user reward selection.

   An example of the dynamic reward configuration:

   

4. Configure Redemption Parameters:

   Value Limits:

   Set minimum and maximum redemption amounts. These are based on the dollar amount of rewards (calculated by dividing the points by the ratio) rather than the points themselves.
   Best Practice: Align with brand limits (e.g., $2,000 for Amazon gift cards)
   Setting to 0 disables specific limits.

   Redemption Rate:

   Define the ratio of earned reward value to dollars, which by default is 1:1, meaning 1 point equals 1 dollar.

   Example: With a 10-point ratio, users earn $1 for every 10 points

   

5. Customize Redemption Center Appearance:

   Use available variables to customize the appearance of the Redemption Center. The configuration options are available directly from the extension page.

   

6. Customize Redemption Emails:

   Update email templates to align with your design preferences.
   Redemption emails are sent after a user redeems a reward to confirm the redemption.
   Note: For Tremendous rewards, the emails require additional customization. Please submit a request for assistance to the Support Team.

7. Save Changes:

   Scroll to the top and save all configuration modifications

Update Program

8. Add Collectible Rewards to the Campaign:

   Link collectible rewards to specific rewardable actions in your campaigns from the 'Rules' section of your campaign. For more details on how to add or update the rewards, refer to Configuring the Rules of Your Program

9. Update Earned Reward Emails (Optional):

   Update the email link to direct users to the Reward Bank
   If you have multiple banks, please contact the Extole Support Team to configure the email links to target the correct integration (for more details, refer to the Multiple Reward Banks: section).
   JWT (JSON Web Tokens) can be used to authenticate users to the Reward Bank via email. Set an appropriate expiration timeframe for the tokens—typically between 1 to 3 years, depending on your reward program’s objectives. For assistance with JWT configuration and email integration, please contact Extole Support.

10. Publish the campaign.

Access Reward Bank

To access the reward bank, you would just call as a verified consumer the zones configured on the reward bank:
Example links:
https://test.extole.io/zone/bankable_rewards_redemption_center(embeddable version)

https://test.extole.io/zone/embedded_bankable_rewards_redemption_center(standalone page)

Multiple Reward Banks:

For different programs and varying reward types, set up multiple Reward Bank extensions. Give each Reward Bank a unique name to make identification easier.

When using multiple integrations, include target=campaign_id:<REWARD_BANK_CAMPAIGN_ID> in the links leading to the Reward Bank to ensure correct functionality.

Example link:
https://test.extole.io/zone/bankable_rewards_redemption_center?target=campaign_id:<CAMPAIGN_ID>&jwt=<JWT_TOKEN>

Reporting

Run the following reports to track Reward Bank activity:

Reward Bank Redeemed Rewards: Includes the rewards that have been redeemed, along with the associated collectible rewards.

Reward Bank Rewards Audit: Provides a detailed log of all collectible Reward Bank rewards, including their current statuses and history.

Reward Bank Rewards Summary: Offers an overview of the total reward activity, summarizing key metrics and redemption trends.

Headless Integration

For advanced integration scenarios, use the following Reward Bank API endpoints via the Extole Customer API.

To successfully call these endpoints, replace theclient with your program domain. For example, if Test Company were to call this endpoint, the URL would be:https://testcompany.extole.io/zone/bankable_rewards.
You can find your program domain in the Tech Center of the My Extole .

Retrieve Bankable Rewards

A verified JWT or access token is required to retrieve the bankable reward.

GET <https://client.extole.io/zone/bankable_rewards>
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <VERIFIED CONSUMER ACCESS TOKEN>' \

Example of Response

[
  {  
    "eligible_rewards": [
      {
        "reward_id": "a1cb349f29057e12025d7a73",  
        "reward_supplier_id": "0c50221129ae1d7231637ae0",
        "face_value": "10.00",  
        "face_value_type": "POINTS"  
      },
      {
        "reward_id": "f8de452d70123a34019b6c8d",  
        "reward_supplier_id": "0c50221129ae1d7231637ae0",
        "face_value": "10.00",  
        "face_value_type": "POINTS"  
      },
    ],  
    "redemption_suppliers": [  
      {  
        "reward_supplier_id": "b6da278e30069f11018e6b96",  
        "name": "Reward 1",  
        "type": "ACCOUNT_CREDIT"  
      },  
      {  
        "reward_supplier_id": "b3e4f4bbb7965e08269f9302",  
        "name": "Reward 2",  
        "type": "ACCOUNT_CREDIT"  
      }  
    ],  
    "redemption_history": [
       {
        "reward_id": "c3d9b56f70481e2301f7a4b2",  
        "reward_supplier_id": "b6da278e30069f11018e6b96",
        "face_value": "20.00",  
        "face_value_type": "USD"  
      }
    ],  
    "reward_parameters": {  
      "face_value_type": [  
        "USD"  
      ],  
      "max_amount": 1000,  
      "min_amount": 0,  
      "ratio_of_value_to_dollars": 1  
    }  
  }
]

Redeem Bankable Rewards

A verified JWT or access token is required to retrieve the bankable reward.

POST <https://client.extole.io/api/v6/events>
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <VERIFIED CONSUMER ACCESS TOKEN>' \

Body:

{
    "event_name": "redeem_rewards",
    "data": {
        "rewards": ["<REWARD ID TO REDEEM>"],
        "reward_supplier_id": "<REWARD SUPPLIER ID USED FOR REDEMPTION>"
     }
}

Example of Response

[
  {  
		"id":"7436077304245789573" 
  }
]

Appendix:

Makegood Events Compatibility

The Reward Bank does not support makegood events created from the Create Event page.

Alternative Methods for Issuing Additional Rewards:

• Use API events
• Use file-based events
• Use v9 flow makegoods

Forcing Makegood Events Compatibility:

To ensure the makegood events compatible with the Reward Bank, use prehandlers to update the "sandbox" parameter:

Prehandler JavaScript Action:

var sandbox = context.getProcessedRawEvent().getData().get('sandbox');

if (sandbox != null && (sandbox.toLowerCase().indexOf('campaign') > -1 || sandbox.toLowerCase().indexOf('CAMPAIGN') > -1) && sandbox.toLowerCase().indexOf('production') > -1) {
    var extractedId = sandbox.match(/\d+/)[0];
    context.log(" extractedId ----------->" + extractedId);
    context.getEventBuilder().removeData(sandbox);
    context.getEventBuilder().addData('sandbox', 'production-production');
    context.getEventBuilder().addData('target', 'campaign_id:' + extractedId);
    context.getEventBuilder().addData('journey.campaign_id', extractedId);
}

Notifications

Subscribe to notifications to monitor the redemption process: