Freeze and unfreeze MPT tokens

Control token transfers by freezing individual holders or the entire MPT issuance.

Issuers can freeze tokens at two levels:

• Individual freeze — Freeze a specific holder's balance.
• Global freeze — Freeze all holders of the MPT.

When tokens are frozen, the holder cannot send or receive tokens until unfrozen.

• You are the issuer of the MPT
• The MPT has lsfMPTCanLock enabled

To freeze a holder or all holders:

1. Go to Accounts and open the issuer account.

2. Click Create order and select Ledger-specific operations.

3. In Ledger, select the XRP Ledger network.

4. In Operation, select Freeze one or all holders.

5. In Freeze scope, select one of these options:

   • Individual holder — Then, in Holder, select the holder's account.
   • All holders — A warning confirms that all transfers for every holder stop until you unfreeze all holders.

6. Select the token:

   • Listed asset — Select the token from the list.
   • Unlisted asset — Enter the token's issuance ID.
   

7. Select a Fee Strategy, then click Submit for approval and sign the operation with the app. The signing window shows the operation as MPT Issuance Set with the setting Freeze. For an individual freeze, it also shows the holder.

   

To unfreeze, follow the same steps and select Unfreeze one or all holders in Operation. Use the same scope that you froze with. A global freeze stays in place until you unfreeze All holders, even if you unfreeze individual holders.

To freeze a specific holder's tokens, use MPTokenIssuanceSet with the tfMPTLock flag:

{
  "payload": {
    "id": "{{intent_id}}",
    "accountId": "{{issuer_account_id}}",
    "ledgerId": "xrpl-testnet",
    "parameters": {
      "type": "XRPL",
      "feeStrategy": {
        "priority": "Medium",
        "type": "Priority"
      },
      "memos": [],
      "operation": {
        "type": "MPTokenIssuanceSet",
        "tokenIdentifier": {
          "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D083",
          "type": "MPTokenIssuanceId"
        },
        "holder": {
          "address": "rHolderAddress...",
          "type": "Address"
        },
        "flags": ["tfMPTLock"]
      }
    },
    "customProperties": {},
    "type": "v0_CreateTransactionOrder"
  }
}

To unfreeze a holder, use the tfMPTUnlock flag:

{
  "payload": {
    "id": "{{intent_id}}",
    "accountId": "{{issuer_account_id}}",
    "ledgerId": "xrpl-testnet",
    "parameters": {
      "type": "XRPL",
      "feeStrategy": {
        "priority": "Medium",
        "type": "Priority"
      },
      "memos": [],
      "operation": {
        "type": "MPTokenIssuanceSet",
        "tokenIdentifier": {
          "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D083",
          "type": "MPTokenIssuanceId"
        },
        "holder": {
          "address": "rHolderAddress...",
          "type": "Address"
        },
        "flags": ["tfMPTUnlock"]
      }
    },
    "customProperties": {},
    "type": "v0_CreateTransactionOrder"
  }
}

To freeze all holders, omit the holder field:

{
  "operation": {
    "type": "MPTokenIssuanceSet",
    "tokenIdentifier": {
      "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D083",
      "type": "MPTokenIssuanceId"
    },
    "flags": ["tfMPTLock"]
  }
}

A successful request returns the transaction order with status Pending. After confirmation, the holder's (or all holders') transfer capabilities are updated.

• Multi-purpose tokens — Overview of MPT operations.
• Token flags — Flag descriptions.
• Clawback — Recover tokens from frozen holders.
• MPTokenIssuanceSet — XRPL transaction reference.