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

​
Description

Fetches the current display name assigned to a wallet. This is a lightweight endpoint for retrieving just the wallet name without other wallet details.

​
Input

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

​
Output

Returns a containing:
  • walletTenantId (long) - Unique identifier of the wallet tenant
  • name (string) - Current display name of the wallet

​
Examples

Request 
GET /api/platform/wallets/2048/name
Response (200 OK) 
{
  "walletTenantId": 2048,
  "name": "Operations Wallet"
}

​
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 wallet name.
  • 404 Not Found: Wallet with the specified identifier does not exist.
  • 500 Internal Server Error: An unexpected error occurred while retrieving the wallet name.

​
Notes

This endpoint works for both EOA and multisignature wallets. The wallet name is a display property and does not affect blockchain operations.

Path Parameters

​
id
integer<int64>
required

Identifier of the wallet tenant.

Query Parameters

​
api-version
string | null

Response

Wallet name 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.