Skip to main content

Burn Token By User

Burn (destroy) tokens owned by a specific user. This action permanently removes the tokens from circulation.

Endpoint​

POST /v2/users/tokens/{token_id}/users/{user_id}/burn

Headers​

HeaderValue
Content-Typeapplication/json
AuthorizationBearer {token}

Path Parameters​

ParameterTypeRequiredDescription
token_idstringYesThe unique identifier of the token to burn
user_idstringYesThe unique identifier of the user whose tokens will be burned

Request Body​

No request body required. User ID and Token ID are passed in the path.

Response​

Returns 200 OK with no content when the burn operation is successfully initiated. The burn is processed asynchronously.

Success Response (200 OK)​

No content - successful response.

Example​

Request​

curl -X POST "\{\{baseUrl\}\}/v2/users/tokens/68aeb272d9336c619ce249f6/users/680c02896d91ca0145cfeb81/burn" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer \{\{token\}\}"

Response​

200 OK
(No content)

Error Responses​

400 Bad Request​

{
    "error": "Invalid parameters",
    "details": "Quantity must be greater than 0"
}

401 Unauthorized​

{
    "error": "Authentication required"
}

403 Forbidden​

{
    "error": "Access denied",
    "details": "Insufficient permissions to burn tokens"
}

404 Not Found​

{
    "error": "Resource not found",
    "details": "Token or user not found"
}

422 Unprocessable Entity​

{
    "error": "Insufficient token balance",
    "details": "User does not have enough tokens to burn"
}

500 Internal Server Error​

{
    "error": "Internal server error"
}

Important Notes​

  • Irreversible Action: Token burning is permanent and cannot be undone
  • Balance Check: The system will verify the user has sufficient token balance before burning
  • Transaction Recording: All burn operations are recorded on the blockchain
  • Permissions: Only authorized users can perform burn operations
  • Audit Trail: All burn operations are logged for audit purposes