Get Wallet Details

GET

/wallets/{id}/

Retrieves detailed information about a specific wallet by its ID, including current balances.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	UUID of the wallet to retrieve

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 the wallet details including balances.

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/550e8400-e29b-41d4-a716-446655440000/" \
  -H "X-API-Key: your_api_key"

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Player 12345",
  "external_id": "player-12345",
  "wallet_id": "w_abc123def456",
  "created": "2025-03-15T14:30:00.000Z",
  "updated": "2025-04-20T08:15:30.000Z",
  "balances": [
    {
      "currency": "USDTTRC20",
      "amount": "1500.75",
      "pending_amount": "0.00",
      "available_balance": "1500.75"
    },
    {
      "currency": "BTC",
      "amount": "0.025",
      "pending_amount": "0.01",
      "available_balance": "0.015"
    }
  ]
}

Error Codes

Status Code	Error Code	Description
400	invalid_request	Invalid wallet ID format
401	unauthorized	Authentication failed
403	forbidden	User doesn't have required permissions
404	not_found	Wallet not found
500	server_error	Internal server error

Error Response Format

{
  "error": {
    "code": "not_found",
    "message": "Wallet not found",
    "details": {}
  }
}

Notes

• The wallet ID in the URL path is the UUID assigned when the wallet was created.
• The response includes all current balances for the wallet.
• Required scopes: read, write.
• For querying balances by wallet_id or external_id instead of UUID, use POST /wallets/balances/.