Redemptions

Retrieve redemption history, if any, for a given wallet_address.

get

Invoke this endpoint to return an array of rewards that were redeemed while associated with a specified wallet address.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

wallet_addressstringRequired

the wallet address

Responses

200

OK

application/json

get

/wallets/{wallet_address}/redemptions

HTTPcURLJavaScriptPython

GET /partner-api/wallets/{wallet_address}/redemptions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "redemptions": [
    {
      "date": 1,
      "token_id": "text",
      "description": "text",
      "code": "text"
    }
  ]
}

Generate a redemption code for a given reward by providing the wallet_address, token_id, and reward_id.

post

Utilize this endpoint to generate a redemption code for a given reward.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

wallet_addressstringRequired

the wallet address

Body

application/x-www-form-urlencoded

reward_idstringRequired

the reward uuid

token_idstringRequired

the token id

Responses

200

OK

application/json

401

Could not generate code due to wallet_address not owning token.

404

Could not generate code due to invalid token_id, or reward_id.

post

/wallets/{wallet_address}/redemptions

HTTPcURLJavaScriptPython

POST /partner-api/wallets/{wallet_address}/redemptions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 38

"reward_id='text'&token_id='text'"

{
  "redemption": {
    "uuid": "text",
    "code": "text",
    "promo_code": "text",
    "state": "text",
    "expires_at": 1
  }
}