Skip to main content
GET
/
platform
/
admin
/
tenant
/
wallets
/
{id}
Get wallet details
curl --request GET \
  --url https://api.example.com/platform/admin/tenant/wallets/{id}
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Description

Fetches complete details for a single wallet including real-time balance, blockchain network information, wallet type (EOA or multisignature), configuration settings, and associated custodian relationships.

Input

  • id (long, required) - The wallet tenant identifier

Output

Returns a containing:
  • walletTenantId (long) - Unique identifier of the wallet tenant
  • walletName (string) - Display name of the wallet
  • walletAddress (string) - Blockchain address
  • blockchainId (long) - Blockchain network identifier
  • blockchainName (string) - Blockchain network name
  • walletType (string) - Type of wallet (EOA or MultiSignature)
  • balance (string) - Current wallet balance
  • isActive (bool) - Active status flag
  • isVisible (bool) - Visibility status flag
  • isTreasury (bool) - Treasury wallet designation
  • custodians (array) - List of associated custodian relationships
  • threshold (int, optional) - Signature threshold for multisig wallets
  • owners (array, optional) - List of owner addresses for multisig wallets

Examples

Request
GET /api/platform/wallets/2048
Response (200 OK)
{
  "walletTenantId": 2048,
  "walletName": "Main Operations Wallet",
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "blockchainId": 137,
  "blockchainName": "Polygon",
  "walletType": "EOA",
  "balance": "15250.75",
  "isActive": true,
  "isVisible": true,
  "isTreasury": false,
  "custodians": [
    {
      "custodianId": 42,
      "custodianName": "Fireblocks",
      "isActive": true,
      "isDefault": true
    }
  ]
}

Errors

  • 400 Bad Request: Invalid wallet tenant identifier format.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to view the specified wallet.
  • 404 Not Found: Wallet with the specified identifier does not exist.
  • 500 Internal Server Error: An unexpected error occurred while retrieving wallet details.

Notes

Balance information is retrieved in real-time from the blockchain network. For multisignature wallets, the response includes threshold and owner information. Custodian relationships show configured integrations with external custody services.

Path Parameters

id
integer<int64>
required

Identifier of the wallet tenant.

Query Parameters

api-version
string | null

Response

Wallet details retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

error
object

Error information returned when the operation fails.

Example:
{
"code": "ValidationError",
"message": "The request parameters failed validation.",
"info": [
"The Name field is required.",
"The Id field must be greater than 0."
]
}
value
object

The result value returned when the operation is successful.

Example:
{
"walletTenantId": 2048,
"walletId": 1,
"isActive": true,
"isVisible": true,
"isTreasuryWallet": false,
"name": "Main Wallet",
"description": "Primary operational wallet",
"walletBalance": 12.345,
"walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
"network": "Polygon",
"networkIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA",
"networkCoinName": "MATIC",
"walletType": "EOA",
"blockchainId": 137,
"isGasStation": false,
"autoRefuelWalletTenantsCount": 0,
"autoRefuelIsEnabled": false,
"autoRefuelMinimumBalance": 0.1,
"autoRefuelAmount": 1,
"autoRefuelWalletName": "Gas Station Wallet"
}