TokenOS
  • Overview
    • Introduction
    • Authentication
    • User & Wallet Identification
    • Errors
    • Versioning
  • Guides
    • How our system works
    • Rewarding your audience
      • In exchange for completing an incentive
      • In exchange for your own points
      • As a credit
  • Wallet API
    • Balances
    • Allocations
  • Management API
    • Token Selection
    • Campaigns
    • Subscriptions
    • Codes
  • Payments API
    • Introduction
    • Payments
    • Deliveries
    • Relayer
Powered by GitBook
On this page
  1. Wallet API

Balances

PreviousAs a creditNextAllocations

Last updated 2 years ago

The balance object

This object represents the balance of one of your holders. This balance merges the following sources of information:

  • Off-Chain Balance. This balance represents any $TOKENs a user has been allocated, but has not yet claimed.

  • On-Chain Balance. This balance represents $TOKENs within the user's wallet.

Retrieve balance

Get user Balances

get
Authorizations
Path parameters
userIdstringRequired
Query parameters
identifierTypestring · enumRequiredPossible values:
Responses
200
Ok
application/json
get
GET /v1/wallets/{userId}/balance HTTP/1.1
Host: localhost:8080
Accept: */*
200

Ok

{
  "onChain": 1,
  "offChain": 1
}
  • The balance object
  • Retrieve balance
  • GETGet user Balances