Burn a token

Burns fungible and non-fungible tokens owned by 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
1
new TokenBurnTransaction()
Copied!
Methods
V2
V1
​
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 (fungible tokens)
Optional
setSerials(<serials>)
List<long>
Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The  list of NFT serial IDs to burn.
Optional
addSerial(<serial>)
long
Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The serial ID to burn.
Optional
Java
1
//Burn 1,000 tokens
2
TokenBurnTransaction transaction = new TokenBurnTransaction()
3
     .setTokenId(tokenId)
4
     .setAmount(1000);
5
​
6
//Freeze the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
7
TransactionResponse txResponse = transaction.freezeWith(client).sign(supplyKey).execute(client);
8
​
9
//Request the receipt of the transaction
10
TransactionReceipt receipt = txResponse.getReceipt(client);
11
​
12
//Obtain the transaction consensus status
13
Status transactionStatus = receipt.status;
14
​
15
System.out.println("The transaction consensus status is " +transactionStatus);
16
​
17
//v2.0.1
Copied!
JavaScript
1
//Burn 1,000 tokens and freeze the unsigned transaction for manual signing
2
const transaction = await new TokenBurnTransaction()
3
     .setTokenId(tokenId)
4
     .setAmount(1000)
5
     .freezeWith(client);
6
​
7
//Sign with the supply private key of the token 
8
const signTx = await transaction.sign(supplyKey);
9
​
10
//Submit the transaction to a Hedera network    
11
const txResponse = await signTx.execute(client);
12
​
13
//Request the receipt of the transaction
14
const receipt = await txResponse.getReceipt(client);
15
    
16
//Get the transaction consensus status
17
const transactionStatus = receipt.status;
18
​
19
console.log("The transaction consensus status " +transactionStatus.toString());
20
​
21
//v2.0.7
Copied!
Go
1
//Burn 1,000 tokens and freeze the unsigned transaction for manual signing
2
transaction, err = hedera.NewTokenBurnTransaction().
3
		SetTokenID(tokenId).
4
		SetAmount(1000).
5
		FreezeWith(client)
6
​
7
if err != nil {
8
		panic(err)
9
}
10
​
11
//Sign with the supply private key of the token, submit the transaction to a Hedera network
12
txResponse, err := transaction.Sign(supplyKey).Execute(client)
13
​
14
if err != nil {
15
		panic(err)
16
}
17
​
18
//Request the receipt of the transaction
19
receipt, err = txResponse.GetReceipt(client)
20
​
21
if err != nil {
22
		panic(err)
23
}
24
​
25
//Get the transaction consensus status
26
status := receipt.Status
27
​
28
fmt.Printf("The transaction consensus status is %v\n", status)
29
​
30
//v2.1.0
Copied!
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
Optional
addSerial(<serial>)
long
Applicable to tokens of type NON_FUNGIBLE_UNIQUE. Serial ID to burn.
Optional
setSerials(<serials>)
List<Long>
Applicable to tokens of type NON_FUNGIBLE_UNIQUE. A list of NFT serials to burn.
Optional
Java
1
//Burn 1,000 tokens
2
TokenBurnTransaction transaction = new TokenBurnTransaction()
3
    .setTokenId(newTokenId)
4
    .setAmount(1000)
5
​
6
//Build the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
7
TransactionId transactionId = transaction.build(client).sign(supplyKey).execute(client);
8
    
9
//Request the receipt of the transaction
10
TransactionReceipt getReceipt = transactionId.getReceipt(client);
11
    
12
//Obtain the transaction consensus status
13
Status transactionStatus = getReceipt.status;
14
​
15
System.out.println("The transaction consensus status is " +transactionStatus);
16
//Version: 1.2.2
Copied!
JavaScript
1
//Burn 1,000 tokens
2
const transaction = new TokenBurnTransaction()
3
    .setTokenId(newTokenId)
4
    .setAmount(1000)
5
​
6
//Build the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
7
const transactionId = await transaction.build(client).sign(supplyKey).execute(client);
8
    
9
//Request the receipt of the transaction
10
const getReceipt = await transactionId.getReceipt(client);
11
    
12
//Obtain the transaction consensus status
13
const transactionStatus = getReceipt.status;
14
​
15
console.log("The transaction consensus status is " +transactionStatus);
16
//Version 1.4.2
Copied!
​
Mint a token
Freeze an account
Last modified 6d ago
Copy link
Contents
Methods