Codes

Codes are used to credit users with $TOKENs. Each code has two required parameters, a reward amount and total number of times the code can be redeemed.

The code object

This object represents a code. It lets you retrieve information about the code including amount, status, redemptions, and redemptions remaining.

Retrieve code

Get token code status

GEThttp://localhost:8080/v1/codes/{codeId}

Path parameters

codeId*string

Response

200

Ok

Body

application/json

status*enum

ACTIVEINACTIVE

redemptions*number

reward*number

number*integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/codes/{codeId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "ACTIVE",
  "redemptions": 0,
  "reward": 0,
  "number": 0
}

Redeem code for user

For a more seamless UX, you can instantly credit a user by redeeming a code on their behalf.

Redeem a token code for a user

POSThttp://localhost:8080/v1/codes/redemptions

Body

application/json

user*UserIdentifierDto (any of)

UserWithEmailDto (object)UserWithEthAddressDto (object)UserWithIdDto (object)

codeId*string

Response

200

Ok

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/codes/redemptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user": {},
      "codeId": "text"
    }),
});
const data = await response.json();