Create redemption (Admin)

Token exchange system facilitating conversion between different token types and redemption for rewards. Provides flexible reward experiences through diverse redemption options.

Redemption Features:

•

Token Exchange:

Convert between different token types with exchange rates

•

Reward Catalog:

Browse available rewards for token redemption

•

Exchange Rules:

Configure conversion rates and redemption requirements

•

Partner Ecosystem:

Redemption options across business partner networks

•

Flexible Rewards:

Support for products, services, and digital rewards

Get redemption by ID

Request

Get specific redemption details by ID. Requires valid project API key.

Security

projectKey

Path

idstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/redemptions/{id}' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption details retrieved

Bodyapplication/json

idstringrequired

Redemption id

descriptionstring or nullrequired

Description of the redemption

namestring or nullrequired

Name of the redemption

imageUrlstring or nullrequired

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobject or nullrequired

The redemption type

type.namestringrequired

Redemption type name

type.descriptionstring

Redemption type description

type.imageUrlstring

Redemption type image url

type.idnumberrequired

Redemption type id

tokenUnitsArray of objects(TokenUnitDTO)required

The redemption tokens to be redeemed

tokenUnits[].idstringrequired

Token unit id

tokenUnits[].tokenobjectrequired

TokenDTO object

tokenUnits[].token.idstringrequired

Id of the token

tokenUnits[].token.contractAddressstringrequired

Address of the token

tokenUnits[].token.metadataArray of objects(TokenMetadataDTO)

Metadata of the token, this is optional and can be null in case of Point token

tokenUnits[].token.abiobjectrequired

this is the abi of the contract, this is the interface of the contract to interact with it

tokenUnits[].token.chainIdnumberrequired

this is the chain id of the chain where the token is deployed

tokenUnits[].token.abiUrlobjectrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

tokenUnits[].token.namestring

this is the name of the token contract

tokenUnits[].token.symbolstring

this is the symbol of the token contract, this is optional and can be null

tokenUnits[].token.decimalsnumber

this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)

tokenUnits[].token.isActivebooleanrequired

This can be used to enable or disable the token

tokenUnits[].token.isGallerybooleanrequired

This can be used to enable or disable the token for gallery

tokenUnits[].token.typestringrequired

This is the underlying web3 native type of the token contract

Enum"ERC20""ERC1155""ERC721"

tokenUnits[].tokenMetadataIncrementalIdnumber or null

token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted

tokenUnits[].amountnumberrequired

Token unit amount is the amount of tokens that the user will receive when aquiring the token unit

tokenUnits[].maxAmountnumber or null

Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc

ordernumber or nullrequired

The order of the redemption

supplyobject or null

The available supply of the redemption

maxPerUserobjectrequired

The maximum redemption per user

minUserStatusTypeobject or nullrequired

The minimum user status type to redeem the redemption

minUserStatusType.namestringrequired

User Status Type name

minUserStatusType.descriptionstring

User Status Type description

minUserStatusType.minTokenBalancenumberrequired

User Status Type eligible Token Addresses

minUserStatusType.discountPercentagenumberrequired

User Status Type discount Rate in percentage

minUserStatusType.imageUrlstring

User Status Type image Url

minUserStatusType.idnumberrequired

User Status Type id

minUserStatusType.eligibleTokenAddressesArray of stringsrequired

User Status Type eligible Token Addresses

countryCodeRestrictionsobject

Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])

Example: ["NOT_ES","FR"]

tagsArray of stringsrequired

Redemption tags

Default []

Response

application/json

{
  "id": "string",
  "description": "string",
  "name": "string",
  "imageUrl": "string",
  "isActive": true,
  "creditTokenAmount": 0,
  "type": {
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "id": 0
  },
  "tokenUnits": [
    { … }
  ],
  "order": 0,
  "supply": {
    "available": 0,
    "total": 0
  },
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  },
  "countryCodeRestrictions": [
    "NOT_ES",
    "FR"
  ],
  "tags": []
}

Update redemption (Admin)

Request

Update existing redemption information. Replaces PUT /redemption/admin/{id}

Security

authJWT

Path

idstringrequired

Bodyapplication/jsonrequired

creditTokenAmountnumber

The amount of credit tokens needed to redeem the redemption tokens

descriptionstring or null

Description of the redemption

namestring

