Code Redemptions

Overview

You can create code redemption where you distribute promotional codes that unlock items or other entitlements to your players. Codes can be redeemed in the Player Portal, Launcher, and in the game itself.

When you create a code redemption, you can choose how many codes to create, how many times each code can be redeemed, and how many times each player can redeem a code. After the code redemption has been launched, you can access the code redemption history in the Admin Portal.

Codes generated by 3rd party platforms such as Steam can also be listed for sale in your catalog.

Tutorials

Create a Code Redemption

You can create a Code Redemption in Admin Portal or use our Swagger. But, before creating a code redemption, make sure you are authorized and have registered your clients.

Create a Code Redemption Using API

  1. Use the Create Campaign: POST /admin/namespaces/{namespace}/campaigns endpoint.

  2. Input the Publisher Namespace.

  3. Fill out the Request Body.

    • Input the code redemption Type. The available type is Redemption.** **
    • Input the code redemption Name. For example, if you want to create a free coin redemption, you can input Free Coin May. This name will be visible to Players in the Player Portal and Launcher to show that in May there will be a free coin redemption.
    • Input the Description of the code redemption.
    • Input the Tags with contextual information about the code redemption.
    • Select the Status of the code redemption. Choose Active to make the code redemption active so players can participate and Inactive to deactivate the code redemption.
    • Input how many times each code can be redeemed in the maxRedeemCountPerCode field.
    • Input how many times each player can redeem a code in the maxRedeemCountPerCodePerUser field.
    • Input how many times each player will be able to redeem a code in the maxRedeemCountPerCampaignPerUser field.
    • Input the maxSaleCount to define how many codes can be sold in the store. For example, if you set 1000 and the code is already sold 1000 then the user can't purchase any more code.
    • Input the Redemption Type you want to create in the code redemption. The available redemption type is Item.

    Fill in the information about the Items below.

    • Input the Item ID.
    • Input the Item Name.
    • Input the Quantity of the items you want to set in the code redemption.
  4. On a successful request, you will be able to create a code redemption.

Create a Code Redemption in Admin Portal

  1. In the Admin Portal, choose Publisher Namespace.

    campaign-management

  2. Go to the E-Commerce section and open the Code Redemption menu.

    campaign-management

  3. In the Code Redemption menu, click the Add Code Redemption button to create a new code redemption.

    campaign-management

  4. The Add Code Redemption form will appear. Here, fill all the fields with the following information as a reference.

    campaign-management

    • Input the Code Redemption Name.
    • Select the Status of your code redemption.
    • Input the number of redemption for each code in the Max redeems per code field.
    • Input the number of redemptions for each Player in the Max redeems per user.
    • Choose the Redeem Type. The available Redemption type is Item.
  5. Once the code redemption is added, the next thing you have to do is to add items that will be redeemed by the player.

Add Item to a Code Redemption

Add Item to a Code Redemption Using API

  1. Use the Update Campaign: PUT /admin/namespaces/{namespace}/campaigns/{campaignId} endpoint.

  2. Input the Namespace with the Publisher Namespace.

  3. Input the Campaign ID. The campaign ID is automatically created when you create a campaign.

  4. Fill out the Item section in the Request Body.

    • Input the Item ID.
    • Input the Item Name.
    • Input the Quantity of the Item.
  5. On a successful response, you will be able to add Item to a Code Redemption.

Add Item to a Code Redemption in Admin Portal

  1. In your code redemption, go to Basic Information & Items tab, and in the Items section, click the Add Item button to add an item into your code redemption.

    campaign-management

  2. A modal will pop up and you need to find the item based on the Item ID. Once you’ve found the item, click Add. After that, the item details will appear, and once you’ve made sure it's the right item, click Add to add the item into a code redemption.

    campaign-management

  3. Once added, the item will appear in the item list.

    campaign-management

Create a Code

Create a Code Using API

  1. Use the Create Campaign Codes: POST /admin/namespaces/{namespace}/codes/campaigns/{campaignId} endpoint.

  2. Input the Namespace with the Publisher Namespace.

  3. Input the Campaign ID. The campaign ID is automatically created when you create a campaign.

  4. Fill out the Request Body.

    • Input the Quantity of the code, define how many code you want to generate in a Campaign.
  5. On a successful request, you will be able to create a code.

Create a Code in Admin Portal

  1. In your code redemption, switch to the Codes tab and click the Add Codes button to add code to your code redemption.

    campaign-management

  2. Input the Quantity of the code and click Add to add the amount of code.

    campaign-management

  3. Once your code is added, you can choose the Status of the code. If Enable is selected, the code can be redeemed by players, if it is Disable, the code will not be available for redeeming. For example, if you are going to start the code redemption, you need to Enable the status and when the code redemption is over, you can Disable the code.

    campaign-management

Download Codes

Download Codes Using API

  1. Use the Download Codes: GET /admin/namespaces/{namespace}/codes/campaigns/{campaignId}/codes.csv endpoint.
  2. Input the Namespace.
  3. Input the Campaign ID.
  4. Input the Batch of the Campaign in the batchNo field. This field is optional.
  5. On a successful request, you will be able to download the code.

Download Codes in Admin Portal

  1. In the Code Redemption sidebar menu, go to the Codes section and click Download Codes. Then, the download process will start immediately.

    campaign-management

  2. After the download is complete, you can open the file and see the code list you have created. Here, the file will be in .csv format.

    campaign-management

Get Redeemed Code History

Get Redeemed Code History Using API

  1. Use the Query Redeem History: GET /admin/namespaces/{namespace}/codes/campaigns/{campaignId}/history endpoint.
  2. Input the Namespace with the Publisher Namespace.
  3. Input the Campaign ID, e.g. 63a635938ffc4560b5b23731150414a6.

These following fields are optional.

  1. Input the User ID if you want to get a list of Redeemed Code History of a specific Player.
  2. Input the Code if you want to get a record of Code Redeemed by Players.

You can fill it in if you want to display pagination.

  1. Input the Offset if you want to skip numbers of data before showing the records.
  2. Input the Limit of the displayed data.
  3. After a successful request, you can see the redeemed history.

Get Redeemed Code History in Admin Portal

  1. In your Code Redemption, switch to the Redeem History tab, and you'll see the list of the redeem history. You can search the history by User ID to see the redeem history for a user or, you can search by Code to get the history based on the code.

    campaign-management

Related Concepts