Redemption

PERS-api docs (1.7.2)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://api.pers.ninja/v1.7/

Introduction

Introducing PERS (Phygital Experience Rewards System) the ultimate SaaS of Loyalty & Reward System. Connect PERS API to your system and get ready to create multi-projects, with your own dashboard and independent database, while ensuring users data confidentiality. This structure enables:

  • Interoperable Rewards
  • Boost Customer Engagement
  • Simplified Management
  • Effortless Integration
  • Security and Privacy
  • Data-Driven Strategy PERS System

Setup Flow

This diagram illustrates the comprehensive flow of creating and connecting various components within the SaaS PERS ecosystem. It outlines the interactions and dependencies between Tokens, Campaigns, Redemptions, Purchase, and Business entities. API Flow

Claim Campaign

The Claim System Flow in SaaS PERS outlines the process through which rewards and tokens can be claimed by different entities within the system. This flow ensures that the claiming process is secure, efficient, and flexible, catering to various use cases and integration requirements. Claim System Flow This flow ensures that the process of claiming rewards is adaptable to various scenarios, making it seamless for system administrators, business partners, and end-users to interact with the reward system efficiently.

Tenant

Operations

Token

Operations

Campaign

Operations

Redemption

Operations

Description

The Redemption module facilitates the exchange rules of one type of token for another, providing a flexible and rewarding experience for users. This module is essential for maintaining the value and utility of tokens within the SaaS PERS ecosystem. Users can redeem their tokens for various rewards, including products, services, or other token types, thus enhancing their engagement and satisfaction.
The Redemption module supports a streamlined and efficient redemption process, ensuring that users can easily and quickly access their desired rewards that are previously listed on the system. By offering diverse redemption options, this module helps businesses maintain a vibrant and attractive rewards program for their business and together with the partners ecosystem.
Redemption Module

Get all active redemptions

Request

Get all active redemptions

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

Responses

Redemptions

Bodyapplication/jsonArray [
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

]
Response
application/json
[
  {
    "id": "string",
    "description": "string",
    "name": "string",
    "imageUrl": "string",
    "isActive": true,
    "creditTokenAmount": 0,
    "type": { … },
    "tokenUnits": [ … ],
    "maxTotalSupply": {},
    "availableSupply": {},
    "maxPerUser": {},
    "minUserStatusType": { … }
  }
]

ADMIN: Get all redemptions

Request

ADMIN: Get all redemptions

Query
activestring

Filter by active status

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

Responses

Redemptions

Bodyapplication/jsonArray [
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

]
Response
application/json
[
  {
    "id": "string",
    "description": "string",
    "name": "string",
    "imageUrl": "string",
    "isActive": true,
    "creditTokenAmount": 0,
    "type": { … },
    "tokenUnits": [ … ],
    "maxTotalSupply": {},
    "availableSupply": {},
    "maxPerUser": {},
    "minUserStatusType": { … }
  }
]

ADMIN: Create a new redemption

Request

Create a new redemption

Bodyapplication/jsonrequired
creditTokenAmountnumber

The amount of credit tokens needed to redeem the redemption tokens

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

redemptionTypeIdnumber

Redemption type id

minUserStatusTypeIdnumber

min user status type id to redeem the redemption

maxTotalSupplynumber

The maximum total supply of the redemption

maxPerUsernumber

The maximum redemption per user

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemption/admin \
  -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,
    "maxPerUser": 0
  }'

Responses

Redemption created

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

Get redemption types

Request

Get all redemption types

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/redemption/type \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption types

Bodyapplication/jsonArray [
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

]
Response
application/json
[
  {
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "id": 0
  }
]

Get redemption

Request

Get redemption by ID

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

Responses

Redemption

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Update redemption

Request

Update redemption information

Path
idstringrequired
Bodyapplication/jsonrequired
creditTokenAmountnumber

The amount of credit tokens needed to redeem the redemption tokens

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

redemptionTypeIdnumber

Redemption type id

minUserStatusTypeIdnumber

min user status type id to redeem the redemption

maxTotalSupplynumber

The maximum total supply of the redemption

maxPerUsernumber

The maximum redemption per user

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/redemption/admin/{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,
    "maxPerUser": 0
  }'

Responses

Redemption updated

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Delete redemption

Request

Delete redemption

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

Responses

Redemption deleted

Bodyapplication/json
boolean
Response
application/json
true

