Get all available redemption types for client reference. Requires valid project API key.
PERS-api docs (2.0.2)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://api.pers.ninja/v2/
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
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/types
https://api.pers.ninja/v2/redemptions/types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/redemptions/types \
-H 'x-project-key: YOUR_API_KEY_HERE'Response
application/json
[ { "name": "string", "description": "string", "imageUrl": "string", "id": 0 } ]
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/types
https://api.pers.ninja/v2/redemptions/types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/redemptions/types \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"imageUrl": "string"
}'Response
application/json
{ "name": "string", "description": "string", "imageUrl": "string", "id": 0 }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}
https://api.pers.ninja/v2/redemptions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Redemption details retrieved
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}
https://api.pers.ninja/v2/redemptions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'Redemption updated successfully
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}
https://api.pers.ninja/v2/redemptions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/available-supply
https://api.pers.ninja/v2/redemptions/{id}/available-supply
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/available-supply' \
-H 'x-project-key: YOUR_API_KEY_HERE'- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/redeem
https://api.pers.ninja/v2/redemptions/{id}/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/redeem' \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"redemptionId": "7fe21afe-a95f-43e9-9df9-d4967b99c691"
}'Redemption executed successfully
The transaction ids that resulted from the user redeeming the redemption
Array [
Transaction token contract id, this is the blockchain contract id of the token
Trigger process type
Enum"PURCHASE""SPEND""TRANSFER""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION"
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
Transaction status
Enum"created""processing""pending_signature""broadcasted""succeeded""failed"
Sender entity type (user, business, system etc.)
Enum"user""business""tenant""system""external"
Recipient entity type (user, Business, system, etc.)
Enum"user""business""tenant""system""external"
Response
application/json
{ "id": "string", "userId": "string", "redemptionId": "string", "transactionIds": [ "string" ], "userCountryCode": "string", "transactions": [ [ … ] ] }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/me/history
https://api.pers.ninja/v2/redemptions/me/history
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/redemptions/me/history \
-H 'x-project-key: YOUR_API_KEY_HERE'Response
application/json
[ { "id": "string", "userId": "string", "redemptionId": "string", "transactionIds": [ … ], "userCountryCode": "string" } ]
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions
https://api.pers.ninja/v2/redemptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemptions?active=true' \
-H 'x-project-key: YOUR_API_KEY_HERE'Redemptions retrieved based on access level
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
Response
application/json
[ { "id": "string", "description": "string", "name": "string", "imageUrl": "string", "isActive": true, "creditTokenAmount": 0, "type": { … }, "tokenUnits": [ … ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { … }, "countryCodeRestrictions": [ … ], "tags": [] } ]
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions
https://api.pers.ninja/v2/redemptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/redemptions \
-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"
]
}'Redemption created successfully
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/status
https://api.pers.ninja/v2/redemptions/{id}/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/status' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Redemption status toggled
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
Bodyapplication/jsonrequired
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units
https://api.pers.ninja/v2/redemptions/{id}/token-units
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"tokenMetadataIncrementalId": 0,
"amount": 0,
"maxAmount": 0
}'Token unit added to redemption
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
Bodyapplication/jsonrequired
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v2/redemptions/{id}/token-units/{tokenUnitId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"tokenMetadataIncrementalId": 0,
"amount": 0,
"maxAmount": 0
}'Token unit updated successfully
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }
- Mock server
https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v2/redemptions/{id}/token-units/{tokenUnitId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/redemptions/{id}/token-units/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Token unit removed from redemption
The redemption tokens to be redeemed
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
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": [ { … } ], "maxTotalSupply": 0, "order": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] }, "countryCodeRestrictions": [ "NOT_ES", "FR" ], "tags": [] }