Redeem game code by client

Digital Distribution Hub API

In-Game Store & Buy Button API

Overview

Download API definition

USER ATTRIBUTES

Admin

Personalized Catalog

BUNDLES

Admin

Catalog

CART & PAYMENT

Cart (client-side)

Cart (server-side)

Payment (client-side)

Payment (server-side)

Order

Free items

COMMON

Webhooks

Pre-Orders

Merchant

Catalog

Common regions

GAME KEYS

Catalog

Entitlement

get

Get list of games owned by user

post

Redeem game code by client

post

Grant entitlement (admin)

post

Revoke entitlement (admin)

Admin

PLAYER INVENTORY

Client

Management

Cross-Inventory

PROMOTIONS

Common

Coupons

Promo Codes

Unique catalog offers

Discounts

Bonuses

VIRTUAL ITEMS & CURRENCY

Admin

Catalog

Virtual Payment

NFT ITEMS

Admin

Catalog

LIMITS

Management

REWARD CHAINS & VALUE POINTS

Admin

Client

Pay Station API

Publisher Account API

Subscriptions API

Webhooks

Redeem game code by client

post/v2/project/{project_id}/entitlement/redeem

Grants entitlement by a provided game code.

Attention

You can redeem codes only for the DRM-free platform.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

Request Body schema: application/json

code required	string Game code.
sandbox	boolean Default: false Redeem game code in the sandbox mode. The option is available for those users who are specified in the list of company users.

Responses

201

Successful redemption.

403

Authorization header not sent.

404

Game code not found. Make sure the code and project_id are correct.

422

Invalid request.

Request samples

application/json

{"code": "AAAA-BBBB-CCCC-DDDD",
"sandbox": false
}

Response samples

application/json

{"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}