POST/tokenization/{id}/operations

Burn NFT · ERC-721

Outcome - Destroys one NFT. The collection must have been created with canBurn true. The NFT must be held by a wallet of this vault, and that wallet signs. Signer: RoxCustody signs with the wallet of this vault that holds the NFT. Do not send a signer: signerWalletAddress or signerWalletId in params is refused. Templates: erc721-v1.

Path Parameters

idnumber

Token ID

Body Parameters

operationstringrequired

Always BURN for this operation.

paramsobjectrequired

The operation details

Show child parameters (1)
nftTokenIdstringrequired

The NFT to burn (digits only)

idempotencyKeystring

Your unique key for this request. Repeating it with the same body returns the first transaction; with a different body it returns 409.

Responses

Response attributes

messagestring

Success message

dataobject

The transaction created

Show child attributes (2)
transactionIdnumber

ID of the transaction (type TOKEN_OPERATION). Follow it with Get Transaction Details or the transaction webhooks: the operation is done when it is COMPLETED.

dataobject

What the operation does, as shown on the transaction everywhere (API and webhooks)

Show child attributes (3)
operationstring

The operation

securityTokenobject

The token

Show child attributes (1)
idnumber

Token ID

movementsarray

One BURN of the NFT from its holder

Show child attributes (6)
typestring

MINT (tokens created: has to), BURN (tokens destroyed: has from) or TRANSFER (has from and to)

fromstring

Address the tokens leave. Absent on MINT.

tostring

Address the tokens reach. Absent on BURN.

amountstring

Fungible tokens: amount in whole units (for example "10.5"). Absent for an NFT.

nftTokenIdstring

ERC-721: the NFT that moves. Absent for fungible tokens.

metadataUrlstring

ERC-721 MINT: the metadata URL of the new NFT

statusnumber

HTTP status code

Was this page helpful?