Transaction

PERS-api docs (1.7.2)

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

Introduction

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

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

Setup Flow

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

Claim Campaign

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

Tenant

Operations

Token

Operations

Campaign

Operations

Redemption

Operations

Purchase

Operations

Business

Operations

Transaction

Operations

Description

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.

BUSINESS: Mint credits

Request

Mint credits to account from active minter account

Bodyapplication/jsonrequired
userEmailstring
userIdentifierstring

User identifier, this is the user´s main reference to identify the user

Enum"id""email""instagramAccountId""externalId"
amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Mint credits to user

Request

Mint credits to user account from tenant

Bodyapplication/jsonrequired
userEmailstring
userIdentifierstring

User identifier, this is the user´s main reference to identify the user

Enum"id""email""instagramAccountId""externalId"
amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

BUSINESS: Transfer credits

Request

Transfer credits from user account to business account

Bodyapplication/jsonrequired
userEmailstring
userIdentifierstring

User identifier, this is the user´s main reference to identify the user

Enum"id""email""instagramAccountId""externalId"
amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Transfer credits from user

Request

Transfer credits from user account to tenant account

Bodyapplication/jsonrequired
userEmailstring
userIdentifierstring

User identifier, this is the user´s main reference to identify the user

Enum"id""email""instagramAccountId""externalId"
amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

AUTH USER: Transfer credits

Request

Transfer credits from account to business account

Bodyapplication/jsonrequired
businessIdstring

Business id

tokenAddressstring

Token address, this is optional, if not provided, the default credit token will be used

tokenMetadataIncrementalIdnumber

Token metadata incremental id, this is optional, if not provided, will be set to null

chainIdnumberrequired

chain Id

amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

AUTH USER: Transfer token

Request

Transfer token from account to business account

Bodyapplication/jsonrequired
businessIdstring

Business id

tokenAddressstring

Token address, this is optional, if not provided, the default credit token will be used

tokenMetadataIncrementalIdnumber

Token metadata incremental id, this is optional, if not provided, will be set to null

chainIdnumberrequired

chain Id

amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

AUTH USER: Burn token

Request

Burn token from account

Bodyapplication/jsonrequired
tokenAddressstringrequired

Token address

chainIdnumberrequired

chain Id

tokenMetadataIncrementalIdstringrequired

Token id

amountnumberrequired
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
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Mint token

Request

Mint token to account

Bodyapplication/jsonrequired
amountnumberrequired

Transaction amount

tokenAddressstringrequired

Transaction token address

tokenMetadataIncrementalIdobject

Transaction token metadata incremental id

chainIdnumberrequired

chain Id

senderAddressstring

Sender address

recipientAddressstring

Recipient address

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/transaction/admin/mint/token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 0,
    "tokenAddress": "string",
    "tokenMetadataIncrementalId": {},
    "chainId": 0,
    "senderAddress": "string",
    "recipientAddress": "string"
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Mint token

Request

Mint token to account

Bodyapplication/jsonrequired
urlstringrequired
Example: "https://example.com/user-data"
amountnumber

Transaction amount, if not provided, the amount must be included in the file from url

tokenAddressstringrequired

Transaction token address

tokenMetadataIncrementalIdobject

Transaction token metadata incremental id

chainIdnumberrequired

chain Id

senderAddressstring

Sender address

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"
  }'

Responses

Transactions completed

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

ADMIN: Burn token

Request

Burn token from account

Bodyapplication/jsonrequired
amountnumberrequired

Transaction amount

tokenAddressstringrequired

Transaction token address

tokenMetadataIncrementalIdobject

Transaction token metadata incremental id

chainIdnumberrequired

chain Id

senderAddressstring

Sender address

recipientAddressstring

Recipient address

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/transaction/admin/burn/token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 0,
    "tokenAddress": "string",
    "tokenMetadataIncrementalId": {},
    "chainId": 0,
    "senderAddress": "string",
    "recipientAddress": "string"
  }'

