Minimum base-asset amount accepted for an instant redemption, expressed in the base asset's smallest units. Requested redemptions instead settle at actual attributable proceeds.
Executable redemption route based on the vault's current liquidity and source positions.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ground","description":"Ground developer documentation for Portfolio Wallets, gtokens, MicroVaults, and webhooks.","colors":{"primary":"#0F172A","light":"#334155","dark":"#0F172A"},"logo":{"light":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc","dark":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc","href":"https://groundtech.co"},"favicon":{"light":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/favicon.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=b4171decaf67f0eb8c4959bbf7e273bc","dark":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/favicon.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=b4171decaf67f0eb8c4959bbf7e273bc"},"api":{"playground":{"proxy":true}},"footer":{"links":[{"header":"Docs","items":[{"label":"Introduction","href":"/docs/introduction"},{"label":"Quickstart","href":"/docs/portfolio-wallets/quickstart"},{"label":"API Conventions","href":"/docs/portfolio-wallets/api-conventions"},{"label":"Portfolio Wallets","href":"/docs/portfolio-wallets/create-wallet"},{"label":"MicroVaults","href":"/docs/microvaults/introduction"}]},{"header":"Reference","items":[{"label":"Portfolio Wallet API","href":"/api-reference/list-portfolio-wallet-yield-sources"},{"label":"gtoken API","href":"/api-reference/list-gtoken-yield-sources"},{"label":"MicroVault API","href":"/api-reference/list-microvaults"}]}]},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"braid-4d08f2b7","hasAudioNarration":false,"actualSubdomain":"braid-4d08f2b7","customDomains":["docs.groundtech.co"],"gitSource":{"type":"github","owner":"ground-technology","repo":"ground-monorepo","deployBranch":"mintlify-deployment","contentDirectory":"apps/api/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae08857d674d5fcdf0fe2d5","collectionId":"a0d35e70-09d4-40c6-9146-5838980a3620","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae08857d674d5fcdf0fe2d5"},"entitlements":{},"buildId":"6ae093912ea1296893ea475d","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"Portfolio Wallets","count":60},{"language":"default","tag":"MicroVaults","count":36},{"language":"default","tag":"gtokens","count":33},{"language":"default","tag":"Getting Started","count":15},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Vaults and Sources","count":10},{"language":"default","tag":"Wallet Lifecycle","count":9},{"language":"default","tag":"Wallets","count":8},{"language":"default","tag":"Integration Guides","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navigation-items .nav-anchor[href^=\"/docs/introduction#\"]{margin-left:2rem;margin-bottom:.5rem;font-weight:400}#navigation-items .nav-anchor[href^=\"/docs/introduction#\"]>div{display:none}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"]){display:flex;flex-direction:column}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"])>ul{order:1}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"])>div:has(a[href=\"/docs/introduction\"]){order:0;margin-top:0;margin-bottom:.5rem}"}],"page":{"pagePath":"api-reference/preview-microvault-redemption","slug":"/api-reference/preview-microvault-redemption","pageMetadata":{"title":"Preview a MicroVault redemption","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults/{vaultId}/redemptions/preview","description":"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.","href":"/api-reference/preview-microvault-redemption"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Determine whether a redemption can execute immediately or requires underlying source liquidation.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Preview a MicroVault redemption","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults/{vaultId}/redemptions/preview","description":"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.","href":"/api-reference/preview-microvault-redemption"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["MicroVaults"],"operationId":"previewMicrovaultRedemption","summary":"Preview a shareholder redemption","description":"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.","requestBody":"f13a4e8d-98ab-4709-bab8-eb81b3c41f0c","responses":{"200":"34836e6a-fa13-4bab-b7b6-745c2a5923e7","400":"38de9344-81df-4dae-bc64-820877a9eddd","401":"f2c6f9d4-7110-4f69-80b7-f38f92e72745"},"method":"post","type":"path","servers":["4c1e0bd9-0228-4e96-b858-9f5ad19f1386","eab9aa06-a1ca-4f31-a8ca-cbf3e6fb205f"],"security":["5da4b017-3eca-46bb-b879-e68ce4273d94"],"path":"/v2/microvaults/vaults/{vaultId}/redemptions/preview","baseUrlOptions":["https://sandbox.groundtech.co","https://production.groundtech.co"],"title":"Preview a shareholder redemption","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8c57389c-fd65-4fc8-bd6d-c20029d391c5":{"name":"vaultId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","example":"8f4c52d7-62ab-4db9-a964-92f481f6b851","isRequired":true,"description":"Ground identifier of the MicroVault. This is distinct from its onchain contract address.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Ground identifier of the MicroVault. This is distinct from its onchain contract address."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["owner","receiver","shares","minAssetsOut"],"properties":{"owner":{"type":"string","description":"Wallet that owns the MicroVault shares being redeemed and submits the transaction returned by this endpoint.","maxLength":42,"minLength":42,"pattern":"^0x(?!0{40}$)[0-9a-fA-F]{40}$","example":"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81","isRequired":true,"uniqueKey":"owner","typeLabel":"string"},"receiver":{"type":"string","description":"Wallet that receives the redeemed base asset. This is usually the owner, but it may be a different address.","maxLength":42,"minLength":42,"pattern":"^0x(?!0{40}$)[0-9a-fA-F]{40}$","example":"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81","isRequired":true,"uniqueKey":"receiver","typeLabel":"string"},"shares":{"type":"string","description":"Number of MicroVault shares to redeem in the share token's 18-decimal base units.","pattern":"^(0|[1-9][0-9]*)$","example":"1000000","isRequired":true,"uniqueKey":"shares","typeLabel":"string"},"minAssetsOut":{"type":"string","description":"Minimum base-asset amount accepted for an instant redemption, expressed in the base asset's smallest units. Requested redemptions instead settle at actual attributable proceeds.","pattern":"^(0|[1-9][0-9]*)$","example":"1000000","isRequired":true,"uniqueKey":"minAssetsOut","typeLabel":"string"}},"example":{"owner":"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22","receiver":"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22","shares":"1000000000000000000","minAssetsOut":"990000"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"owner":"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22","receiver":"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22","shares":"1000000000000000000","minAssetsOut":"990000"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"34836e6a-fa13-4bab-b7b6-745c2a5923e7":{"description":"Redemption route and transaction data.","content":{"application/json":{"schema":{"type":"object","required":["plan"],"properties":{"plan":{"type":"object","additionalProperties":true,"description":"Executable redemption route based on the vault's current liquidity and source positions.","required":["mode","action","parameters","directTransaction"],"properties":{"mode":{"type":"string","enum":["instant","requested"],"description":"Whether assets arrive in the submitted transaction or require later source processing and a claim.","isRequired":true,"uniqueKey":"plan.mode","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["redeem_instant","redeem_instant_route","request_redeem"],"description":"Vault function encoded in `directTransaction.data`.","isRequired":true,"uniqueKey":"plan.action","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","additionalProperties":true,"description":"Normalized owner, receiver, share amount, and route constraints used to build the transaction.","isRequired":true,"uniqueKey":"plan.parameters","typeLabel":"object"},"directTransaction":{"type":"object","additionalProperties":true,"description":"Transaction request for the shareholder wallet to submit directly to the MicroVault.","isRequired":true,"uniqueKey":"plan.directTransaction","typeLabel":"object"},"reason":{"oneOf":[{"type":"string","description":"Reason an asynchronous requested route was selected.","uniqueKey":"plan.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason an asynchronous requested route was selected.","uniqueKey":"plan.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.reason","typeLabel":"string | null"},"asyncLegs":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"plan.asyncLegs.items.[INDEX]","typeLabel":"object"},"description":"Yield-source exits expected before a requested redemption becomes claimable.","uniqueKey":"plan.asyncLegs","typeLabel":"object[]"},"timing":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Expected and maximum processing estimates in seconds for asynchronous source exits.","uniqueKey":"plan.timing.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Expected and maximum processing estimates in seconds for asynchronous source exits.","uniqueKey":"plan.timing.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.timing","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"plan","typeLabel":"object"}},"example":{"plan":{"mode":"requested","action":"request_redeem","parameters":{"owner":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","receiver":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","shares":"5000000000000000000"},"reason":"insufficient_synchronous_liquidity","asyncLegs":[{"sourceId":"0x1111111111111111111111111111111111111111111111111111111111111111","sourceName":"Invesco USTB","expectedAssets":"4998100","expectedProcessingSeconds":86400,"maxProcessingSeconds":259200}],"timing":{"expectedSeconds":86400,"maximumSeconds":259200},"directTransaction":{"executionMode":"end_user_direct_transaction","relayable":false,"from":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","to":"0x848837d997f0ce3f753d4644ee51b837ab8b386e","data":"0xabcdef01","value":"0","chainId":11155111}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"plan":{"mode":"requested","action":"request_redeem","parameters":{"owner":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","receiver":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","shares":"5000000000000000000"},"reason":"insufficient_synchronous_liquidity","asyncLegs":[{"sourceId":"0x1111111111111111111111111111111111111111111111111111111111111111","sourceName":"Invesco USTB","expectedAssets":"4998100","expectedProcessingSeconds":86400,"maxProcessingSeconds":259200}],"timing":{"expectedSeconds":86400,"maximumSeconds":259200},"directTransaction":{"executionMode":"end_user_direct_transaction","relayable":false,"from":"0x76f8fc6667E239f83a547d4e16225d6a34f6FA22","to":"0x848837d997f0ce3f753d4644ee51b837ab8b386e","data":"0xabcdef01","value":"0","chainId":11155111}}}}},"exampleType":"generated"}},"exampleType":"generated"},"38de9344-81df-4dae-bc64-820877a9eddd":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","example":"invalid_request","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"details":{"oneOf":[{"description":"Structured context for the error, when available.","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Structured context for the error, when available.","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"}},"example":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"}}},"exampleType":"generated"}},"exampleType":"generated"},"f2c6f9d4-7110-4f69-80b7-f38f92e72745":{"description":"The request is missing a valid bearer token, or the token is invalid or expired.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Authentication or authorization error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Additional auth middleware detail, when present.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional auth middleware detail, when present.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","enum":["unauthenticated","forbidden"],"description":"Some auth and scope failures include a stable code; middleware errors may omit it.","uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["unauthenticated","forbidden"],"description":"Some auth and scope failures include a stable code; middleware errors may omit it.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthenticated request","message":"Missing or invalid bearer token"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthenticated request","message":"Missing or invalid bearer token"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"5da4b017-3eca-46bb-b879-e68ce4273d94":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4c1e0bd9-0228-4e96-b858-9f5ad19f1386":{"url":"https://sandbox.groundtech.co"},"eab9aa06-a1ca-4f31-a8ca-cbf3e6fb205f":{"url":"https://production.groundtech.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"swagger/swagger-combined.yaml"},"subdomain":"braid-4d08f2b7","siteName":"Ground","title":"Preview a MicroVault redemption - Ground","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-11T20:51:28.717Z","originalFileLocation":"api-reference/preview-microvault-redemption.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ground\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview a MicroVault redemption - Ground\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ground\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.groundtech.co/api-reference/preview-microvault-redemption\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://braid-4d08f2b7.mintlify.app/_mintlify/api/og/v2?division=Redemptions\u0026amp;title=Preview+a+MicroVault+redemption\u0026amp;description=Returns+an+instant+route+when+liquidity+is+available%2C+otherwise+a+requested+route+that+settles+at+actual+attributable+proceeds.\u0026amp;theme=a63f7a1c49707387ffb29914\u0026amp;signature=def17361ed4e6667697f400986f8a30384c53d3b07637170af779d8d876400d6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Preview a MicroVault redemption - Ground\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://braid-4d08f2b7.mintlify.app/_mintlify/api/og/v2?division=Redemptions\u0026amp;title=Preview+a+MicroVault+redemption\u0026amp;description=Returns+an+instant+route+when+liquidity+is+available%2C+otherwise+a+requested+route+that+settles+at+actual+attributable+proceeds.\u0026amp;theme=a63f7a1c49707387ffb29914\u0026amp;signature=def17361ed4e6667697f400986f8a30384c53d3b07637170af779d8d876400d6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ground\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.groundtech.co/api-reference/preview-microvault-redemption\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/preview-microvault-redemption.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.groundtech.co/#organization\",\"name\":\"Ground\",\"url\":\"https://docs.groundtech.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.groundtech.co#website\",\"name\":\"Ground\",\"url\":\"https://docs.groundtech.co\",\"publisher\":{\"@id\":\"https://docs.groundtech.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption#webpage\",\"url\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption\",\"name\":\"Preview a MicroVault redemption\",\"description\":\"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\",\"dateModified\":\"2026-09-11T20:51:28.717Z\",\"isPartOf\":{\"@id\":\"https://docs.groundtech.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.groundtech.co/api-reference/list-microvaults\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview a MicroVault redemption\",\"item\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption#apireference\",\"headline\":\"Preview a MicroVault redemption\",\"name\":\"Preview a MicroVault redemption\",\"description\":\"Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.\",\"url\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption\",\"mainEntityOfPage\":{\"@id\":\"https://docs.groundtech.co/api-reference/preview-microvault-redemption#webpage\"},\"dateModified\":\"2026-09-11T20:51:28.717Z\",\"publisher\":{\"@id\":\"https://docs.groundtech.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.groundtech.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ground\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ground","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/docs/introduction"}]},{"tab":"Portfolio Wallets","pages":[{"title":"Portfolio Wallets","href":"/docs/portfolio-wallets/introduction"}]},{"tab":"gtokens","pages":[{"title":"gtokens","href":"/docs/gtokens/introduction"}]},{"tab":"MicroVaults","groups":[{"group":"Getting Started","pages":[{"title":"MicroVaults","href":"/docs/microvaults/introduction"},{"title":"MicroVault quickstart","href":"/docs/microvaults/quickstart"},{"title":"Concepts and control model","href":"/docs/microvaults/concepts"},{"title":"Supported chains and yield sources","href":"/docs/microvaults/supported-chains-and-sources"}]},{"group":"Vault Lifecycle","pages":[{"title":"Create a MicroVault","href":"/docs/microvaults/create-vault"},{"title":"Manage shareholders","href":"/docs/microvaults/shareholders"},{"title":"Configure strategy and source modes","href":"/docs/microvaults/strategy"},{"title":"Configure fees","href":"/docs/microvaults/fees"},{"title":"Subscribe from an external wallet","href":"/docs/microvaults/subscribe"},{"title":"Redeem MicroVault shares","href":"/docs/microvaults/redeem"},{"title":"Export vault authority","href":"/docs/microvaults/export-authority"}]},{"group":"Operations","pages":[{"title":"Use emergency controls","href":"/docs/microvaults/emergency-controls"},{"title":"Synchronous and asynchronous operations","href":"/docs/microvaults/async-operations"},{"title":"Statuses, activity, and performance","href":"/docs/microvaults/status-and-performance"},{"title":"Sandbox testing","href":"/docs/microvaults/sandbox-testing"}]},{"group":"Resources","pages":[{"title":"MicroVault contracts","href":"/docs/microvaults/contracts"},{"title":"Security and trust model","href":"/docs/microvaults/security"}]},{"group":"API Reference","pages":[{"group":"Vaults and Sources","pages":[{"title":"List MicroVaults","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults","href":"/api-reference/list-microvaults"},{"title":"Create a MicroVault","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults","href":"/api-reference/create-microvault"},{"title":"Get a MicroVault","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}","href":"/api-reference/get-microvault"},{"title":"List MicroVault yield sources","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/yield-sources","href":"/api-reference/list-microvault-yield-sources"},{"title":"List MicroVault source positions","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/sources","href":"/api-reference/list-microvault-sources"},{"title":"Update MicroVault strategy","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/strategy","href":"/api-reference/update-microvault-strategy"},{"title":"Update MicroVault source mode","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/sources/{sourceId}/mode","href":"/api-reference/update-microvault-source-mode"},{"title":"Update MicroVault fees","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/fees","href":"/api-reference/update-microvault-fees"},{"title":"Update MicroVault pause controls","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/pause","href":"/api-reference/update-microvault-pause"},{"title":"Get MicroVault pause status","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/pause-status","href":"/api-reference/get-microvault-pause-status"}]},{"group":"Performance and Activity","pages":[{"title":"Get MicroVault performance summary","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/performance-summary","href":"/api-reference/get-microvault-performance-summary"},{"title":"Get MicroVault performance series","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/performance-series","href":"/api-reference/get-microvault-performance-series"},{"title":"List MicroVault activity","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/activity","href":"/api-reference/list-microvault-activity"}]},{"group":"Shareholders","pages":[{"title":"Get MicroVault shareholders","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/shareholders","href":"/api-reference/get-microvault-shareholders"},{"title":"Add a MicroVault shareholder","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}","href":"/api-reference/add-microvault-shareholder"},{"title":"Remove a MicroVault shareholder","openapi":"swagger/swagger-combined.yaml DELETE /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}","href":"/api-reference/remove-microvault-shareholder"},{"title":"Get shareholder proof","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}/proof","description":"Returns the proof an approved wallet uses to subscribe or receive shares. A `404` means no proof exists on the confirmed onchain list.","href":"/api-reference/get-microvault-shareholder-proof"}]},{"group":"Redemptions","pages":[{"title":"Preview a MicroVault redemption","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults/{vaultId}/redemptions/preview","href":"/api-reference/preview-microvault-redemption"},{"title":"Get a requested redemption","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/redemptions/{requestId}","description":"Returns liquidation progress, actual attributable proceeds, the fixed receiver, and underlying source operations for one asynchronous redemption request.","href":"/api-reference/get-microvault-redemption"}]}]}]}]},"title":"Preview a MicroVault redemption - Ground","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}