TAtatum
Multi Tokens (ERC-1155 or compatible)

Burn a Multi Token

/v3/multitoken/burn

2 credits per API call

Burn a fixed amount of Multi Tokens by id. This method destroys Multi Tokens from smart contract defined in contractAddress.

This API is supported for the following blockchains:

  • BNB Smart Chain
  • Celo
  • Ethereum
  • Harmony
  • Klaytn
  • KuCoin Community Chain
  • Polygon
  • Flare
  • Cronos
  • Base
  • Avalanche
  • Fantom
  • Optimism

Signing a transaction

When burning a Multi Token, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

post/v3/multitoken/burn

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/multitoken/burn
  • Auth
    API key in header x-api-key

Query parameters

testnetType'ethereum-sepolia' | 'flare-coston' | 'flare-coston2' | 'flare-songbird'

Specifies the testnet type. The default is ethereum-sepolia for Ethereum (ETH) currency and flare-coston for Flare (FLR) currency. Valid testnet types depend on the specified currency.

Type of testnet in query. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Headers

x-testnet-typeSchema (unresolved $ref)

Type of testnet in header. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Request body

OR
OR
OR

Example request

{
  "chain": "ETH",
  "account": "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f",
  "tokenId": "100000",
  "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
  "amount": "100000",
  "fee": {
    "gasLimit": "40000",
    "gasPrice": "20"
  }
}

Response

OK

OR

Example response

{
  "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

Changes

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