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:
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. 
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.
The Tenant module in SaaS PERS represents the business or organization that leads the reward and loyalty program. As the primary administrator, the tenant has overarching control over the configuration and management of the loyalty and reward system. Key responsibilities and features for the tenant include:
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/tenant \
-H 'Content-Type: application/json' \
-d '{
"projectName": "string"
}'Tenant created
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Testnet project API key for tenant. Used in case of testnet project.
This is an optional field for any extra login requirements for your users.
JWT token for tenant admin user. This token is used to authenticate tenant admin user. It is generated when tenant is created. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.
{ "projectName": "string", "id": "string", "createdAt": "2019-08-24T14:15:22Z", "projectDescription": "string", "projectWebsite": "string", "projectEmail": "string", "projectImageUrl": "string", "projectApiKey": "string", "testnetProjectApiKey": "string", "stripeApiKey": "string", "stripeWebhookSecret": "string", "loginToken": "string", "allowJWTForUnauthenticatedUsers": true, "firebaseTenantId": "string", "jwt": "string", "apiPrivateKey": "string" }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/tenant/admin/api-key \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"keyName": "string"
}'Api key created
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Testnet project API key for tenant. Used in case of testnet project.
This is an optional field for any extra login requirements for your users.
JWT token for tenant admin user. This token is used to authenticate tenant admin user. It is generated when tenant is created. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.
{ "projectName": "string", "id": "string", "createdAt": "2019-08-24T14:15:22Z", "projectDescription": "string", "projectWebsite": "string", "projectEmail": "string", "projectImageUrl": "string", "projectApiKey": "string", "testnetProjectApiKey": "string", "stripeApiKey": "string", "stripeWebhookSecret": "string", "loginToken": "string", "allowJWTForUnauthenticatedUsers": true, "firebaseTenantId": "string", "jwt": "string", "apiPrivateKey": "string" }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/tenant/admin/jwt \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isTestnet": true
}'Api key created
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Testnet project API key for tenant. Used in case of testnet project.
This is an optional field for any extra login requirements for your users.
JWT token for tenant admin user. This token is used to authenticate tenant admin user. It is generated when tenant is created. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.
{ "projectName": "string", "id": "string", "createdAt": "2019-08-24T14:15:22Z", "projectDescription": "string", "projectWebsite": "string", "projectEmail": "string", "projectImageUrl": "string", "projectApiKey": "string", "testnetProjectApiKey": "string", "stripeApiKey": "string", "stripeWebhookSecret": "string", "loginToken": "string", "allowJWTForUnauthenticatedUsers": true, "firebaseTenantId": "string", "jwt": "string", "apiPrivateKey": "string" }
This is an optional field for any extra login requirements for your users.
curl -i -X PUT \
https://docs.pers.ninja/_mock/swagger/tenant/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"projectName": "My Project",
"projectDescription": "string",
"stripeApiKey": "string",
"stripeWebhookSecret": "string",
"stripePublishableKey": "string",
"loginToken": "string",
"allowJWTForUnauthenticatedUsers": true,
"firebaseTenantId": "string",
"projectWebsite": "string",
"projectEmail": "string",
"projectImageUrl": "string"
}'Tenant updated
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Unique identifier for tenant. This id is used to identify tenant in the system for client requests.
Testnet project API key for tenant. Used in case of testnet project.
This is an optional field for any extra login requirements for your users.
JWT token for tenant admin user. This token is used to authenticate tenant admin user. It is generated when tenant is created. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.
{ "projectName": "string", "id": "string", "createdAt": "2019-08-24T14:15:22Z", "projectDescription": "string", "projectWebsite": "string", "projectEmail": "string", "projectImageUrl": "string", "projectApiKey": "string", "testnetProjectApiKey": "string", "stripeApiKey": "string", "stripeWebhookSecret": "string", "loginToken": "string", "allowJWTForUnauthenticatedUsers": true, "firebaseTenantId": "string", "jwt": "string", "apiPrivateKey": "string" }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/tenant/login-token \
-H 'x-project-key: YOUR_API_KEY_HERE'curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/tenant/public \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "projectName": "string", "id": "string", "createdAt": "2019-08-24T14:15:22Z", "projectDescription": "string", "projectWebsite": "string", "projectEmail": "string", "projectImageUrl": "string" }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/tenant/client-config \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "projectName": "My Project", "id": "ererf-erf-erf-erf", "stripePublishableKey": "string", "firebaseTenantId": "string", "infuraApiKey": "string", "polyScanApiKey": "string" }
The ABI URL is the URL to the contract ABI. This is an optional field. If not provided, the contract ABI will be fetched from PERS instance depending on selected token type.
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/token/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"contractAddress": "string",
"abiUrl": "string",
"type": "ERC20",
"decimals": 0
}'Token created
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/mainnet/{contractAddress}/chain/{chainId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Mainnet token Address created
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/toggle-active' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Token toggled
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
This indicates if token should be included as a gallery. This is useful for ERC721 or ERC1155 tokens.
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isGallery": true,
"name": "string",
"symbol": "string"
}'Token updates
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/metadata' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"imageUrl": "string",
"externalUrl": "string",
"description": "string",
"name": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"animationUrl": "string",
"youtubeUrl": "string",
"creatorAccountAddress": "string",
"previewUrl": "string"
}'Token metadata created
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
{ "imageUrl": "string", "externalUrl": "string", "description": "string", "name": "string", "expiryDate": "2019-08-24T14:15:22Z", "animationUrl": "string", "youtubeUrl": "string", "creatorAccountAddress": "string", "previewUrl": "string", "id": "string", "animationWeb3StorageUrl": "string", "imageWeb3StorageUrl": "string", "web3StorageUrl": "string", "tokenMetadataIncrementalId": 0, "isActive": true }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/metadata/{id}/toggle-active' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Token metadata toggled
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
{ "imageUrl": "string", "externalUrl": "string", "description": "string", "name": "string", "expiryDate": "2019-08-24T14:15:22Z", "animationUrl": "string", "youtubeUrl": "string", "creatorAccountAddress": "string", "previewUrl": "string", "id": "string", "animationWeb3StorageUrl": "string", "imageWeb3StorageUrl": "string", "web3StorageUrl": "string", "tokenMetadataIncrementalId": 0, "isActive": true }
Token native Types:
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/token/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nativeTokenType": "ERC20",
"name": "string",
"imageUrl": "string",
"description": "string"
}'{ "nativeTokenType": "ERC20", "name": "string", "imageUrl": "string", "description": "string" }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/token/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "nativeTokenType": "ERC20", "name": "string", "imageUrl": "string", "description": "string" } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/token/credit \
-H 'x-project-key: YOUR_API_KEY_HERE'Credit token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token/reward?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Reward tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token/status?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Status tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]
The Campaign module in SaaS PERS enables the creation and management of multi-campaigns that users can participate in to earn tokens. This module supports a wide range of campaign types, including promotional, engagement, and loyalty campaigns, each designed to incentivize specific user behaviours. Campaigns are a strategic tool for boosting customer engagement and driving desired actions. With robust analytics and reporting features, the Campaign module allows businesses to monitor campaign performance and optimise their strategies for maximum impact. The flexibility of this module ensures that businesses can design campaigns tailored to their unique goals and customer demographics. 
Key Campaign Features
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/campaign \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ … ], "businessEngagements": [ … ], "createdAt": {}, "updatedAt": {} } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/admin?active=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'[ { "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ … ], "businessEngagements": [ … ], "createdAt": {}, "updatedAt": {} } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"beneficiaryAccountAddress": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"imageUrl": "string",
"externalUrl": "string"
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"beneficiaryAccountAddress": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"imageUrl": "string",
"externalUrl": "string"
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/activate' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/environment' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
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
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/token-units' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"tokenMetadataIncrementalId": 0,
"amount": 0,
"maxAmount": 0
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
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
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/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
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/token-units/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/trigger/{triggerId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
A short description of the business engagement, with indications what to do etc
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/business-engagement' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"businessIds": [
"string"
],
"shortDescription": "string",
"maxPerBussiness": 0,
"maxPerDay": 0
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
A short description of the business engagement, with indications what to do etc
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/business-engagement/{businessEngagementId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"businessIds": [
"string"
],
"shortDescription": "string",
"maxPerBussiness": 0,
"maxPerDay": 0
}'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{id}/business-engagement/{businessEngagementId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ "string" ], "businessEngagements": [ "string" ], "createdAt": {}, "updatedAt": {} }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/campaign/trigger/all \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": {}, "id": "string", "conditions": [ … ] } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"maxPerDay": 0,
"maxPerUser": 0,
"minCooldownSeconds": 0,
"maxGeoDistanceInMeters": 0,
"requiredUserInfo": {},
"triggerType": "CLAIM_BY_USER",
"maxMultiplier": 0,
"completionThreshold": {}
}'{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": {}, "id": "string", "conditions": [ "string" ] }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"maxPerDay": 0,
"maxPerUser": 0,
"minCooldownSeconds": 0,
"maxGeoDistanceInMeters": 0,
"requiredUserInfo": {},
"triggerType": "CLAIM_BY_USER",
"maxMultiplier": 0,
"completionThreshold": {}
}'{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": {}, "id": "string", "conditions": [ "string" ] }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger/{triggerId}/condition/{conditionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": {}, "id": "string", "conditions": [ "string" ] }
Trigger condition type
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger-condition \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conditionType": "EQUALS",
"value": {},
"key": "string",
"id": "string"
}'{ "conditionType": "EQUALS", "value": {}, "key": "string" }
Trigger condition type
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/trigger-condition/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conditionType": "EQUALS",
"value": {},
"key": "string",
"id": "string"
}'{ "conditionType": "EQUALS", "value": {}, "key": "string" }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/system/claim \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"campaignId": "string",
"conditionsData": {},
"multiplier": 0,
"businessId": "string",
"latitude": 0,
"longitude": 0,
"userIdentifier": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"id": "string",
"email": "string",
"instagramAccountId": "string",
"externalId": "string"
}'Campaign reward claimed
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
{ "id": "string", "createdAt": {}, "user": { "id": "string", "email": {}, "firstName": {}, "lastName": {}, "externalId": {}, "accountAddress": "string", "instagramAccountId": {}, "googleAccountName": {} }, "campaign": { "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ … ], "businessEngagements": [ … ], "createdAt": {}, "updatedAt": {} }, "business": { "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { … }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true } }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/business/claim \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"campaignId": "string",
"conditionsData": {},
"multiplier": 0,
"businessId": "string",
"latitude": 0,
"longitude": 0,
"userIdentifier": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"id": "string",
"email": "string",
"instagramAccountId": "string",
"externalId": "string"
}'Campaign reward claimed
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
{ "id": "string", "createdAt": {}, "user": { "id": "string", "email": {}, "firstName": {}, "lastName": {}, "externalId": {}, "accountAddress": "string", "instagramAccountId": {}, "googleAccountName": {} }, "campaign": { "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ … ], "businessEngagements": [ … ], "createdAt": {}, "updatedAt": {} }, "business": { "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { … }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true } }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign/auth/claim \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"campaignId": "string",
"conditionsData": {},
"multiplier": 0,
"businessId": "string",
"latitude": 0,
"longitude": 0
}'Campaign reward claimed
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
{ "id": "string", "createdAt": {}, "user": { "id": "string", "email": {}, "firstName": {}, "lastName": {}, "externalId": {}, "accountAddress": "string", "instagramAccountId": {}, "googleAccountName": {} }, "campaign": { "name": "string", "description": {}, "beneficiaryAccountAddress": {}, "startDate": {}, "endDate": {}, "imageUrl": {}, "externalUrl": {}, "id": "string", "isActive": true, "isTestnet": true, "trigger": {}, "tokenUnits": [ … ], "businessEngagements": [ … ], "createdAt": {}, "updatedAt": {} }, "business": { "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { … }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true } }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/campaign/auth/claim \
-H 'x-project-key: YOUR_API_KEY_HERE'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/auth/{campaignId}/claim' \
-H 'x-project-key: YOUR_API_KEY_HERE'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/campaign/admin/claim \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/{campaignId}/claim' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/claim/user/{userId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign/admin/claim/business/{businessId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Claim history
The user that is claiming the campaign
The campaign that the user is claiming
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign businesses: what businesses are involved in the campaign
[ { "id": "string", "createdAt": {}, "user": { … }, "campaign": { … }, "business": { … } } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/redemption \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "id": "string", "description": "string", "name": "string", "imageUrl": "string", "isActive": true, "creditTokenAmount": 0, "type": { … }, "tokenUnits": [ … ], "maxTotalSupply": {}, "availableSupply": {}, "maxPerUser": {}, "minUserStatusType": { … } } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemption/admin?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "id": "string", "description": "string", "name": "string", "imageUrl": "string", "isActive": true, "creditTokenAmount": 0, "type": { … }, "tokenUnits": [ … ], "maxTotalSupply": {}, "availableSupply": {}, "maxPerUser": {}, "minUserStatusType": { … } } ]
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
}'{ "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": [ … ] } }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/redemption/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "name": "string", "description": "string", "imageUrl": "string", "id": 0 } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemption/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "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": [ … ] } }
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
}'{ "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": [ … ] } }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/toggle-active' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "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": [ … ] } }
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
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
}'{ "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": [ … ] } }
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
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
}'{ "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": [ … ] } }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/redemption/admin/{id}/token-units/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "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": [ … ] } }
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"
}'{ "name": "string", "description": "string", "imageUrl": "string", "id": 0 }
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"
}'{ "id": "string", "userId": "string", "redemptionId": "string", "transactionIds": [ "string" ], "transactions": [ "string" ] }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/redemption/auth/redeem \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "id": "string", "userId": "string", "redemptionId": "string", "transactionIds": [ … ] } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/redemption/{id}/available-supply' \
-H 'x-project-key: YOUR_API_KEY_HERE'
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/stripe-webhookcurl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/admin/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"description": "string",
"purchaseTypeId": 0
}'Token created
Token
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 url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
Purchase Type
{ "id": "string", "description": "string", "token": { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }, "contractTokenId": {}, "purchaseType": { "conversionRate": 0, "currency": "eur", "id": 0 }, "isActive": true }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/purchase/admin/token/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"isActive": true
}'Token updated
Token
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 url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
Purchase Type
{ "id": "string", "description": "string", "token": { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }, "contractTokenId": {}, "purchaseType": { "conversionRate": 0, "currency": "eur", "id": 0 }, "isActive": true }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/purchase/admin/token/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conversionRate": 0,
"currency": "eur"
}'{ "conversionRate": 0, "currency": "eur" }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/admin/donation/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"percentage": 0,
"id": 0
}'{ "percentage": 0, "id": 0 }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/purchase/donation/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "percentage": 0, "id": 0 } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/purchase/token?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Active Purchase Tokens
Token
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 url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
Purchase Type
[ { "id": "string", "description": "string", "token": { … }, "contractTokenId": {}, "purchaseType": { … }, "isActive": true } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/auth \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"quantity": 0,
"paymentIntentId": "string",
"purchaseTokenId": "string",
"donationTypeId": 0,
"donationAccountAddress": "string"
}'Purchase Created
Purchase Token
Token
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
Purchase Type
User
Business
The id of the business, this is unique and will be used to identify the business.
The email of the business, this is unique and will be used to identify the business.
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The website of the business, this is the website that will be shown to the public.
The image of the business, this is the image that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "stripePaymentIntentId": "string", "status": {}, "amount": 0, "currency": "eur", "quantity": 0, "purchaseToken": { "id": "string", "description": "string", "token": { … }, "contractTokenId": {}, "purchaseType": { … }, "isActive": true }, "user": { "id": "string", "email": {}, "firstName": {}, "lastName": {}, "externalId": {}, "accountAddress": "string", "instagramAccountId": {}, "googleAccountName": {} }, "business": { "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { … }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }, "donationAccountAddress": "string", "donationType": { "percentage": 0, "id": 0 }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "paymentClientSecret": {} }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/purchase/auth \
-H 'x-project-key: YOUR_API_KEY_HERE'Purchase found
Purchase Token
Token
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
Purchase Type
User
Business
The id of the business, this is unique and will be used to identify the business.
The email of the business, this is unique and will be used to identify the business.
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The website of the business, this is the website that will be shown to the public.
The image of the business, this is the image that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
[ { "id": "string", "stripePaymentIntentId": "string", "status": {}, "amount": 0, "currency": "eur", "quantity": 0, "purchaseToken": { … }, "user": { … }, "business": { … }, "donationAccountAddress": "string", "donationType": { … }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/purchase/payment-intent \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"amount": 0,
"currency": "string",
"receiptEmail": "string",
"description": "string"
}'{ "paymentClientSecret": {}, "paymentIntentId": "string" }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/purchase/payment-intent/{paymentIntentId}' \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"amount": 0,
"currency": "string",
"receiptEmail": "string",
"description": "string"
}'{ "paymentClientSecret": {}, "paymentIntentId": "string" }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/purchase/payment-intent/{paymentIntentId}' \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "paymentClientSecret": {}, "paymentIntentId": "string" }
The Business module encompasses all participants and partners involved in the reward system. This includes the partner community, such as vendors, service providers, artist community, commercial partners, public or private institutions and other entities that contribute to the reward ecosystem. Key features of the Business module include:
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/business/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"code": "string",
"iconUrl": "string"
}'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
curl -i -X PUT \
https://docs.pers.ninja/_mock/swagger/business/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"description": "string",
"code": "string",
"iconUrl": "string"
}'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/business/admin/type/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/business/type \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/business/business/me \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
The token balances of the business, this is the token balances that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "tokenBalances": [ { … } ] }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/business \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/business/admin?active=string&sanitize=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/business/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "string"
}'Business created
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "apiPrivateKey": "string" }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/business/account/{accountAddress}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/business/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/business/admin/{id}/api-key' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/business/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"businessLegalName": "string",
"displayName": "string",
"description": "string",
"shortDescription": "string",
"websiteUrl": "string",
"imageUrl": "string",
"streetAddress": "string",
"city": "string",
"postalCode": "string",
"coordsLatitude": 0,
"coordsLongitude": 0,
"businessTypeId": 0
}'Business created
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
The token balances of the business, this is the token balances that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "tokenBalances": [ { … } ] }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/business/admin/activate/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isActive": true,
"canMintToken": true,
"canChargeToken": true,
"canManageUsers": true,
"canReceiveDonation": true
}'Business account permissions updated
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
The Transaction module in SaaS PERS manages all transactional operations related to credits and tokens within the reward system. It ensures a smooth and secure flow of credits and tokens between users and the system.
API Endpoints
User identifier, this is the user´s main reference to identify the user
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/business/mint/credits \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
User identifier, this is the user´s main reference to identify the user
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/mint/credits \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
User identifier, this is the user´s main reference to identify the user
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/business/transfer/credits \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
User identifier, this is the user´s main reference to identify the user
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/transfer/credits \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
Token address, this is optional, if not provided, the default credit token will be used
Token metadata incremental id, this is optional, if not provided, will be set to null
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/auth/transfer/credits \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"businessId": "string",
"tokenAddress": "string",
"tokenMetadataIncrementalId": 0,
"chainId": 0,
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
Token address, this is optional, if not provided, the default credit token will be used
Token metadata incremental id, this is optional, if not provided, will be set to null
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/auth/transfer/token \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"businessId": "string",
"tokenAddress": "string",
"tokenMetadataIncrementalId": 0,
"chainId": 0,
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/auth/burn/token \
-H 'Content-Type: application/json' \
-H 'x-project-key: YOUR_API_KEY_HERE' \
-d '{
"tokenAddress": "string",
"chainId": 0,
"tokenMetadataIncrementalId": "string",
"amount": 0
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/mint/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0,
"tokenAddress": "string",
"tokenMetadataIncrementalId": {},
"chainId": 0,
"senderAddress": "string",
"recipientAddress": "string"
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/mint/token/url \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/user-data",
"amount": 0,
"tokenAddress": "string",
"tokenMetadataIncrementalId": {},
"chainId": 0,
"senderAddress": "string"
}'Transactions completed
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/burn/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0,
"tokenAddress": "string",
"tokenMetadataIncrementalId": {},
"chainId": 0,
"senderAddress": "string",
"recipientAddress": "string"
}'Transaction complete
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/transaction/auth/sender \
-H 'x-project-key: YOUR_API_KEY_HERE'Transactions by user as sender
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/transaction/auth/recipient \
-H 'x-project-key: YOUR_API_KEY_HERE'Transactions by user as recipeint
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/sender \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"userIdentifier": "id",
"accountAddress": "string",
"businessOrUserId": "string",
"accountType": "BUSINESS"
}'Transactions as sender
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/transaction/admin/recipient \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"userIdentifier": "id",
"accountAddress": "string",
"businessOrUserId": "string",
"accountType": "BUSINESS"
}'Transactions as recipient
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/transaction/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"userIdentifier": "id",
"accountAddress": "string",
"businessOrUserId": "string",
"accountType": "BUSINESS"
}'Transactions as recipient
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
[ { "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/transaction/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Transaction
Trigger process type
Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)
{ "amount": 0, "id": "string", "tokenAddress": "string", "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }