Wipes the provided amount of tokens from the specified Account. Must be signed by the Token's Wipe key.
If the provided account is not found, the transaction will resolve to INVALID_ACCOUNT_ID.
If the provided account has been deleted, the transaction will resolve to ACCOUNT_DELETED.
If the provided token is not found, the transaction will resolve to INVALID_TOKEN_ID.
If the provided token has been deleted, the transaction will resolve to TOKEN_WAS_DELETED.
If an Association between the provided token and account is not found, the transaction will resolve to TOKEN_NOT_ASSOCIATED_TO_ACCOUNT.
If Wipe Key is not present in the Token, the transaction results in TOKEN_HAS_NO_WIPE_KEY.
If the provided account is the Token's Treasury Account, the transaction results in CANNOT_WIPE_TOKEN_TREASURY_ACCOUNT
On success, tokens are removed from the account and the total supply of the token is decreased by the wiped amount.
The amount provided is in the lowest denomination possible. Example:
Token A has 2 decimals. In order to wipe 100 tokens from account, one must provide amount of 10000. In order to wipe 100.55 tokens, one must provide amount of 10055.
| Field | Type | Description |
|---|---|---|
token |
TokenID | The token for which the account will be wiped. If token does not exist, transaction results in INVALID_TOKEN_ID |
account |
AccountID | The account to be wiped |
amount |
uint64 | Applicable to tokens of type FUNGIBLE_COMMON. The amount of tokens to wipe from the specified account. Amount must be a positive non-zero number in the lowest denomination possible, not bigger than the token balance of the account (0; balance] |
serialNumbers |
int64 | Applicable to tokens of type NON_FUNGIBLE_UNIQUE. The list of serial numbers to be wiped. |