PERS-api docs (1.8.2)
https://docs.pers.ninja/_mock/swagger/
https://explorins-loyalty.ngrok.io/
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 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/transaction/business/mint/credits
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/mint/credits
https://explorins-loyalty.ngrok.io/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/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/transaction/business/transfer/credits
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/transfer/credits
https://explorins-loyalty.ngrok.io/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/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/transaction/auth/transfer/credits
https://explorins-loyalty.ngrok.io/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/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/transaction/auth/transfer/token
https://explorins-loyalty.ngrok.io/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/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/transaction/auth/burn/token
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/mint/token
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/mint/token/url
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/burn/token
https://explorins-loyalty.ngrok.io/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/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/transaction/auth/sender
https://explorins-loyalty.ngrok.io/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/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/transaction/auth/recipient
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/sender
https://explorins-loyalty.ngrok.io/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/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/transaction/admin/recipient
https://explorins-loyalty.ngrok.io/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/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/transaction/admin
https://explorins-loyalty.ngrok.io/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/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/transaction/{id}
https://explorins-loyalty.ngrok.io/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/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": {} }