ADMIN: Activate redemption

Request

Activate redemption

Path
idstringrequired
curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/toggle-active' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Redemption activated

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Create redemption token unit

Request

Create redemption token unit

Path
idstringrequired
Bodyapplication/jsonrequired
tokenIdstringrequired

Token id

tokenMetadataIncrementalIdnumber

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

amountnumberrequired

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

maxAmountnumber

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

curl -i -X POST \
  'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/token-units' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenId": "string",
    "tokenMetadataIncrementalId": 0,
    "amount": 0,
    "maxAmount": 0
  }'

Responses

Redemption token unit updated

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Update redemption token unit

Request

Update redemption token unit

Path
idstringrequired
tokenUnitIdstringrequired
Bodyapplication/jsonrequired
tokenIdstringrequired

Token id

tokenMetadataIncrementalIdnumber

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

amountnumberrequired

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

maxAmountnumber

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

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/token-units/{tokenUnitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenId": "string",
    "tokenMetadataIncrementalId": 0,
    "amount": 0,
    "maxAmount": 0
  }'

Responses

Redemption token unit updated

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Remove redemption token unit

Request

Remove redemption token unit

Path
idstringrequired
tokenUnitIdstringrequired
curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/token-units/{tokenUnitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Redemption token unit removed

Bodyapplication/json
idstring

Redemption id

descriptionstring

Description of the redemption

namestring

Name of the redemption

imageUrlstring

Image url of the redemption

isActivebooleanrequired

Redemptio is active

creditTokenAmountnumberrequired

The amount of credit tokens needed to redeem the redemption tokens

typeobjectrequired

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 stringsrequired

The redemption tokens to be redeemed

maxTotalSupplyobject

The maximum total supply of the redemption

availableSupplyobject

The available supply of the redemption

maxPerUserobject

The maximum redemption per user

minUserStatusTypeobject

The minimum user status type to redeem the redemption

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": [
    "string"
  ],
  "maxTotalSupply": {},
  "availableSupply": {},
  "maxPerUser": {},
  "minUserStatusType": {
    "name": "string",
    "description": "string",
    "minTokenBalance": 0,
    "discountPercentage": 0,
    "imageUrl": "string",
    "id": 0,
    "eligibleTokenAddresses": [ … ]
  }
}

ADMIN: Create a new redemption type

Request

Create a new redemption type

Bodyapplication/jsonrequired
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemption/admin/type \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "imageUrl": "string"
  }'

Responses

Redemption type created

Bodyapplication/json
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

Response
application/json
{
  "name": "string",
  "description": "string",
  "imageUrl": "string",
  "id": 0
}

AUTH USER: Redeem a redemption

Request

Redeem a redemption

Bodyapplication/jsonrequired
redemptionIdstringrequired

The redemption id

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemption/auth/redeem \
  -H 'Content-Type: application/json' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "redemptionId": "string"
  }'

Responses

Redemption redeemed

Bodyapplication/json
idstringrequired

The id of the redemption user redeem

userIdstringrequired

The user id that is claiming the redemption

redemptionIdstringrequired

The redemption that the user is redeeming

transactionIdsArray of stringsrequired

The transaction ids that resulted from the user redeeming the redemption

transactionsArray of stringsrequired

The transactions that resulted from the user redeeming the redemption

Response
application/json
{
  "id": "string",
  "userId": "string",
  "redemptionId": "string",
  "transactionIds": [
    "string"
  ],
  "transactions": [
    "string"
  ]
}

AUT USER: Get all redemption user redeems

Request

Get all redemption user redeems

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/redemption/auth/redeem \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption user redeems

Bodyapplication/jsonArray [
idstringrequired

The id of the redemption user redeem

userIdstringrequired

The user id that is claiming the redemption

redemptionIdstringrequired

The redemption that the user is redeeming

transactionIdsArray of stringsrequired

The transaction ids that resulted from the user redeeming the redemption

]
Response
application/json
[
  {
    "id": "string",
    "userId": "string",
    "redemptionId": "string",
    "transactionIds": [ … ]
  }
]

Get redemption redeems amount available

Request

Get redemption redeems amount available

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

Responses

Redemption redeems amount available

Bodyapplication/json
number
Response
application/json
0

Purchase

Operations

Business

Operations

Transaction

Operations

User

User endpoints

Operations

Admin

Operations

Auth

Operations

Web3 Contract

Operations

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations