ORB3 API - Technical Documentation
  • ORB3 API - Technical Documentation
    • About the ORB3 API
    • Getting Started
    • Projects
      • Creating your Project
      • Fetching Project Data
    • Collections
      • Creating a Collection
      • Fetching Collection Data
    • Collectibles
      • Creating a Collectible
      • Minting a Collectible
      • Sending a Collectible
      • Requesting a Collectible
      • Burning a Collectible
      • Fetching Collectible Data
    • Users
      • User Operations
    • Marketplace Functions
      • Collectible Listings
      • Collectible Offers
      • Collectible Auctions
Powered by GitBook
On this page
  1. ORB3 API - Technical Documentation
  2. Collectibles

Burning a Collectible

PreviousRequesting a CollectibleNextFetching Collectible Data

Last updated 1 year ago

Use the following Mutation in order to burn editions of a collectible.

BurnToken
mutation BurnToken($input: BurnTokenInput!) {
  BurnToken(input: $input) {
    transactionHash
  }
}
Input Variables
 "input": {
    "burnValue": 1,
    "collectionId": "KT1SjwraTtii88ZaEs8ReU6wkUreTvM8qfaa",
    "tokenId": "0"
  }

A few things to keep in mind when wanting to burn editions of a collectible:

  • burnValue: This is the number of editions, of a specific collectible, you wish to burn.

  • collectionId: The collectionId that the collectible belongs to.

  • tokenId: The tokenId of the collectible you want to burn editions of.

If the collectible you are burning has been infused with ORB tokens, then the ORB tokens will be added to your balance. They are not burned together with the edition of the collectible.

Sample Response
{
  "data": {
    "BurnToken": {
      "transactionHash": "ooRADFbt8ftELT5Vd3qwH3vfmxy1WZz7M4oqTn75BTMmPWKpZi7"
    }
  }
}

Once the transaction has been signed from the developer wallet, the edition of the collectible will be successfully burned and the value of the edition will be reflected in the balance of the wallet. The hash of the transaction is returned as a response, in order to monitor the status of the transaction.

Burning a token in the ORB Platform