Burn Token
Ends a token's term: burns every token investors still hold and funds a payout pool at the current token price. The token must be in status 6 (Listed) or 4 (NotListed) and at least one token must be held by investors. Read Get Burn Summary first to see the amount the burn will move.
The call is asynchronous: it queues a BurnToken transaction (type 10) and answers with its id. Poll Get Token Transaction By ID. When the transaction reaches 3 (Done) the token is in status 8 (Burn) and one payout is recorded for each (investor, wallet) that held the token: the wallet's quantity times the token price. Investors then claim their payouts; follow them with Get Burn Payouts.
Required permission: token:burn
Request
POST /v2/admin/tokens/{token_id}/burn
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. Token id. |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Example
curl --request POST \
--url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/burn' \
--header 'Authorization: Bearer <access_token>'
Response
{
"transaction_id": "6a8b5e13f9129816a6cc7a12"
}
Response Fields
| Field | Type | Description |
|---|---|---|
transaction_id | string | The BurnToken transaction. Poll it with Get Token Transaction By ID. |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10016 | token_id is not a valid id |
| 400 | 10001 | Token not found (token domain 5) |
| 403 | 10005 | The caller's node does not cover the token's node (node domain 2) |
| 400 | 10006 | The token is neither listed nor not-listed (token domain 5, message token is not salable) |
| 400 | 10015 | No investor holds the token (message Token has not been sold) |
A failure after acceptance ends the transaction in status 4 (Error) with the reason in its error field. See Errors for the error format and common codes.