xrpl
    Preparing search index...

    Interface Clawback

    The Clawback transaction is used by the token issuer to claw back issued tokens from a holder.

    interface Clawback {
        Account: string;
        AccountTxnID?: string;
        Amount: ClawbackAmount;
        Delegate?: string;
        Fee?: string;
        Flags?: number | GlobalFlagsInterface;
        Holder?: string;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "Clawback";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Amount Delegate? Fee? Flags? Holder? LastLedgerSequence? Memos? NetworkID? Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TxnSignature?

    Properties

    Account: string

    Indicates the AccountID that submitted this transaction. The account MUST be the issuer of the currency or MPT.

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    Amount: ClawbackAmount

    The amount of currency or MPT to clawback, and it must be non-XRP. The nested field names MUST be lower-case. If the amount is IOU, the issuer field MUST be the holder's address, whom to be clawed back.

    Delegate?: string

    The delegate account that is sending the transaction.

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    Flags?: number | GlobalFlagsInterface

    Set of bit-flags for this transaction.

    Holder?: string

    Indicates the AccountID that the issuer wants to clawback. This field is only valid for clawing back MPTs.

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    TransactionType: "Clawback"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Settings

    Member Visibility

    On This Page

    Properties