{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/accounts-and-assets/omnibus/overview","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/accounts-and-assets/omnibus/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/accounts-and-assets/omnibus/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/accounts-and-assets/omnibus/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/accounts-and-assets/omnibus/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/accounts-and-assets/omnibus/overview","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Omnibus","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":"omnibus","__idx":0},"children":["Omnibus"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Executive summary"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Omnibus lets an organization hold pooled on-chain funds in a single custody account while tracking each tenant's share off-chain."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A single omnibus wallet holds accepted funds on-chain."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Virtual accounts track tenant balances and movements off-chain."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dedicated deposit wallets identify incoming funds before Omnibus sweeps them into the omnibus wallet."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Intra-omnibus transfers are off-chain and do not create blockchain transactions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Withdrawals and other on-chain movements still follow custody policies, approvals, and signing controls."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Why this matters"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus reduces blockchain fees and settlement delays for high-volume pooled custody, trading, tokenization, asset-management, and repurchase-agreement workflows. Instead of creating and operating many segregated wallets, operators can pool accepted assets on-chain and use off-chain accounting to represent each tenant's position."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For architects and operators, Omnibus changes how you design domains, policies, fee sponsorship, and monitoring. Operators must monitor the on-chain balance of the omnibus wallet and the off-chain virtual account records together."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Current scope"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This release does not support native assets, cross-chain liquidity, automatic tenant assignment for direct deposits to the omnibus wallet, or delivery of Omnibus events to external consumers. Omnibus currently supports non-native assets on Solana, XRPL, and EVM networks, constrained by Gas Station coverage."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-omnibus-works","__idx":1},"children":["How Omnibus works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus scopes each structure to a ","Ripple Custody"," domain. The structure combines:"]},{"$$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":"Component"},"children":["Component"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omnibus wallet"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custody account that holds pooled funds on-chain. Withdrawals leave from this account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Virtual accounts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Off-chain records that represent tenant positions in the pooled funds. The API uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tenantId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/tenants"]}," for these resources."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host virtual account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First virtual account created with the omnibus structure. It holds unassigned funds and absorbs fee compensation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deposit wallets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custody accounts dedicated to virtual accounts for external deposits. Omnibus sweeps funds into the omnibus wallet after confirmation and quarantine release."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accounting Service"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source of truth for settled virtual account balances, statements, audit trail, and exports."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fee funding for non-native token sweeps on supported Solana, XRPL, and EVM networks."]}]}]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n External[\"External wallet\"] -->|\"Deposit\"| DepositWallet[\"Deposit wallet\"]\n DepositWallet -->|\"Sweep after confirmation and quarantine release\"| OmnibusWallet[\"Omnibus wallet\"]\n OmnibusWallet -->|\"Withdrawal\"| Destination[\"External or same-instance destination\"]\n\n subgraph Records[\"Off-chain virtual account records\"]\n Host[\"Host virtual account\"]\n TenantA[\"Tenant A virtual account\"]\n TenantB[\"Tenant B virtual account\"]\n end\n\n DepositWallet -. \"Credits after sweep\" .-> TenantA\n TenantA -. \"Internal transfer\" .-> TenantB\n Host -. \"Fee compensation\" .-> OmnibusWallet\n","diagramHtml":"

Off-chain virtual account records

Deposit

Sweep after confirmation and quarantine release

Withdrawal

Credits after sweep

Internal transfer

Fee compensation

External wallet

Deposit wallet

Omnibus wallet

External or same-instance destination

Host virtual account

Tenant A virtual account

Tenant B virtual account

","diagramHtmlDark":"

Off-chain virtual account records

Deposit

Sweep after confirmation and quarantine release

Withdrawal

Credits after sweep

Internal transfer

Fee compensation

External wallet

Deposit wallet

Omnibus wallet

External or same-instance destination

Host virtual account

Tenant A virtual account

Tenant B virtual account

"},"children":["flowchart LR\n External[\"External wallet\"] -->|\"Deposit\"| DepositWallet[\"Deposit wallet\"]\n DepositWallet -->|\"Sweep after confirmation and quarantine release\"| OmnibusWallet[\"Omnibus wallet\"]\n OmnibusWallet -->|\"Withdrawal\"| Destination[\"External or same-instance destination\"]\n\n subgraph Records[\"Off-chain virtual account records\"]\n Host[\"Host virtual account\"]\n TenantA[\"Tenant A virtual account\"]\n TenantB[\"Tenant B virtual account\"]\n end\n\n DepositWallet -. \"Credits after sweep\" .-> TenantA\n TenantA -. \"Internal transfer\" .-> TenantB\n Host -. \"Fee compensation\" .-> OmnibusWallet\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-use-cases","__idx":2},"children":["Common use cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Omnibus when you need to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hold assets for many tenants while minimizing the number of on-chain custody accounts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Give each tenant a dedicated deposit address while pooling accepted funds."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Support instant, fee-free movements between virtual accounts in the same omnibus structure."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monitor a pooled blockchain balance against tenant-level off-chain positions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sponsor sweep gas centrally rather than requiring every deposit wallet to hold native tokens."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"omnibus-vs-regular-accounts","__idx":3},"children":["Omnibus vs. regular accounts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Regular ","Ripple Custody"," accounts are on-chain custody wallets. Balances, transactions, and policies attach directly to those accounts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Omnibus adds an off-chain accounting layer. The omnibus wallet is still a regular custody account, but virtual accounts do not hold private keys or blockchain addresses themselves. They represent claims on pooled funds and can move value internally without creating blockchain transactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"lifecycle","__idx":4},"children":["Lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At a high level, an omnibus structure moves through these stages:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Plan"]}," the domain, Gas Station setup, Omnibus system-signed policy, and balance-monitoring model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]}," the omnibus structure and omnibus wallet through the normal intent flow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configure automation"]}," for deposit wallet creation, sweeps, and ledger propagation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create virtual accounts"]}," for tenants."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate deposit wallets"]}," lazily when a tenant requests deposit addresses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operate"]}," deposits, withdrawals, and internal transfers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor"]}," virtual account balances against the omnibus wallet and customer systems."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":5},"children":["Limitations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A tenant is not a ","Ripple Custody"," user or domain. A virtual account represents the tenant's Omnibus position. Mapping users to tenants and virtual accounts is the customer's responsibility unless the Omnibus UI or customer integration enforces a stricter model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Omnibus can't automatically assign funds sent directly to the omnibus wallet to a specific tenant in this release. Omnibus credits those funds to the host virtual account after confirmation and quarantine release."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tenants must withdraw assets on the same ledger where they deposited them. Cross-chain liquidity is out of scope."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Omnibus currently supports non-native assets on Solana, XRPL, and EVM networks only."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The host virtual account can become negative when Omnibus compensates fees after deposits or withdrawals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deposit wallets inherit ledgers from the omnibus wallet. Adding a ledger directly to a deposit wallet can cause sweeps to fail if the omnibus wallet cannot receive that ledger."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":6},"children":["Next steps"]},{"$$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":"Task"},"children":["Task"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Documentation"},"children":["Documentation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Plan setup and controls"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/setup-and-governance"},"children":["Setup and governance"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Understand deposits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/deposits"},"children":["Deposits"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Understand withdrawals"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/withdrawals"},"children":["Withdrawals"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Move funds between virtual accounts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/internal-transfers"},"children":["Internal transfers"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Review balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/balances-and-reconciliation"},"children":["Balances"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage in the UI"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/manage-omnibus-ui"},"children":["Manage an omnibus account in the UI"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage with the API"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/omnibus/manage-omnibus-api"},"children":["Manage omnibus with the API"]}]}]}]}]}]}]},"headings":[{"value":"Omnibus","id":"omnibus","depth":1},{"value":"How Omnibus works","id":"how-omnibus-works","depth":2},{"value":"Common use cases","id":"common-use-cases","depth":2},{"value":"Omnibus vs. regular accounts","id":"omnibus-vs-regular-accounts","depth":2},{"value":"Lifecycle","id":"lifecycle","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Omnibus"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/accounts-and-assets/omnibus/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}