Name of the redemption

imageUrlstring or null

Image url of the redemption

redemptionTypeIdnumber or null

Redemption type id

minUserStatusTypeIdnumber or null

min user status type id to redeem the redemption

maxTotalSupplynumber or null

The maximum total supply of the redemption

ordernumber or null

The order of the redemption

maxPerUsernumber or null

The maximum redemption per user

countryCodeRestrictionsArray of strings or null

Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])

Example: ["NOT_ES","FR"]

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/redemptions/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "creditTokenAmount": 0,
    "description": "string",
    "name": "string",
    "imageUrl": "string",
    "redemptionTypeId": 0,
    "minUserStatusTypeId": 0,
    "maxTotalSupply": 0,
    "order": 0,
    "maxPerUser": 0,
    "countryCodeRestrictions": [
      "NOT_ES",
      "FR"
    ]
  }'

Responses

Redemption updated successfully

Bodyapplication/json

idstringrequired

Redemption id

descriptionstring or nullrequired

Description of the redemption

namestring or nullrequired

Name of the redemption

imageUrlstring or nullrequired

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobject or nullrequired

The redemption type

type.namestringrequired

Redemption type name

type.descriptionstring

Redemption type description

type.imageUrlstring

Redemption type image url

type.idnumberrequired

Redemption type id

tokenUnitsArray of objects(TokenUnitDTO)required

The redemption tokens to be redeemed

tokenUnits[].idstringrequired

Token unit id

tokenUnits[].tokenobjectrequired

TokenDTO object

tokenUnits[].token.idstringrequired

Id of the token

tokenUnits[].token.contractAddressstringrequired

Address of the token

tokenUnits[].token.metadataArray of objects(TokenMetadataDTO)

Metadata of the token, this is optional and can be null in case of Point token

tokenUnits[].token.abiobjectrequired

this is the abi of the contract, this is the interface of the contract to interact with it

tokenUnits[].token.chainIdnumberrequired

this is the chain id of the chain where the token is deployed

tokenUnits[].token.abiUrlobjectrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

tokenUnits[].token.namestring

this is the name of the token contract

tokenUnits[].token.symbolstring

this is the symbol of the token contract, this is optional and can be null

tokenUnits[].token.decimalsnumber

this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)

tokenUnits[].token.isActivebooleanrequired

This can be used to enable or disable the token

tokenUnits[].token.isGallerybooleanrequired

This can be used to enable or disable the token for gallery

tokenUnits[].token.typestringrequired

This is the underlying web3 native type of the token contract

Enum"ERC20""ERC1155""ERC721"

tokenUnits[].tokenMetadataIncrementalIdnumber or null

token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted

tokenUnits[].amountnumberrequired

Token unit amount is the amount of tokens that the user will receive when aquiring the token unit

tokenUnits[].maxAmountnumber or null

Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc

ordernumber or nullrequired

The order of the redemption

supplyobject or null

The available supply of the redemption

maxPerUserobjectrequired

The maximum redemption per user

minUserStatusTypeobject or nullrequired

The minimum user status type to redeem the redemption

minUserStatusType.namestringrequired

User Status Type name

minUserStatusType.descriptionstring

User Status Type description

minUserStatusType.minTokenBalancenumberrequired

User Status Type eligible Token Addresses

minUserStatusType.discountPercentagenumberrequired

User Status Type discount Rate in percentage

minUserStatusType.imageUrlstring

User Status Type image Url

minUserStatusType.idnumberrequired

User Status Type id

minUserStatusType.eligibleTokenAddressesArray of stringsrequired

User Status Type eligible Token Addresses

countryCodeRestrictionsobject

Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])

Example: ["NOT_ES","FR"]

tagsArray of stringsrequired

Redemption tags

Default []

Response

application/json

{
  "id": "string",
  "description": "string",
  "name": "string",
  "imageUrl": "string",
  "isActive": true,
  "creditTokenAmount": 0,
  "type": {
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "id": 0
  },
  "tokenUnits": [
    { … }
  ],
  "order": 0,
  "supply": {
    "available": 0,
    "total": 0
  },
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  },
  "countryCodeRestrictions": [
    "NOT_ES",
    "FR"
  ],
  "tags": []
}

Delete redemption (Admin)

Request

Permanently delete a redemption. Replaces DELETE /redemption/admin/{id}

