Burn Token
Burns supply of a specific token, removing it from circulation. This call is asynchronous — the handler enqueues a BurnToken blockchain transaction and returns HTTP 200 immediately; the supply only decreases on-chain (and via the user overlay) once the wallet pipeline confirms the transaction. Poll List Token Transactions to observe completion.
Request
POST /v2/admin/tokens/{token_id}/burn
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. The ID of the token to burn |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer token for authentication |
Content-Type | Required. Must be application/json |
Example
curl --request POST \
--url '\{\{baseUrl\}\}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/burn' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.3.1' \
--data '{}'
Response
A successful response returns an empty object:
{}
The 200 means "queued", not "burned". An empty body is returned even when the wallet transaction subsequently fails — use the polling pattern in List Token Transactions to observe terminal status.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Success - Token has been burned successfully |
| 400 | Bad Request - Invalid request parameters |
| 401 | Unauthorized - Invalid or missing authentication token |
| 404 | Not Found - Token ID does not exist |
| 500 | Internal Server Error |