Set up and configure code redemptions

Last updated on June 14, 2023

Overview

AccelByte Gaming Services (AGS) features a code redemption service that allows you to create redeemable codes and distribute them to your players so that they can unlock in-game items or other entitlements. Codes can be redeemed in the game or on your website.

Topics this guide covers

• Creating a code redemption campaign.
• Adding an item to a code redemption.
• Creating codes for redemption.
• How to download codes.
• Generating a history of redeemed codes.

Prerequisites

• Access to AccelByte Admin Portal.
• Appropriate namespaces are created.

Create a code redemption campaign

1. Go to the E-commerce menu in the Admin Portal. You need to switch to the desired namespace where you want code redemptions configured. Open the Code Redemption menu.

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

3. The Add Code Redemption form will appear. Here, fill in the fields as seen below:

   • Input a name for your campaign in the Code Redemption Name field.
   • In the Status dropdown, select ACTIVE if you want to start the campaign right away, or select INACTIVE if you don’t want it to start yet.
   • Input the number of times a code can be redeemed in the Max Redeem Code field.
   • Input the number of times a player can redeem codes from this campaign in the Max User Redemption field.
   • Input the number of codes you want to create in the Max Code Redemption field.
   • Choose the Redeem Type. The available redemption type is Item.
   • Select the Start Time of your code redemption campaign.
   • Select the End Time of your code redemption campaign.

4. Once the code redemption is added, you need to add items that will be redeemed by the player.

Add an item to a code redemption

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

• You will be prompted Add items by searching for and selecting an item that you want to add from a dropdown menu. After selecting an item, click Add to add the item into the code redemption.

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

• Status is an indication of whether the item is active or inactive in the stores.

Subscription time

You can now grant subscription time to players via single-use redeemable codes. Players can redeem their code via their account page. The time value of their code will be added to their total subscription time.

1. To add a subscription time code, scroll down to the Subscription Time section and click Add Subscription.

2. The Add Subscription prompt will appear. Fill in the required information:

   • Select the subscription plan. Make sure you’ve already created a subscription in your catalog.
   • Input the total number of subscription days in the Subscription Duration (days) box. This is the number of days that will be added to a player’s total subscription when they redeem their code.

3. Once completed, click Add. Your new subscription will be added to the list.

Create a code

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

2. Input the quantity codes you want to create and click Add to add that amount of codes.

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

Download codes

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

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

View the redeem history of codes

1. In your code redemption, switch to the Redeem History tab. You can search the history by User ID, or you can search by Code to get the history based on the code.