{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/wallet/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Configure transaction freeze controls","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":"configure-transaction-freeze-controls","__idx":0},"children":["Configure transaction freeze controls"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transaction freeze controls let you hold funds in place for compliance review, risk management, or regulatory purposes. You can freeze individual transactions or enable automatic freeze on a wallet so that Ripple Custody (Wallet) freezes all incoming deposits by default."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the console procedures, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions"},"children":["Freeze and unfreeze transactions via the console"]},". For the API procedures, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/transaction-freeze-api"},"children":["Freeze and unfreeze transactions via the API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"freeze-actions","__idx":1},"children":["Freeze actions"]},{"$$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":"Action"},"children":["Action"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Console role"},"children":["Console role"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Console procedure"},"children":["Console procedure"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API procedure"},"children":["API procedure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Freeze deposits by default"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions#enable-automatic-freeze-on-a-wallet-via-the-console"},"children":["Enable automatic freeze on a wallet"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api#update-wallet-settings-via-the-api"},"children":["Update wallet settings"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Freeze a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Auditor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions#freeze-an-individual-transaction-via-the-console"},"children":["Freeze an individual transaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/transaction-freeze-api#freeze-a-transaction-via-the-api"},"children":["Freeze a transaction"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unfreeze a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Auditor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions#unfreeze-a-transaction-via-the-console"},"children":["Unfreeze a transaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/transaction-freeze-api#unfreeze-a-transaction-via-the-api"},"children":["Unfreeze a transaction"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check frozen funds"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions#monitor-frozen-balances-via-the-console"},"children":["Monitor frozen balances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/transaction-freeze-api#check-freeze-state-via-the-api"},"children":["Check freeze state"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions:"]}," In the console, owners, administrators, and auditors can freeze and unfreeze transactions. Owners, administrators, and proposers can turn on freeze by default, which is a wallet setting. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/organization-and-access/users-and-roles#transactions"},"children":["User roles and permissions"]},". Freezing and unfreezing through the API needs an API credential of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TRANSACTIONS"]},". Changing wallet settings through the API needs a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLETS"]}," credential."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-freeze-controls-work","__idx":2},"children":["How freeze controls work"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you freeze a transaction, the funds remain in the wallet but move from the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["available balance"]}," to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["frozen balance"]},". Users can't spend, transfer, or include frozen funds in outgoing transactions until you unfreeze them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The wallet's balance view shows:"]},{"$$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":"Balance type"},"children":["Balance type"]},{"$$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":"strong","attributes":{},"children":["Available balance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds available for outgoing transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Frozen balance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds held in a frozen state — visible but not spendable"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pending balance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incoming funds that Ripple Custody (Wallet) hasn't yet released to the available balance or frozen"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each frozen transaction records why it was frozen, and manual decisions take precedence over automatic ones. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions#freeze-types-and-who-can-change-them"},"children":["Freeze types and who can change them"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compliance-use-cases","__idx":3},"children":["Compliance use cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Freeze controls support a range of compliance and risk management scenarios:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AML/sanctions screening"]}," — freeze incoming deposits until your compliance team completes screening checks."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Suspicious activity investigation"]}," — freeze a transaction while you investigate unusual activity on a wallet."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Regulatory holds"]}," — place a hold on funds in response to a regulatory request or legal order."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Audit trail"]}," — Ripple Custody (Wallet) records every freeze and unfreeze action with the user, timestamp, and reason. Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/audit-logging"},"children":["audit logging"]}," to export this data for compliance reporting."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Pair with approval groups"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For additional governance, set up a transaction approval group so that outgoing transactions require human approval. Freeze controls govern incoming funds; approval groups govern outgoing funds. Together, they provide end-to-end oversight. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/governance-and-controls/approvals/configure-approval-flows"},"children":["Configure approval flows"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-documentation","__idx":4},"children":["Related documentation"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/freeze-and-unfreeze-transactions"},"children":["Freeze and unfreeze transactions via the console"]}," — Enable automatic freeze, freeze and unfreeze transactions, and monitor frozen balances in the console"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/transactions/view-and-track-transactions#view-a-transaction-via-the-console"},"children":["View and track transactions"]}," — Find a transaction and open its transaction page"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/transactions/receive-assets"},"children":["Receive assets"]}," — How deposits appear, including frozen deposits"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets"},"children":["Manage wallets"]}," — Enable automatic freeze in wallet settings"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/integrations-and-monitoring/audit-logging"},"children":["Audit logging"]}," — Track freeze and unfreeze activity"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/compliance/transaction-freeze-api"},"children":["Freeze and unfreeze transactions via the API"]}," — Freeze, unfreeze, and check freeze state programmatically"]}]}]},"headings":[{"value":"Configure transaction freeze controls","id":"configure-transaction-freeze-controls","depth":1},{"value":"Freeze actions","id":"freeze-actions","depth":2},{"value":"How freeze controls work","id":"how-freeze-controls-work","depth":2},{"value":"Compliance use cases","id":"compliance-use-cases","depth":2},{"value":"Related documentation","id":"related-documentation","depth":2}],"frontmatter":{"title":"Configure transaction freeze controls","seo":{"title":"Configure transaction freeze controls"}},"lastModified":"2026-10-09T11:09:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallet/compliance/transaction-freeze","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}