Rewards

Overview

Rewards are the incentives that participants can redeem points for. Depending on how redemption rules are configured, a reward item may be digital money, physical items, or e-vouchers. A Rewards Partner is a service that provides rewards to participants.

Note: The terms redemption provider, redemption item and account redemption item have been renamed to rewards partner, rewards and redemption respectively for improved clarity and intuitiveness. However, to maintain backward compatibility, the original terms continue to be used in the GovRewards APIs.

Rewards Partners

To reward your participants, GovRewards integrates with multiple rewards partners, ensuring a smooth experience when redeeming rewards.

There are currently two rewards partners:

GovSupply
GovWallet - Temporarily unavailable

GovSupply

Before you can redeem rewards through GovRewards, you must first create the corresponding items in your GovSupply campaign. The process differs depending on whether you are creating physical or digital rewards.

Remember to set the available quantity for the reward item on the GovRewards side as well, to ensure proper inventory management across both systems.

Physical Reward Items

To create a physical reward item in GovSupply:

From the GovSupply campaign page, click Items from the left sidebar, then click Add Item.
Fill in the details:
- Item Category Name
- Does item have an unique ID number? → Choose No
- Does item have variants? → Choose No (Variants are not supported at the moment)
- Initial Balance (Remember to set the quantity at the GovRewards side as well)
Click Next.
Click Save and Add.

Digital Reward Items

To create a digital reward item in GovSupply:

From the GovSupply campaign page, click Items from the left sidebar, then click Add Item.
Fill in the details:
- Item Category Name
- Does item have an unique ID number? → Choose Yes
For ID Number, configure the following:
- Field Name: (Keep as default)
- Field Validation → Choose Extended Alphanumeric
- Allow scanning? → Choose No
In Customise Fields, add the following fields:
- Add Field 1:
  - Is the field mandatory? → Choose Yes
  - Field Name: GR_REDEMPTION_EXTERNAL_REFERENCE_ID
  - Field Validation → Choose Extended Alphanumeric
  - Allow scanning? → Choose No
Click Next.
Click Save and Add.

The GR_REDEMPTION_EXTERNAL_REFERENCE_ID field allows GovRewards to pass its reference ID to GovSupply. As a campaign owner, this enables you to correlate transactions in GovSupply reports with redemptions in GovRewards when reviewing transaction histories.

Adding Voucher Fields to Digital Reward Items

After creating a digital reward item in GovSupply, you can add custom fields:

From the GovSupply campaign page, click Items from the left sidebar, then select the digital reward item you created.
Click Add Item ID.
In Customise Fields, add the following fields (or add other custom fields as needed for your reward). If you want the voucher code and/or voucher link to be displayed on GovRewards frontend applications, use either or both of these fields:
- Add Field 1 (for voucher URL):
  - Field Name: voucherURL
  - Field Value
- Add Field 2 (for voucher code):
  - Field Name: voucherCode
  - Field Value
Click Save.

GovSupply Configuration

To configure GovRewards to disburse items through GovSupply, follow these steps:

Using the GovRewards API

Call the GovRewards Add Redemption Provider API with the following payload:

{
  "provider": "GOVSUPPLY",
  "providerConfig": {
    "apiKey": "<API_KEY from GovSupply>",
    "campaignId": "<Campaign ID retrieved from GovSupply>"
  }
}

Call the GovRewards Add Redemption Item API with the following payload as an example:

{
  "sid": "<Short ID of the redemption item>",
  "name": "<Name of Redemption Item>",
  "description": "<Description of Redemption Item. Optional>",
  "pointsToRedeem": 50,
  "type": "POINTS_TO_ITEM",
  "provider": "GOVSUPPLY",
  "providerItemConfig": {
     "categoryId": "<Corresponding Category ID in GovSupply>",
     "redeemOnDisbursement": "<Set to true for digital rewards, false for physical rewards>"
  }
}

Note: type must be POINTS_TO_ITEM, provider must be GOVSUPPLY, and providerItemConfig must be present for GovSupply redemption items.

Using the GovRewards Admin Portal

From your campaign page, click Reward Items from the left sidebar, then click Add Item.
Fill in the reward item details:
- Item Name
- Description (Optional)
- Redemption Period
Click Next.
Click + Connect GovSupply Campaign.
Follow the instructions under GovSupply Steps to generate a GovSupply API key. Upload the CSV file with the GovSupply API key. Then, click Save and Continue.
If successful, you will see that your GovRewards campaign has been connected to your GovSupply campaign.
Select an item category from your GovSupply campaign. For Reward Type, select either Physical Gift or Digital Reward, then click Next.
Set the initial available quantity of your reward item. You will be able to adjust this quantity later on. Note that this should be less than or equal to the quantity available in GovSupply.
Set points and redemption limit per participant.
Click Save and Add

Reports

Tenants