Reward system

Glossary

Reward system
System designed to provide partners with the ability to incentivize users to spend real currency in the in-game stores.
Reward chain
A set of steps that a user has to complete in order to receive a reward.
Step
A step in the reward chain at which the user, after accumulating the required number of value points, receives the reward.
Value points
Points that show the user’s progress in the reward system.
Reward
An item received by the user after accumulating a set number of value points.

How it works

The reward system gives you the opportunity to incentivize users who regularly purchase items in the in-game store with real currency. In this case, users receive additional motivation to use the in-game store or web store.

You can create reward chains by giving out rewards for a certain amount of real currency spent. There can be several chains in the game. The maximum length of one chain is 31 steps. Each step has an execution condition — to gain a given number of value points that show the user’s progress in the reward system.

Note
You can give out free items to users and give out value points in addition to them. Accumulated value points motivate users to earn more points by purchasing items with real currency.

At each step, the user can receive from 1 to 10 rewards.

You can reward users by giving out the following item types:

  • virtual items
  • virtual currency
  • virtual currency packages
  • bundles

Unauthorized users can see reward chains, but not their own progress. The number of earned value points and progress in the reward system are displayed to the user after authorization.

User flow

  1. The user goes to the site.
  2. The user sees the item catalog, available rewards, and the number of value points that can be received for the purchase of each item.
  3. User logs in or signs up on the site.
  4. The user sees their progress in the reward system and can move up the reward chains by earning value points for purchasing items.

How to get it

To set up a reward system, you will need the following details:

  • start and end dates of the reward system

Note
If there is no end date, the reward system will run indefinitely.

  • an image, description, SKUs, and names of value points that enable progress in the reward chain
  • the number of value points and items in the reward chain

See the examples below.

Reward chain:

DescriptionExampleLimitations
NameXsolla bonus systemCharacter limit — 35.
Explanatory textCompleting each step gives you unique rewards. Collect shards and get access to even cooler rewards!Character limit — 175.
Period01.05.2023 — 31.05.2023
Image size1065 x 515 px
Step of reward chain:
DescriptionExampleLimitations
Step nameTier 1Character limit — 35.
Image size200 x 200 pxSupported formats: PNG, JPG.
The number of accumulated value points at which the user receives a reward25
List with item SKUs and the number of rewards that the user receives in this stepsword_1 x 1, coin_pack_50 x 2
Value points:
DescriptionExample
NameShard
Explanatory textTo get rewards, collect the shards.
SKUExampleSKU003
Image or its URLCrystal
Recommended value points price:
StepValue points
Step 15
Step 210
Step 315
Step 420
Step 530
Step 640
Step 760
Step 880
Step 9100
Step 10150
Step 11 and subsequent stepsPrevious step + 50
Value points given out for the purchase of certain goods:
DescriptionExample
Item SKU for the purchase of which value points are given outHelmet_1
The number of value points given out after the items’ purchase10
Implement on your side:
  • display of elements of the reward system in the store:
    • the number of value points that are awarded for purchasing items in the catalog
    • value points
    • steps
    • reward chains
    • the balance of the authorized user’s value points
    • rewards
  • integration of reward methods
Note

For the correct work of the reward system, your site must have user authorization set up in the catalog.

If you use the Web Shop or Site Builder, then you don’t have to implement displaying the elements of the reward system and integrating API methods on your side.

To set up the reward system, implement the following API methods:

Set up via Publisher Account

Before reward chain creation, you need to create value points.

Create value points

To create value points:

  1. Open your project in Publisher Account.
  2. Click Store in the side menu.
  3. In the Promotions and rewards pane, click:
    • Connect — if you don’t have promotions or rewards.
    • Configure – if you previously connected promotions or rewards.

  1. In the Rewards tab, click Create value points.

Note
If this is your first time setting up a reward system, use the how-to create a reward chain.

  1. Specify the following parameters:
    • Image (optional).
    • Unique value points SKU.
    • Value points name.

  1. Click Next.
  2. Click + and select a virtual item’s SKU and the amount of value points that user will receive per purchase.

Note

  1. Click Save.

Value points are created and displayed above the reward chains. If necessary, you can change them using the Edit button.

Create reward chain

To create the reward chain:

  1. Open your project in Publisher Account.
  2. In the side pane, click Store.
  3. In the Promotions and rewards pane, click:
    • Connect — if you don’t have promotions or rewards.
    • Configure — if you previously connected promotions or rewards.

  1. In the Rewards tab, click Create reward.

  1. Specify the following parameters:
    • Reward chain name.
    • Description.
    • In the drop-down list choose value points.

Note
When creating your first chain, you will first should create value points.

  1. Click Next.
  2. Specify the following parameters:
    • Step name.
    • Required amount of value points for claiming the reward.
    • Required amount of virtual items for step.

  1. Click Save.

Note
The value points for each level should be increasing.
The recommended maximum length of one chain is 31 steps.

  1. Click Next.

  1. Specify validity period of the reward chain.

  1. Click Save.

The reward chain is created and shown in a catalog.

To activate the reward chain:

  1. In the reward catalog, choose the reward chain.
  2. Click ••• and choose Activate in the drop-down list.

Set up via API calls

You can use the methods from the Admin subsection of the Reward chains & Value points method group to work with the reward system.

  1. Create the value points that give access to rewards in the rewards system via the Create value point API.
  2. Use the Set value points for items API to award value points to users after purchasing certain items.
  3. Create the reward system via the Create reward chain API.
  4. Switch on the reward system via the Toggle reward chain API.

You can change, disable, or delete the reward system and remove item value points.

Note
If you call the Delete value points from items API to remove value points from one or more items, value points will be removed from all items.
Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Rate this page
Rate this page
Is there anything we can improve?

Don’t want to answer

Thank you for your feedback!
Last updated: June 4, 2024

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!