Skip to content

Recover tokens from a holder's account.

How clawback works

Clawback allows the issuer to forcibly recover tokens from a holder without their consent. This is useful for regulatory compliance, fraud recovery, or asset recall scenarios.

Clawback requires lsfMPTCanClawback to be set during issuance. This flag cannot be added after the MPT is created.

Prerequisites

  • You are the issuer of the MPT
  • The MPT has lsfMPTCanClawback enabled
  • The holder has tokens to claw back

Clawback tokens

To clawback tokens from a holder, submit a Clawback transaction:

{
  "payload": {
    "id": "{{intent_id}}",
    "accountId": "{{issuer_account_id}}",
    "parameters": {
      "type": "XRPL",
      "feeStrategy": {
        "priority": "Medium",
        "type": "Priority"
      },
      "operation": {
        "type": "Clawback",
        "currency": {
          "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D0831E",
          "type": "MultiPurposeToken"
        },
        "holder": {
          "address": "rHolderAddress...",
          "type": "Address"
        },
        "value": "500000"
      }
    },
    "customProperties": {},
    "type": "v0_CreateTransactionOrder"
  }
}

Parameters

FieldTypeRequiredDescription
currency.issuanceIdstringYesThe 192-bit MPT issuance ID.
currency.typestringYesMust be MultiPurposeToken.
holderobjectYesThe holder to claw back tokens from.
holder.typestringYesOne of: Account (internal account UUID), Address (XRPL address), or Endpoint (endpoint UUID).
holder.addressstringConditionalThe holder's XRPL address. Required when holder.type is Address.
holder.accountIdstringConditionalInternal account UUID. Required when holder.type is Account.
holder.endpointIdstringConditionalEndpoint UUID. Required when holder.type is Endpoint.
valuestringYesThe amount to claw back (raw integer value).

Response

A successful request returns the transaction order with status Pending. After confirmation:

  • The holder's balance decreases by the clawed back amount.
  • The total supply decreases accordingly.
  • The issuer does not receive the tokens — they are removed from circulation.

Clawback frozen tokens

Clawback works even when a holder's tokens are frozen. This allows issuers to recover tokens from non-compliant or sanctioned addresses.

Typical workflow:

  1. Freeze the holder's tokens to prevent transfers.
  2. Clawback the tokens.
  3. Optionally unfreeze the holder.