FIfireblocks
Tokenization

Burn tokens

Burn tokens in a collection

post/tokenization/collections/{id}/tokens/burn

Request

Path parameters

idstring required

The collection link id

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

vaultAccountIdstring required

The id of the vault account that initiates the burn function

tokenIdstring required

The token id

amountstring

For ERC721, amount is optional or should always be 1 and for ERC1155, amount should be 1 or greater

externalIdstring

External id that can be used to identify the transaction in your system. The unique identifier of the transaction outside of Fireblocks with max length of 255 characters

Example request

{
  "vaultAccountId": "0",
  "tokenId": "1",
  "amount": "1",
  "externalId": "0192e4f5-924e-7bb9-8e5b-c748270feb38"
}

Response

Tokens burned successfully

txIdstring required

Transaction Id for the burn operation

Example response

{
  "txId": "fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb"
}

Changes

No recorded changes to this operation across all 1 revision of this API.