Recover tokens from a holder's account.
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.
- You are the issuer of the MPT
- The MPT has
lsfMPTCanClawbackenabled - The holder has tokens to claw back
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"
}
}| Field | Type | Required | Description |
|---|---|---|---|
currency.issuanceId | string | Yes | The 192-bit MPT issuance ID. |
currency.type | string | Yes | Must be MultiPurposeToken. |
holder | object | Yes | The holder to claw back tokens from. |
holder.type | string | Yes | One of: Account (internal account UUID), Address (XRPL address), or Endpoint (endpoint UUID). |
holder.address | string | Conditional | The holder's XRPL address. Required when holder.type is Address. |
holder.accountId | string | Conditional | Internal account UUID. Required when holder.type is Account. |
holder.endpointId | string | Conditional | Endpoint UUID. Required when holder.type is Endpoint. |
value | string | Yes | The amount to claw back (raw integer value). |
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 works even when a holder's tokens are frozen. This allows issuers to recover tokens from non-compliant or sanctioned addresses.
Typical workflow:
- Multi-purpose tokens — Overview of MPT operations.
- Freeze tokens — Freeze holder before clawback.
- Clawback — XRPL transaction reference.