Burn a token

Burns tokens from the Treasury Account. If no Supply Key is defined, the transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY. 
The operation decreases the Total Supply of the Token. 
Total supply cannot go below zero. 
The amount provided must be in the lowest denomination possible. 
Example: Token A has 2 decimals. In order to burn 100 tokens, one must provide an amount of 10000. In order to burn 100.55 tokens, one must provide an amount of 10055.
Transaction Signing Requirements:
Supply key
Transaction fee payer account key
Constructor
Description
new TokenBurnTransaction()
    Initializes the TokenBurnTransaction object
new TokenBurnTransaction()
Methods
V2
V1
V2
​
Method
Type
Description
Requirement
setTokenId(<tokenId>)
TokenId
The ID of the token to burn supply
Required
setAmount(<amount>)
long
The number of tokens to burn
Required
Java
//Burn 1,000 tokens
TokenBurnTransaction transaction = new TokenBurnTransaction()
     .setTokenId(tokenId)
     .setAmount(1000);
​
//Freeze the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.freezeWith(client).sign(supplyKey).execute(client);
​
//Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);
​
//Obtain the transaction consensus status
Status transactionStatus = receipt.status;
​
System.out.println("The transaction consensus status is " +transactionStatus);
​
//v2.0.1
JavaScript
//Burn 1,000 tokens and freeze the unsigned transaction for manual signing
const transaction = await new TokenBurnTransaction()
     .setTokenId(tokenId)
     .setAmount(1000)
     .freezeWith(client);
​
//Sign with the supply private key of the token 
const signTx = await transaction.sign(supplyKey);
​
//Submit the transaction to a Hedera network    
const txResponse = await signTx.execute(client);
​
//Request the receipt of the transaction
const receipt = await txResponse.getReceipt(client);
    
//Get the transaction consensus status
const transactionStatus = receipt.status;
​
console.log("The transaction consensus status " +transactionStatus.toString());
​
//v2.0.7
Go
//Burn 1,000 tokens and freeze the unsigned transaction for manual signing
transaction, err = hedera.NewTokenBurnTransaction().
		SetTokenID(tokenId).
		SetAmount(1000).
		FreezeWith(client)
​
if err != nil {
		panic(err)
}
​
//Sign with the supply private key of the token, submit the transaction to a Hedera network
txResponse, err := transaction.Sign(supplyKey).Execute(client)
​
if err != nil {
		panic(err)
}
​
//Request the receipt of the transaction
receipt, err = txResponse.GetReceipt(client)
​
if err != nil {
		panic(err)
}
​
//Get the transaction consensus status
status := receipt.Status
​
fmt.Printf("The transaction consensus status is %v\n", status)
​
//v2.1.0
V1
Method
Type
Description
Requirement
setTokenId(<tokenId>)
TokenId
The ID of the token to burn supply
Required
setTokenAmount(<amount>)
long
The number of tokens to burn
Required
Java
//Burn 1,000 tokens
TokenBurnTransaction transaction = new TokenBurnTransaction()
    .setTokenId(newTokenId)
    .setAmount(1000)
​
//Build the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
TransactionId transactionId = transaction.build(client).sign(supplyKey).execute(client);
    
//Request the receipt of the transaction
TransactionReceipt getReceipt = transactionId.getReceipt(client);
    
//Obtain the transaction consensus status
Status transactionStatus = getReceipt.status;
​
System.out.println("The transaction consensus status is " +transactionStatus);
//Version: 1.2.2
JavaScript
//Burn 1,000 tokens
const transaction = new TokenBurnTransaction()
    .setTokenId(newTokenId)
    .setAmount(1000)
​
//Build the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
const transactionId = await transaction.build(client).sign(supplyKey).execute(client);
    
//Request the receipt of the transaction
const getReceipt = await transactionId.getReceipt(client);
    
//Obtain the transaction consensus status
const transactionStatus = getReceipt.status;
​
console.log("The transaction consensus status is " +transactionStatus);
//Version 1.4.2
​
Mint a token
Freeze an account
Last updated 6 days ago
Constructor	Description
`new TokenBurnTransaction()`	Initializes the TokenBurnTransaction object
Method	Type	Description	Requirement
`setTokenId(<tokenId>)`	TokenId	The ID of the token to burn supply	Required
`setAmount(<amount>)`	long	The number of tokens to burn	Required