{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/wallet/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Vaults overview","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":"vaults-overview","__idx":0},"children":["Vaults overview"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"In this section"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults"},"children":["Manage vaults"]}," – Create, list, view, update, and tag vaults in the console or through the API"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"vault-actions","__idx":1},"children":["Vault 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":["Create a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#create-a-vault-via-the-console"},"children":["Create a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#create-a-vault-via-the-api"},"children":["Create a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List vaults"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#list-vaults-via-the-console"},"children":["List vaults"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#list-vaults-via-the-api"},"children":["List vaults via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#view-a-vault-via-the-console"},"children":["View a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#get-a-vault-via-the-api"},"children":["Get a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#edit-or-delete-a-vault-via-the-console"},"children":["Edit or delete a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#update-a-vault-via-the-api"},"children":["Update a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check vault balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/understanding-balances#viewing-balances"},"children":["Viewing balances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api#get-vault-balances-via-the-api"},"children":["Get vault balances"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tag a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#tag-a-vault-via-the-console"},"children":["Tag a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults/manage-vaults#tag-a-vault-via-the-api"},"children":["Tag a vault via the API"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-is-a-vault","__idx":2},"children":["What is a vault?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A vault in Ripple Custody (Wallet) is a logical collection of wallets."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Vaults are used to bundle common wallet use-cases together. In other words, if you have multiple wallets that are used for a common purpose such as paying merchants or automating your savings, then these wallets can be kept together in the same vault."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"vault-organization-strategies","__idx":3},"children":["Vault organization strategies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use vaults to separate wallets by:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business unit"]}," — one vault per department or team"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Risk profile"]}," — separate hot wallets (frequent transactions) from cold storage"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Asset class"]}," — group wallets by blockchain or asset type"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environment"]}," — separate operational wallets from test wallets in sandbox"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-vault-setup","__idx":4},"children":["Common vault setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Users are free to setup and organize their vaults however they wish, however the following setup comprising 3 separate vaults is quite common on the Ripple Custody (Wallet) platform:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Treasury vault"]},": contains all wallets that hold funds belonging to the organization on a long-term basis. These wallets can only transact with wallets inside the Outbound vault. No API credential is allowed to interact with wallets inside this vault."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outbound vault"]},": contains all wallets that hold funds which are earmarked for outbound transfers. In a typical flow, these wallets receive funds from wallets inside the Treasury vault and execute transfers to wallets that are external to Ripple Custody (Wallet). API credentials have access to these wallets as they can only transact using allocated funds."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer vault"]},": contains all wallets that hold funds on behalf of a customer. These are omnibus style wallets that receive deposits and process withdrawals on behalf of a customer. These wallets only process inbound transactions from the customer's wallet (external to Ripple Custody (Wallet)) and outbound to either the customer or to wallets inside the Treasury vault. API credentials have access to these wallets to perform sweep operations."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Wallets, once created inside a vault, cannot be moved to another vault."]}]}]},"headings":[{"value":"Vaults overview","id":"vaults-overview","depth":1},{"value":"Vault actions","id":"vault-actions","depth":2},{"value":"What is a vault?","id":"what-is-a-vault","depth":2},{"value":"Vault organization strategies","id":"vault-organization-strategies","depth":2},{"value":"Common vault setup","id":"common-vault-setup","depth":2}],"frontmatter":{"title":"Vaults overview","seo":{"title":"Vaults overview"}},"lastModified":"2026-10-09T11:09:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallet/vaults-and-wallets/vaults","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}