/tokenization/{id}/operationsBurn · ERC-3643 / Title-fraction
Outcome - An agent destroys tokens held by any address, inside or outside RoxCustody. Frozen tokens can be burned: the contract unfreezes what the unfrozen balance cannot cover. title-fraction-v1: only while fractionalized, and never the whole supply (at least one fraction must remain so the title can be redeemed). Signer: An agent signs: name one ACTIVE agent of this token in params, as signerWalletAddress or signerWalletId (from Get Token Roles). Exactly one of the two. Templates: erc3643-v1, title-fraction-v1.
Path Parameters
idnumberToken ID
Body Parameters
operationstringrequiredAlways BURN for this operation.
paramsobjectrequiredThe operation details, including its signer
Show child parameters (4)
fromstringrequiredAddress whose tokens are burned
amountstringrequiredAmount in whole units, as a string (for example "10.5"), with at most the token's decimals.
signerWalletAddressstringone of the twoAddress of the wallet that signs. Give signerWalletAddress or signerWalletId, not both.
signerWalletIdnumberone of the twoID of that wallet: its wallet of the token (walletId from Get Token Roles). Give signerWalletAddress or signerWalletId, not both.
idempotencyKeystringYour 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
messagestringSuccess message
dataobjectThe transaction created
Show child attributes (2)
transactionIdnumberID of the transaction (type TOKEN_OPERATION). Follow it with Get Transaction Details or the transaction webhooks: the operation is done when it is COMPLETED.
dataobjectWhat the operation does, as shown on the transaction everywhere (API and webhooks)
Show child attributes (3)
operationstringThe operation
securityTokenobjectThe token
Show child attributes (1)
idnumberToken ID
movementsarrayOne BURN from the from address
Show child attributes (6)
typestringMINT (tokens created: has to), BURN (tokens destroyed: has from) or TRANSFER (has from and to)
fromstringAddress the tokens leave. Absent on MINT.
tostringAddress the tokens reach. Absent on BURN.
amountstringFungible tokens: amount in whole units (for example "10.5"). Absent for an NFT.
nftTokenIdstringERC-721: the NFT that moves. Absent for fungible tokens.
metadataUrlstringERC-721 MINT: the metadata URL of the new NFT
statusnumberHTTP status code
Was this page helpful?