Responses

Transaction complete

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

AUTH USER: Get transactions by sender for authentificated user

Request

Get transactions by sender for authentificated user

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

Responses

Transactions by user as sender

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

AUTH USER: Get transactions by recipient for authentificated user

Request

Get transactions by recipient for authentificated user

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

Responses

Transactions by user as recipeint

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

ADMIN: Get transactions by sender for authenticated admin

Request

Get transactions by sender for authenticated admin

Bodyapplication/jsonrequired
emailstring

User email

userIdentifierstring

User identifier

Enum"id""email""instagramAccountId""externalId"
accountAddressstring

User account address

businessOrUserIdstring

Business or user id

accountTypestringrequired

Type to retrieve transactions from: user or business

Enum"BUSINESS""USER"
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"
  }'

Responses

Transactions as sender

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

Get transactions by recipient for authenticated admin

Request

Get transactions by recipient for authenticated admin

Bodyapplication/jsonrequired
emailstring

User email

userIdentifierstring

User identifier

Enum"id""email""instagramAccountId""externalId"
accountAddressstring

User account address

businessOrUserIdstring

Business or user id

accountTypestringrequired

Type to retrieve transactions from: user or business

Enum"BUSINESS""USER"
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"
  }'

Responses

Transactions as recipient

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

ADMIN: Get transactions

Request

Get transactions for authenticated admin

Bodyapplication/jsonrequired
emailstring

User email

userIdentifierstring

User identifier

Enum"id""email""instagramAccountId""externalId"
accountAddressstring

User account address

businessOrUserIdstring

Business or user id

accountTypestringrequired

Type to retrieve transactions from: user or business

Enum"BUSINESS""USER"
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"
  }'

Responses

Transactions as recipient

Bodyapplication/jsonArray [
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]
Response
application/json
[
  {
    "amount": 0,
    "id": "string",
    "tokenAddress": "string",
    "tokenType": "ERC20",
    "senderAddress": "string",
    "recipientAddress": {},
    "transactionHash": {},
    "type": "MINT",
    "triggerProcessType": "PURCHASE",
    "triggerProcessId": {},
    "status": "created",
    "createdAt": {},
    "updatedAt": {}
  }
]

Get transaction by id

Request

Get transaction by id

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

Responses

Transaction

Bodyapplication/json
amountnumberrequired

Transaction amount

idstringrequired

Transaction id

tokenAddressstringrequired

Transaction token address

tokenTypestringrequired

Transaction token type

Enum"ERC20""ERC721""ERC1155"
senderAddressstringrequired

Sender address

recipientAddressobjectrequired

Recipient address

transactionHashobjectrequired

Transaction hash

typestringrequired

Transaction type

Enum"MINT""TRANSFER""BURN""CLAIM"
triggerProcessTypestringrequired

Trigger process type

Enum"PURCHASE""SPEND""EARN""CAMPAIGN_USER_CLAIM""CAMPAIGN_SYSTEM_CLAIM""CAMPAIGN_BUSINESS_CLAIM""REDEMPTION_SPEND""REDEMPTION_RECEIVE""MIGRATION""ADMIN_TRIGGERED"
triggerProcessIdobjectrequired

Trigger process id, this is the id of the entity that triggered the transaction if applicable (e.g. CampaignUserClaim id)

statusstringrequired

Transaction status

Enum"created""processing""broadcasted""succeeded""failed"
createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response
application/json
{
  "amount": 0,
  "id": "string",
  "tokenAddress": "string",
  "tokenType": "ERC20",
  "senderAddress": "string",
  "recipientAddress": {},
  "transactionHash": {},
  "type": "MINT",
  "triggerProcessType": "PURCHASE",
  "triggerProcessId": {},
  "status": "created",
  "createdAt": {},
  "updatedAt": {}
}

User

User endpoints

Operations

Admin

Operations

Auth

Operations

Web3 Contract

Operations

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations