Burn NFT

This API "burns" NFT from the user's wallet.

As a consequence, the specific token held by the user is deleted. The deleted token is not transferred back to the developer. It simply ceases to exist. Think of it as an undo operation to the app/nft/mint API.


Acceptable Use Advisory

Exercise extreme caution and restraint when using the burn API. Otherwise, the ecosystem risks loss of confidence in your brand, in MetaKeep, and in the broader Crypto & Web3 ecosystem.

Examples of Acceptable Use:

  1. User "cashes-in" their token for a discount on merchandise.
    • The developer may burn the token from the user's wallet and discount the merchandise by x.
  2. User returns merchandise for which they were awarded a token.
    • The developer may burn the token they awarded the user
    • PS: In case of e-commerce transactions, we recommend that you don't mint token to user until the transaction passes the return window.
  3. User is discovered to have defrauded the platform.
    • The developer may burn the token they issued the user
  4. User has lost a token or the token was stolen from them
    • The developer can burn the old token and issue the user a new token.

Upon calling this API, a transaction is raised and submitted to the Queue on the blockchain. MetaKeep, behind the scenes, employs several strategies to make sure transactions succeed, and at the lowest cost.

You can get the status of this blockchain transaction by querying for transaction status by copying transactionId from this API response and querying it in Transaction Status API.


Replaying this API

Once you get a status response as QUEUED, replaying this API doesn't give you the latest status; Replaying the same API with the same Idempotency-Key results in the same response, always with status-QUEUED. You must query the Transaction Status API for the latest status.

As you would learn from the Transaction Status API docs, if a transaction failed, MetaKeep would have exhausted all feasible smart AI-based strategies to recover from failure, that would have been attempted by humans, and the "FAILED" status, if shown, is final.


This API utilizes powerful MetaKeep lambda infrastructure

MetaKeep's first-party NFT and Coin contracts are built on MetaKeep Lambda Infrastructure. This API uses lambda infrastructure to invoke the burn function of the NFT smart contract.

Error Status


Api Error Status

You can find error status returned by the api here.

© Copyright 2024, Passbird Research Inc.

Click Try It! to start a request and see the response here!