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

Description

Changes the treasury designation of a wallet. Treasury wallets are flagged for special tracking, reporting, and may have different operational rules or permissions applied.

Input

  • id (long, required) - The wallet tenant identifier (route parameter)
  • value (bool, required) - The new treasury status (query parameter): true to designate as treasury, false to remove designation

Output

Returns a containing:
  • success (bool) - Indicates if the operation succeeded
  • message (string, optional) - Additional information about the operation

Examples

Request
PUT /api/platform/wallets/3001/is-treasury?value=true
Response (200 OK)
{
  "success": true,
  "message": "Wallet treasury status updated successfully"
}

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 update the treasury status.
  • 404 Not Found: Wallet with the specified identifier does not exist.
  • 500 Internal Server Error: An unexpected error occurred while updating the treasury status.

Notes

Treasury designation is typically used for primary fund management wallets that require enhanced oversight and reporting. This flag may trigger additional compliance or audit requirements depending on system configuration.

Path Parameters

id
integer<int64>
required

Identifier of the wallet tenant.

Query Parameters

value
boolean

New treasury wallet status value (true to enable treasury operations, false to disable).

api-version
string | null

Response

Wallet treasury status updated 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:
{ "success": true }