Security

authJWT

Path

idstringrequired

curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger/redemptions/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Redemption deleted successfully

Bodyapplication/json

boolean

Response

application/json

true

Get redemption available supply

Request

Get the available supply count for a specific redemption. Used for inventory display.

Security

projectKey

Path

idstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/supply' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Available supply count

Bodyapplication/json

availablenumber or nullrequired

Number of items available for supply. Null if unlimited.

totalnumber or nullrequired

Total number of items for supply. Null if unlimited.

Response

application/json

{
  "available": 0,
  "total": 0
}

Get redemptions (Intelligent Access)

Request

Intelligent endpoint that adapts based on authentication: Public users get active redemptions only, Admin users get all redemptions with optional filtering. Consolidates GET /redemption and GET /redemption/admin

Security

projectKey

Query

activeboolean

Filter by active status (Admin only: true=active, false=inactive, omit=all). Ignored for public access.

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/redemptions?active=true' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemptions retrieved based on access level

Bodyapplication/jsonArray [

idstringrequired

Redemption id

descriptionstring or nullrequired

Description of the redemption

namestring or nullrequired

Name of the redemption

imageUrlstring or nullrequired

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobject or nullrequired

The redemption type

type.namestringrequired

Redemption type name

type.descriptionstring

Redemption type description

type.imageUrlstring

Redemption type image url

type.idnumberrequired

Redemption type id

tokenUnitsArray of objects(TokenUnitDTO)required

The redemption tokens to be redeemed

tokenUnits[].idstringrequired

Token unit id

tokenUnits[].tokenobjectrequired

TokenDTO object

tokenUnits[].token.idstringrequired

Id of the token

tokenUnits[].token.contractAddressstringrequired

Address of the token

tokenUnits[].token.metadataArray of objects(TokenMetadataDTO)

Metadata of the token, this is optional and can be null in case of Point token

tokenUnits[].token.abiobjectrequired

this is the abi of the contract, this is the interface of the contract to interact with it

tokenUnits[].token.chainIdnumberrequired

this is the chain id of the chain where the token is deployed

tokenUnits[].token.abiUrlobjectrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

tokenUnits[].token.namestring

this is the name of the token contract

tokenUnits[].token.symbolstring

this is the symbol of the token contract, this is optional and can be null

tokenUnits[].token.decimalsnumber

this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)

tokenUnits[].token.isActivebooleanrequired

This can be used to enable or disable the token

tokenUnits[].token.isGallerybooleanrequired

This can be used to enable or disable the token for gallery

tokenUnits[].token.typestringrequired

This is the underlying web3 native type of the token contract

Enum"ERC20""ERC1155""ERC721"

tokenUnits[].tokenMetadataIncrementalIdnumber or null

token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted

tokenUnits[].amountnumberrequired

Token unit amount is the amount of tokens that the user will receive when aquiring the token unit

tokenUnits[].maxAmountnumber or null

Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc

ordernumber or nullrequired

The order of the redemption

supplyobject or null

The available supply of the redemption

maxPerUserobjectrequired

The maximum redemption per user

minUserStatusTypeobject or nullrequired

The minimum user status type to redeem the redemption

minUserStatusType.namestringrequired

User Status Type name

minUserStatusType.descriptionstring

User Status Type description

minUserStatusType.minTokenBalancenumberrequired

User Status Type eligible Token Addresses

minUserStatusType.discountPercentagenumberrequired

User Status Type discount Rate in percentage

minUserStatusType.imageUrlstring

User Status Type image Url

minUserStatusType.idnumberrequired

User Status Type id

minUserStatusType.eligibleTokenAddressesArray of stringsrequired

User Status Type eligible Token Addresses

countryCodeRestrictionsobject

Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])

Example: ["NOT_ES","FR"]

tagsArray of stringsrequired

Redemption tags

Default []

]

Response

application/json

[
  {
    "id": "string",
    "description": "string",
    "name": "string",
    "imageUrl": "string",
    "isActive": true,
    "creditTokenAmount": 0,
    "type": { … },
    "tokenUnits": [ … ],
    "order": 0,
    "supply": { … },
    "maxPerUser": {},
    "minUserStatusType": { … },
    "countryCodeRestrictions": [ … ],
    "tags": []
  }
]