Reject a token

TokenRejectTransaction

The TokenRejectTransaction allows users to reject and return unwanted airdrops to the treasury account without incurring custom fees. This transaction type supports rejecting the full balance of fungible tokens or individual NFT serial numbers with support for up to 10 token rejections in a single transaction. Rejection is not supported if the token has been frozen or paused. Note that the transaction does not dissociate the account from the token. To both reject and dissociate, use TokenRejectFlow (see below).

  • Each rejected token is transferred to the treasury, and the transfer is recorded in the token_transfer_list in the transaction record.

  • The receiver_sig_required setting is ignored on the treasury account when handling a TokenReject. Rejection will always proceed without custom fees.

  • Custom fees are waived during rejection, preventing the payer from incurring any extra costs.

  • The transaction does not decrement used_auto_associations, as it does not remove the association with the token. This field tracks the total number of auto-associations made, not the current number of token types associated with the account.

Transaction Signing Requirements

  • The receiver/owner account key.

  • The transaction fee payer account key.

Transaction Fees

  • Please see the transaction and query fees table for the base transaction fee.

  • Please use the Hedera fee estimator to estimate the cost of your transaction fee.

SDK Method
Type
Description

setOwnerId(accountId)

Sets the ID of the account holding/owning the tokens.

addTokenId(<tokenId>)

TokenId

Adds a token to be rejected.

setTokenIds(tokenIds)

List<TokenId>

Adds a list of one or more token IDs to be rejected.

addNftId(<nftId>)

TokenId

Adds a NFT ID to be rejected.

setNftIds(<nftIds>)

List<NftId>

Adds a list of one or more NFT IDs to be rejected.

// Create the token reject transaction for fungible token
TokenRejectTransaction transaction = new TokenRejectTransaction()
    .setOwnerId(accountId)
    .addTokenId(tokenId)
    .freezeWith(client);
  
// Sign with the account Id key and submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.sign(accountIdKey).execute(client);

// Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);

// Get the transaction consensus status
Status transactionStatus = receipt.status;

System.out.println("The transaction consensus status is " +transactionStatus);

// v2.50.0

TokenRejectFlow

The TokenRejectFlow simplifies the process of rejecting unwanted tokens and dissociating from them in a single execute() call. This flow combines both the TokenRejectTransaction, which transfers the tokens back to the treasury, and the TokenDissociateTransaction, which dissociates the account from the token. It streamlines the process by executing both actions in one single transaction.

Transaction Signing Requirements

  • The receiver/owner account key.

  • The transaction fee payer account key.

Transaction Fees

  • Please see the transaction and query fees table for the base transaction fee.

  • Please use the Hedera fee estimator to estimate the cost of your transaction fee.

Method
Type
Description

setOwnerId(accountId)

Sets the ID of the account holding/owning the tokens. This is the receiver account that will be rejecting the token.

addTokenId(<tokenId>)

TokenId

Adds a token ID to be rejected and dissociated.

setTokenIds(tokenIds)

List<TokenId>

Sets a list of one or more token IDs to be rejected and dissociated.

addNftId(<NftId>)

NftId

Adds a NFT ID to be rejected and dissociated.

setNftIds(<nftIds>)

List<NftId>

Sets a list of one or more NFT IDs to be rejected and dissociated.

// Create the token reject transaction for fungible token
TokenRejectFlow transaction = new TokenRejectFlow()
    .setOwnerId(accountId)
    .addTokenId(tokenId)
    .freezeWith(client);
  
// Sign with the account Id key and submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.sign(accountIdKey).execute(client);

// Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);

// Get the transaction consensus status
Status transactionStatus = receipt.status;

System.out.println("The transaction consensus status is " +transactionStatus);

// v2.50.0

Last updated

#2871: HIP-423 long term scheduled transactions

Change request updated