{"templateId":"markdown","versions":[{"version":"v1.40","label":"v1.40 STS","link":"/products/custody/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/v1.39/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Freeze and unfreeze MPT tokens","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"freeze-and-unfreeze-mpt-tokens","__idx":0},"children":["Freeze and unfreeze MPT tokens"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Control token transfers by freezing individual holders or the entire MPT issuance."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-freezing-works","__idx":1},"children":["How freezing works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Issuers can freeze tokens at two levels:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Individual freeze"]}," — Freeze a specific holder's balance."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Global freeze"]}," — Freeze all holders of the MPT."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When tokens are frozen, the holder cannot send or receive tokens until unfrozen."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Freezing requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lsfMPTCanLock"]}," to be set during issuance. If this flag is not set, the issuer cannot freeze tokens."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":2},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You are the issuer of the MPT"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The MPT has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lsfMPTCanLock"]}," enabled"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"freeze-a-specific-holder","__idx":3},"children":["Freeze a specific holder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To freeze a specific holder's tokens, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MPTokenIssuanceSet"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tfMPTLock"]}," flag:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"id\": \"{{intent_id}}\",\n    \"accountId\": \"{{issuer_account_id}}\",\n    \"parameters\": {\n      \"type\": \"XRPL\",\n      \"feeStrategy\": {\n        \"priority\": \"Medium\",\n        \"type\": \"Priority\"\n      },\n      \"operation\": {\n        \"type\": \"MPTokenIssuanceSet\",\n        \"tokenIdentifier\": {\n          \"issuanceId\": \"000004C463C52827307480341125DA0577AFFC21D4B2D0831E\",\n          \"type\": \"MPTokenIssuanceId\"\n        },\n        \"holder\": {\n          \"address\": \"rHolderAddress...\",\n          \"type\": \"Address\"\n        },\n        \"flags\": [\"tfMPTLock\"]\n      }\n    },\n    \"customProperties\": {},\n    \"type\": \"v0_CreateTransactionOrder\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unfreeze-a-specific-holder","__idx":4},"children":["Unfreeze a specific holder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To unfreeze a holder, use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tfMPTUnlock"]}," flag:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"id\": \"{{intent_id}}\",\n    \"accountId\": \"{{issuer_account_id}}\",\n    \"parameters\": {\n      \"type\": \"XRPL\",\n      \"feeStrategy\": {\n        \"priority\": \"Medium\",\n        \"type\": \"Priority\"\n      },\n      \"operation\": {\n        \"type\": \"MPTokenIssuanceSet\",\n        \"tokenIdentifier\": {\n          \"issuanceId\": \"000004C463C52827307480341125DA0577AFFC21D4B2D0831E\",\n          \"type\": \"MPTokenIssuanceId\"\n        },\n        \"holder\": {\n          \"address\": \"rHolderAddress...\",\n          \"type\": \"Address\"\n        },\n        \"flags\": [\"tfMPTUnlock\"]\n      }\n    },\n    \"customProperties\": {},\n    \"type\": \"v0_CreateTransactionOrder\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"global-freeze","__idx":5},"children":["Global freeze"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To freeze all holders, omit the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder"]}," field:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"operation\": {\n    \"type\": \"MPTokenIssuanceSet\",\n    \"tokenIdentifier\": {\n      \"issuanceId\": \"000004C463C52827307480341125DA0577AFFC21D4B2D0831E\",\n      \"type\": \"MPTokenIssuanceId\"\n    },\n    \"flags\": [\"tfMPTLock\"]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"parameters","__idx":6},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenIdentifier.issuanceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 192-bit MPT issuance ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenIdentifier.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MPTokenIssuanceId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The holder to freeze. Omit for global freeze."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One of: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Account"]}," (internal account UUID), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Address"]}," (XRPL address), or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Endpoint"]}," (endpoint UUID). Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder"]}," is provided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The holder's XRPL address. Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Address"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal account UUID. Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Account"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.endpointId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Endpoint UUID. Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["holder.type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Endpoint"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"tfMPTLock\"]"]}," to freeze, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"tfMPTUnlock\"]"]}," to unfreeze."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":7},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful request returns the transaction order with status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pending"]},". After confirmation, the holder's (or all holders') transfer capabilities are updated."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":8},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.38/accounts-and-assets/tokenization/xrpl-mpts#supported-operations"},"children":["Multi-purpose tokens"]}," — Overview of MPT operations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.38/accounts-and-assets/tokenization/xrpl-mpts#token-flags"},"children":["Token flags"]}," — Flag descriptions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.38/accounts-and-assets/tokenization/xrpl-mpts/issuer/clawback"},"children":["Clawback"]}," — Recover tokens from frozen holders."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xrpl.org/docs/references/protocol/transactions/types/mptokenissuanceset","target":"_blank"},"children":["MPTokenIssuanceSet"]}," — XRPL transaction reference."]}]}]},"headings":[{"value":"Freeze and unfreeze MPT tokens","id":"freeze-and-unfreeze-mpt-tokens","depth":1},{"value":"How freezing works","id":"how-freezing-works","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Freeze a specific holder","id":"freeze-a-specific-holder","depth":2},{"value":"Unfreeze a specific holder","id":"unfreeze-a-specific-holder","depth":2},{"value":"Global freeze","id":"global-freeze","depth":2},{"value":"Parameters","id":"parameters","depth":2},{"value":"Response","id":"response","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"Freeze and unfreeze MPT tokens"}},"lastModified":"2026-07-27T10:10:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.38/accounts-and-assets/tokenization/xrpl-mpts/issuer/freeze","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}