Skip to content

PERS-api docs (2.0.7)

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://explorins-loyalty.ngrok.io/
https://api.pers.ninja/v2/

Tenants

Operations

Admins

Operations

Tokens

Operations

Campaigns

Operations

Campaign Tags

Operations

Campaign Tokens

Operations

Campaign Triggers

Operations

Campaign Engagements

Operations

Campaign Claims

Operations

Redemptions

Operations

Purchases

Operations

Businesses

Operations

Transactions

Operations

Users

Operations

Balances

Operations

Account Balance Management

Real-time balance tracking and management across all token types and user accounts. Provides comprehensive balance queries and balance-related operations.
Balance Features:

•
Multi-Token Balances:
Track balances across different token types per user

•
Real-Time Updates:
Instant balance updates from all transaction sources

•
Balance History:
Historical balance tracking and change audit trails

•
Balance Queries:
Flexible balance lookup with filtering and aggregation

•
Balance Notifications:
Alert systems for balance changes and thresholds

Get account balance by address (Admin)

Request

Get detailed balance information including token metadata for any account address. Requires tenant admin privileges. Replaces GET /balance/admin/account/{accountAddress}

Security
tenantAdminJWT
Path
accountAddressstringrequired
Query
includeInactiveboolean

Include inactive tokens in balance response (default: false)

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/balances/accounts/{accountAddress}?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Account balance retrieved successfully

Bodyapplication/json
accountAddressstringrequired
tokenBalancesArray of objects(TokenMetadataBalanceDTO)required
tokenBalances[].​contractAddressstringrequired
tokenBalances[].​chainIdnumberrequired
tokenBalances[].​balancenumberrequired
tokenBalances[].​tokenNamestring
tokenBalances[].​tokenSymbolstring
tokenBalances[].​tokenTypestringrequired
tokenBalances[].​tokenIdstring or nullrequired
tokenBalances[].​metadataUristring or nullrequired
tokenBalances[].​metadataobjectrequired
Response
application/json
{ "accountAddress": "string", "tokenBalances": [ { … } ] }

Files

Operations

Web3 Chains

Operations

Contracts

Operations

Auth

Operations

Root

Operations

Well-known

Operations

webhooks

Business Types

Operations

Redemption Types

Operations

Redemption Redeems

Operations

Redemption Tokens

Operations

API Keys

Operations