RedeemCode

Redeem a code.

Note that if the optional codeType is not provided, the system assumes that codes <= 20 characters are shared ('multi-use') codes - while codes >= 25 characters are personal ('single-use') codes.

Service	Operation
redemptionCode	REDEEM_CODE

Usage

http://localhost:3000

C#

string scanCode = "a scan code";
string codeType = "a code type";
string customRedemptionInfo = "{}";
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.RedemptionCodeService.RedeemCode(scanCode, codeType, customRedemptionInfo, successCallback, failureCallback);

C++

const char *scanCode = "a scan code";
const char *codeType = "a code type";
const char *customRedemptionInfo = "{}";
_bc->getRedemptionCodeService()->redeemCode(scanCode, codeType, customRedemptionInfo, this);

Obj-C

NSString *scanCode = @"a scan code";
NSString *codeType = @"a code type";
NSString *customRedemptionInfo = @"{}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc redemptionCodeService] redeemCode:scanCode
                   codeType:codeType
       customRedemptionInfo:customRedemptionInfo
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String scanCode = "a scan code";
String codeType = "a code type";
String customRedemptionInfo = "{}";
this; // implements IServerCallback

_bc.getRedemptionCodeService().redeemCode(scanCode, codeType, customRedemptionInfo, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var scanCode = "a scan code";
var codeType = "a code type";
var customRedemptionInfo = {};

_bc.redemptionCode.redeemCode(scanCode, codeType, customRedemptionInfo, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  scanCode = "a scan code";
var  codeType = "a code type";
var  customRedemptionInfo = {};

ServerResponse result = await _bc.redemptionCodeService.redeemCode(scanCode:scanCode, codeType:codeType, customRedemptionInfo:customRedemptionInfo);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Roblox

local scanCode = "a scan code"
local codeType = "a code type"
local customRedemptionInfo = {}

local callback = function(result)
    if result.statusCode == 200 then
        print("Success")
    else
        print("Failed | " .. tostring(result.status))
    end
end

_bc:getRedemptionCodeService():redeemCode(scanCode, codeType, customRedemptionInfo, callback)

GDScript

N/A

Cloud Code

var scanCode = "a scan code";
var codeType = "a code type";
var customRedemptionInfo = {};
var redemptionCodeProxy = bridge.getRedemptionCodeServiceProxy();

var postResult = redemptionCodeProxy.redeemCode(scanCode, codeType, customRedemptionInfo);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "redemptionCode",
    "operation": "REDEEM_CODE",
    "data": {
        "scanCode": "the-scan-code",
        "codeType": "the-code-type",
        "customRedemptionInfo": {}
    }
}

JSON Response

{
    "data": {
        "gameId": "23782",
        "scanCode": "vfaok-yu7gy-y4ida-jhibz-rtikc",
        "codeType": "ct",
        "redemptionCodeId": "ea2db0da-ef7b-4390-b747-df2eafaba2a3",
        "version": 2,
        "codeState": "Redeemed",
        "customCodeInfo": {},
        "customRedemptionInfo": {},
        "redeemedByProfileId": "c5ecdbda-5f91-41a9-96aa-174f412f7657",
        "redeemedByProfileName": "",
        "invalidationReason": null,
        "createdAt": 1655757623392,
        "activatedAt": 1655757623392,
        "redeemedAt": 1655758430895,
        "invalidatedAt": null,
        "updatedAt": 1655757623392
    },
    "status": 200
}

Common Error Code

Status Codes

Code	Name	Description
40395	REDEMPTION_CODE_NOT_FOUND	The specified code was not found
40398	REDEMPTION_CODE_NOT_ACTIVE	The specified code is not active
40399	REDEMPTION_CODE_TYPE_NOT_FOUND	The specified code type was not found
40401	REDEMPTION_CODE_REDEEMED	The code has already been redeemed
40402	REDEMPTION_CODE_REDEEMED_BY_SELF	The code has already been redeemed by the calling user
40403	REDEMPTION_CODE_REDEEMED_BY_OTHER	The code has already been redeemed by another user

Method Parameters

Parameter	Description
scanCode	The code to redeem. Sometimes referred to as the Promo Code in the Design Portal.
codeType	The type of code. Corresponds to the Campaign Name in the Design Portal.
jsonCustomRedemptionInfo	Optional - A JSON string containing custom redemption data