PERS-api docs (1.8.1)
https://docs.pers.ninja/_mock/swagger-spec/
https://api.pers.ninja/v1.8/
Introduction
Introducing PERS (Phygital Experience Rewards System) the ultimate SaaS of Loyalty & Reward System. Connect PERS API to your system and get ready to create multi-projects, with your own dashboard and independent database, while ensuring users data confidentiality. This structure enables:
- Interoperable Rewards
- Boost Customer Engagement
- Simplified Management
- Effortless Integration
- Security and Privacy
- Data-Driven Strategy
Claim Campaign
The Claim System Flow in SaaS PERS outlines the process through which rewards and tokens can be claimed by different entities within the system. This flow ensures that the claiming process is secure, efficient, and flexible, catering to various use cases and integration requirements. 
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:
- Program Management: Define and oversee the overall structure and rules of the reward program.
- Dashboard Access: Utilize a comprehensive dashboard to monitor and manage all aspects of the reward system.
- Data Confidentiality: Ensure that all user data within the system is handled with the highest level of confidentiality and security.
- Customization: Tailor the reward system to align with the business's unique objectives and customer engagement strategies.
- Integration: Seamlessly integrate the reward system with existing business systems and processes through the PERS API.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant
https://api.pers.ninja/v1.8/tenant
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/admin/api-key
https://api.pers.ninja/v1.8/tenant/admin/api-key
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/admin/jwt
https://api.pers.ninja/v1.8/tenant/admin/jwt
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/admin
https://api.pers.ninja/v1.8/tenant/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/login-token
https://api.pers.ninja/v1.8/tenant/login-token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/tenant/login-token \
-H 'x-project-key: YOUR_API_KEY_HERE'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/public
https://api.pers.ninja/v1.8/tenant/public
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/tenant/client-config
https://api.pers.ninja/v1.8/tenant/client-config
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin
https://api.pers.ninja/v1.8/token/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/{id}/mainnet/{contractAddress}/chain/{chainId}
https://api.pers.ninja/v1.8/token/admin/{id}/mainnet/{contractAddress}/chain/{chainId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/{id}/toggle-active
https://api.pers.ninja/v1.8/token/admin/{id}/toggle-active
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/{id}
https://api.pers.ninja/v1.8/token/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/{id}/metadata
https://api.pers.ninja/v1.8/token/admin/{id}/metadata
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/metadata/{id}/toggle-active
https://api.pers.ninja/v1.8/token/admin/metadata/{id}/toggle-active
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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:
- ERC20: used for credits
- ERC721: used for stamps and NFTs
- ERC1155: used for rewards
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/admin/type
https://api.pers.ninja/v1.8/token/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/type
https://api.pers.ninja/v1.8/token/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/token/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "nativeTokenType": "ERC20", "name": "string", "imageUrl": "string", "description": "string" } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/address/{contractAddress}
https://api.pers.ninja/v1.8/token/address/{contractAddress}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/token/address/{contractAddress}?contractTokenId=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token
https://api.pers.ninja/v1.8/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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" } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/credit
https://api.pers.ninja/v1.8/token/credit
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/reward
https://api.pers.ninja/v1.8/token/reward
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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" } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/token/status
https://api.pers.ninja/v1.8/token/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Integration with External APIs: The Campaign module supports connections to over 7,000 external APIs, including CMS, CRM, Email Marketing, Events, Social Media, Product Sales, and AI. This extensive integration capability allows businesses to automate and streamline their campaign processes. Connect with Zapier
- Tailored Strategies: Businesses can design campaigns to align with specific goals, such as marketing objectives, sales targets, sustainability and environmental initiatives, and productivity improvements. This flexibility ensures that campaigns are not only engaging but also strategically impactful.
- Dynamic Campaign Models: The module supports various campaign types, each designed to incentivize different user behaviors. Whether it's a promotional campaign to boost short-term sales or a loyalty program to foster long-term customer engagement, the Campaign module can handle it.
- User Engagement: By participating in campaigns, users can earn tokens for completing specific actions. These actions can range from social media interactions and product purchases to attending events and more, depending on the campaign's objectives.
- Data-Driven Optimization: With robust analytics and reporting features, businesses can monitor the performance of their campaigns in real-time. This data-driven approach allows for continuous optimization, ensuring that campaigns achieve their desired outcomes.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign
https://api.pers.ninja/v1.8/campaign
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin
https://api.pers.ninja/v1.8/campaign/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin
https://api.pers.ninja/v1.8/campaign/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/{id}
https://api.pers.ninja/v1.8/campaign/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}
https://api.pers.ninja/v1.8/campaign/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}
https://api.pers.ninja/v1.8/campaign/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/activate
https://api.pers.ninja/v1.8/campaign/admin/{id}/activate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/environment
https://api.pers.ninja/v1.8/campaign/admin/{id}/environment
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units
https://api.pers.ninja/v1.8/campaign/admin/{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-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v1.8/campaign/admin/{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-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v1.8/campaign/admin/{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-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/trigger/{triggerId}
https://api.pers.ninja/v1.8/campaign/admin/{id}/trigger/{triggerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement
https://api.pers.ninja/v1.8/campaign/admin/{id}/business-engagement
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement/{businessEngagementId}
https://api.pers.ninja/v1.8/campaign/admin/{id}/business-engagement/{businessEngagementId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement/{businessEngagementId}
https://api.pers.ninja/v1.8/campaign/admin/{id}/business-engagement/{businessEngagementId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/trigger/all
https://api.pers.ninja/v1.8/campaign/trigger/all
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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": 0, "id": "string", "conditions": [ … ] } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger
https://api.pers.ninja/v1.8/campaign/admin/trigger
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": 0
}'{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "id": "string", "conditions": [ "string" ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{id}
https://api.pers.ninja/v1.8/campaign/admin/trigger/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": 0
}'{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": {}, "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "id": "string", "conditions": [ "string" ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{id}
https://api.pers.ninja/v1.8/campaign/admin/trigger/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{triggerId}/condition/{conditionId}
https://api.pers.ninja/v1.8/campaign/admin/trigger/{triggerId}/condition/{conditionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": 0, "id": "string", "conditions": [ "string" ] }
Trigger condition type
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger-condition
https://api.pers.ninja/v1.8/campaign/admin/trigger-condition
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger-condition/{id}
https://api.pers.ninja/v1.8/campaign/admin/trigger-condition/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/system/claim
https://api.pers.ninja/v1.8/campaign/system/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": {}, "customData": {}, "publicProfile": {}, "isActive": true }, "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 } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/business/claim
https://api.pers.ninja/v1.8/campaign/business/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": {}, "customData": {}, "publicProfile": {}, "isActive": true }, "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 } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/claim
https://api.pers.ninja/v1.8/campaign/auth/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": {}, "customData": {}, "publicProfile": {}, "isActive": true }, "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 } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/claim
https://api.pers.ninja/v1.8/campaign/auth/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/{campaignId}/claim
https://api.pers.ninja/v1.8/campaign/auth/{campaignId}/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim
https://api.pers.ninja/v1.8/campaign/admin/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{campaignId}/claim
https://api.pers.ninja/v1.8/campaign/admin/{campaignId}/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim/user/{userId}
https://api.pers.ninja/v1.8/campaign/admin/claim/user/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim/business/{businessId}
https://api.pers.ninja/v1.8/campaign/admin/claim/business/{businessId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption
https://api.pers.ninja/v1.8/redemption
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/redemption \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "id": "string", "description": "string", "name": "string", "imageUrl": "string", "isActive": true, "creditTokenAmount": 0, "type": { … }, "tokenUnits": [ … ], "maxTotalSupply": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin
https://api.pers.ninja/v1.8/redemption/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/redemption/admin?active=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'[ { "id": "string", "description": "string", "name": "string", "imageUrl": "string", "isActive": true, "creditTokenAmount": 0, "type": { … }, "tokenUnits": [ … ], "maxTotalSupply": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { … } } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin
https://api.pers.ninja/v1.8/redemption/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/type
https://api.pers.ninja/v1.8/redemption/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/redemption/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "name": "string", "description": "string", "imageUrl": "string", "id": 0 } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/{id}
https://api.pers.ninja/v1.8/redemption/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}
https://api.pers.ninja/v1.8/redemption/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}
https://api.pers.ninja/v1.8/redemption/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}/toggle-active
https://api.pers.ninja/v1.8/redemption/admin/{id}/toggle-active
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": 0, "availableSupply": 0, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}/token-units
https://api.pers.ninja/v1.8/redemption/admin/{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-spec/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": 0, "availableSupply": 0, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v1.8/redemption/admin/{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-spec/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": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/{id}/token-units/{tokenUnitId}
https://api.pers.ninja/v1.8/redemption/admin/{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-spec/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": 0, "availableSupply": 0, "maxPerUser": {}, "minUserStatusType": { "name": "string", "description": "string", "minTokenBalance": 0, "discountPercentage": 0, "imageUrl": "string", "id": 0, "eligibleTokenAddresses": [ … ] } }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/admin/type
https://api.pers.ninja/v1.8/redemption/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/auth/redeem
https://api.pers.ninja/v1.8/redemption/auth/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/auth/redeem
https://api.pers.ninja/v1.8/redemption/auth/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/redemption/auth/redeem \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "id": "string", "userId": "string", "redemptionId": "string", "transactionIds": [ … ] } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/redemption/{id}/available-supply
https://api.pers.ninja/v1.8/redemption/{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-spec/redemption/{id}/available-supply' \
-H 'x-project-key: YOUR_API_KEY_HERE'
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/stripe-webhook
https://api.pers.ninja/v1.8/purchase/stripe-webhook
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/purchase/stripe-webhook- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/token
https://api.pers.ninja/v1.8/purchase/admin/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/token/{id}
https://api.pers.ninja/v1.8/purchase/admin/token/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/token/{id}
https://api.pers.ninja/v1.8/purchase/admin/token/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/token/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/type
https://api.pers.ninja/v1.8/purchase/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conversionRate": 0,
"currency": "eur"
}'{ "conversionRate": 0, "currency": "eur" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/donation/type
https://api.pers.ninja/v1.8/purchase/admin/donation/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/purchase/admin/donation/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"percentage": 0,
"id": 0
}'{ "percentage": 0, "id": 0 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/donation/type
https://api.pers.ninja/v1.8/purchase/donation/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/purchase/donation/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "percentage": 0, "id": 0 } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/token
https://api.pers.ninja/v1.8/purchase/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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 } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/auth
https://api.pers.ninja/v1.8/purchase/auth
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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": {}, "customData": {}, "publicProfile": {}, "isActive": true }, "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": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/auth
https://api.pers.ninja/v1.8/purchase/auth
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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" } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/payment-intent
https://api.pers.ninja/v1.8/purchase/payment-intent
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/payment-intent/{paymentIntentId}
https://api.pers.ninja/v1.8/purchase/payment-intent/{paymentIntentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/purchase/payment-intent/{paymentIntentId}
https://api.pers.ninja/v1.8/purchase/payment-intent/{paymentIntentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/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:
- Partner Management: Onboard and manage partners who participate in the reward system.
- Collaboration: Facilitate collaboration between the tenant and business partners to create cohesive and engaging reward campaigns.
- Incentive Structures: Develop and implement incentive structures that motivate partners to actively contribute to the reward system.
- Performance Tracking: Monitor the performance and engagement levels of business partners within the reward ecosystem.
- Community Building: Foster a sense of community among business participants to enhance the overall value and appeal of the reward program.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type
https://api.pers.ninja/v1.8/business/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type
https://api.pers.ninja/v1.8/business/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type/{id}
https://api.pers.ninja/v1.8/business/admin/type/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin/type/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/type
https://api.pers.ninja/v1.8/business/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/business/type \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/business/me
https://api.pers.ninja/v1.8/business/business/me
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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": [ { … } ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business
https://api.pers.ninja/v1.8/business
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin
https://api.pers.ninja/v1.8/business/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin
https://api.pers.ninja/v1.8/business/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/account/{accountAddress}
https://api.pers.ninja/v1.8/business/account/{accountAddress}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/{id}
https://api.pers.ninja/v1.8/business/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/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 }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}/api-key
https://api.pers.ninja/v1.8/business/admin/{id}/api-key
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}
https://api.pers.ninja/v1.8/business/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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": [ { … } ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/activate/{id}
https://api.pers.ninja/v1.8/business/admin/activate/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/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
- Mint credits: Mint credits to a user's account.
- Transfer credits: Transfer credits from one user account to another.
- Burn token: Remove tokens from a user's account.
- Mint token: Add new tokens to a user's account.
- Authorize transaction: Ensure the user has the necessary permissions and balance for a transaction.
- Get balance: Retrieve the balance of a user's account, including both credits and tokens. Key Transaction Features
- Secure Transactions: Ensures all transactions are secure and authorized, protecting user data and maintaining the integrity of the reward system.
- Comprehensive Management: Supports a variety of transactional operations, providing flexibility in how credits and tokens are managed within the system.
- Real-Time Processing: All transactions are processed in real-time, ensuring that user balances are updated instantly.
- Integration Capabilities: Easily integrates with other modules and external systems to provide a seamless transactional experience.
The Transaction module is essential for the efficient and secure management of credits and tokens, enhancing user engagement and satisfaction within the SaaS PERS system.
User identifier, this is the user´s main reference to identify the user
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/business/mint/credits
https://api.pers.ninja/v1.8/transaction/business/mint/credits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/mint/credits
https://api.pers.ninja/v1.8/transaction/admin/mint/credits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/mint/credits \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/business/transfer/credits
https://api.pers.ninja/v1.8/transaction/business/transfer/credits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/transfer/credits
https://api.pers.ninja/v1.8/transaction/admin/transfer/credits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/transfer/credits \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"userEmail": "string",
"userIdentifier": "id",
"amount": 0
}'Transaction complete
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/transfer/credits
https://api.pers.ninja/v1.8/transaction/auth/transfer/credits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "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
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/transfer/token
https://api.pers.ninja/v1.8/transaction/auth/transfer/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/burn/token
https://api.pers.ninja/v1.8/transaction/auth/burn/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
Transaction token metadata incremental id
Transaction token metadata incremental id
Transaction token metadata incremental id
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/mint/token
https://api.pers.ninja/v1.8/transaction/admin/mint/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/mint/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0,
"tokenAddress": "string",
"tokenMetadataIncrementalId": "string",
"chainId": 0,
"senderAddress": "string",
"recipientAddress": "string"
}'Transaction complete
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/mint/token/url
https://api.pers.ninja/v1.8/transaction/admin/mint/token/url
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
Transaction token metadata incremental id
Transaction token metadata incremental id
Transaction token metadata incremental id
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/burn/token
https://api.pers.ninja/v1.8/transaction/admin/burn/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/burn/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0,
"tokenAddress": "string",
"tokenMetadataIncrementalId": "string",
"chainId": 0,
"senderAddress": "string",
"recipientAddress": "string"
}'Transaction complete
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/sender
https://api.pers.ninja/v1.8/transaction/auth/sender
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/sender \
-H 'x-project-key: YOUR_API_KEY_HERE'Transactions by user as sender
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/recipient
https://api.pers.ninja/v1.8/transaction/auth/recipient
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/transaction/auth/recipient \
-H 'x-project-key: YOUR_API_KEY_HERE'Transactions by user as recipeint
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/sender
https://api.pers.ninja/v1.8/transaction/admin/sender
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin/recipient
https://api.pers.ninja/v1.8/transaction/admin/recipient
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/admin
https://api.pers.ninja/v1.8/transaction/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/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
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} } ]
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/transaction/{id}
https://api.pers.ninja/v1.8/transaction/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/transaction/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Transaction
Transaction token contract id, this is the blockchain contract id of the token
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", "contractTokenId": {}, "tokenType": "ERC20", "senderAddress": "string", "recipientAddress": {}, "transactionHash": {}, "type": "MINT", "triggerProcessType": "PURCHASE", "triggerProcessId": {}, "status": "created", "createdAt": {}, "updatedAt": {} }