List Wallets

This endpoint returns a list of all wallets (sub-accounts) belonging to the authenticated tenant.

GET

/wallets/

Authentication

This endpoint requires authentication using one of the following methods:

Authentication Type	Header	Description
OAuth 2.0	Authorization	Bearer your_access_token
API Key	X-API-Key	your_api_key

Response

A successful response returns a list of wallet objects and a total count.

Field	Type	Description
accounts	array	List of wallet objects
total	integer	Total number of wallets

Wallet Object

Field	Type	Description
id	string	Unique wallet identifier (UUID)
name	string	Custom name for the wallet
external_id	string	Your unique identifier for this wallet
wallet_id	string	System-assigned wallet identifier
created	string	ISO 8601 timestamp of wallet creation
updated	string	ISO 8601 timestamp of last wallet update
balances	array	Array of balance objects for this wallet

Balance Object

Field	Type	Description
currency	string	Currency code (e.g., "USDTTRC20", "BTC")
amount	number	Total balance amount
pending_amount	number	Amount in pending transactions
available_balance	number	Balance available for transfers

Example Request

curl -X GET "{{BASE_URL}}/wallets/" \
  -H "X-API-Key: your_api_key"

Example Response

{
  "accounts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Player 12345",
      "external_id": "player-12345",
      "wallet_id": "w_abc123def456",
      "created": "2025-03-15T10:20:30.456Z",
      "updated": "2025-04-19T12:34:56.789Z",
      "balances": [
        {
          "currency": "USDTTRC20",
          "amount": "1000.00",
          "pending_amount": "50.00",
          "available_balance": "950.00"
        }
      ]
    },
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "name": "Player 67890",
      "external_id": "player-67890",
      "wallet_id": "w_xyz789ghi012",
      "created": "2025-04-01T08:15:30.123Z",
      "updated": "2025-04-19T12:34:56.789Z",
      "balances": []
    }
  ],
  "total": 2
}

Error Codes

Status Code	Error Code	Description
401	unauthorized	Authentication failed
403	forbidden	User doesn't have required permissions
500	server_error	Internal server error

Notes

• Each wallet includes its current balances across all cryptocurrencies.
• The available_balance represents funds that can be used for transfers (total minus pending).
• Required scopes: read, write.