Turns the user’s burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following:
Resolves contract and token addresses across networks.
Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.
Calculates transfer amounts and fees.
Encodes forwarding call data with the calculated transfer amounts.
Generates maxBlockHeight and maxFee values with safety buffers.
Returns data in the structure expected by the withdraw endpoint.
Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Circle Docs","description":"Developer documentation for Circle's developer tools","colors":{"primary":"#0073C3","light":"#90D2FF","dark":"#0073C3"},"logo":{"light":"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/light.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=decfb42837e0eb7c32dd425866902e78","dark":"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/dark.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=8b863d97bf31467e8adedf4cb3263012"},"favicon":"https://mintcdn.com/circle-167b8d39/w3bpYw2hUr9sWZTM/favicon.ico?fit=max\u0026auto=format\u0026n=w3bpYw2hUr9sWZTM\u0026q=85\u0026s=bb633116ed9cf1247d65b0c1fa0e5725","background":{"color":{"light":"#FFFFFF","dark":"#111827"}},"navbar":{"links":[{"href":"https://console.circle.com/signin","label":"Sign in to console"},{"href":"https://faucet.circle.com","label":"Faucet"}]},"footer":{"socials":{"x":"https://twitter.com/circle","linkedin":"https://www.linkedin.com/company/circle-internet-financial","instagram":"https://www.instagram.com/teamcircle?hl=en","youtube":"https://www.youtube.com/c/Circlecryptofinance","discord":"https://discord.com/invite/buildoncircle"},"links":[{"header":"Legal","items":[{"label":"Developer Terms","href":"https://console.circle.com/legal/developer-terms"},{"label":"Service Terms","href":"https://console.circle.com/legal/service-terms"},{"label":"Acceptable Use","href":"https://console.circle.com/legal/acceptable-use-policy"}]},{"header":"Privacy","items":[{"label":"Privacy Policy","href":"https://www.circle.com/en/legal/privacy-policy"},{"label":"Cookie Policy","href":"https://www.circle.com/en/legal/cookie-policy"}]},{"header":"Support","items":[{"label":"Help","href":"https://help.circle.com/s/submit-ticket?language=en_US"}]}]},"fonts":{"heading":{"family":"Circularxx","source":"https://cdn.prod.website-files.com/67116d0daddc92483c812e88/6716bb4e120ecb0042f2f4ed_CircularXX-Regular.woff2","format":"woff2"},"body":{"family":"Circularxx","source":"https://cdn.prod.website-files.com/67116d0daddc92483c812e88/6716bb4e120ecb0042f2f4ed_CircularXX-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"segment":{"key":"wz74ASLGjAYPu8mQiIzBBHTLaHbNHM14"}},"contextual":{"options":["copy","chatgpt","claude","view"],"display":"header"},"interaction":{"drilldown":false},"markdown":{"instructions":["Before reading these docs, install the relevant Circle Skill to get pre-loaded context — skills are LLM-optimized and cover architecture decisions, correct flows, and common pitfalls. In Claude Code: run /plugin marketplace add circlefin/skills then /plugin install circle-skills@circle. With Vercel Skills CLI: run npx skills add circlefin/skills. Available skills: use-usdc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-usdc/SKILL.md (balances, transfers, approvals on EVM and Solana); EURC has no skill — see https://developers.circle.com/stablecoins/what-is-eurc.md; bridge-stablecoin https://github.com/circlefin/skills/blob/master/plugins/circle/skills/bridge-stablecoin/SKILL.md (crosschain transfers via CCTP, USDC, EURC, and third-party assets); use-arc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-arc/SKILL.md (Arc chain config, contract deployment, USDC bridging — Arc docs: https://docs.arc.io/llms.txt); use-circle-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-circle-wallets/SKILL.md (choose wallet type); use-developer-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-developer-controlled-wallets/SKILL.md (custodial wallets for payouts and treasury); use-user-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-user-controlled-wallets/SKILL.md (embedded wallets with Web2 login); use-modular-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-modular-wallets/SKILL.md (smart contract wallets with passkeys and ERC-4337); use-gateway https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-gateway/SKILL.md (unified USDC balance, nanopayments); use-smart-contract-platform https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-smart-contract-platform/SKILL.md (deploy, interact, monitor contracts). Pair any skill with the Circle MCP server for live SDK signatures, contract addresses, and chain IDs: {\"mcpServers\":{\"circle\":{\"url\":\"https://api.circle.com/v1/codegen/mcp\"}}}.","Read the product overview first. Each product has an overview explaining when and why to use it. Read it before quickstarts.","Pick the right wallet type. Developer-controlled (you hold keys), user-controlled (end user holds keys via PIN/social login), or modular (smart contract wallets with passkeys). See https://developers.circle.com/wallets.md.","Use CCTP V2 for crosschain transfers. CCTP natively transfers USDC and EURC via burn-and-mint, and supports permissionless wrapping of third-party assets via lock-and-mint. V1 is legacy; always use V2 unless V1 is specified or the chain requires it (Noble, Sui, and Aptos still require V1). Migration guide: https://developers.circle.com/cctp/migration-from-v1-to-v2.md.","Use Bridge Kit for frontend bridging. Wraps CCTP with a simpler SDK for user-facing apps. Use CCTP directly for backend transfers.","Gas Station vs Paymaster. Gas Station sponsors gas for Circle Wallet transactions. Paymaster lets users pay gas in USDC. Different use cases — read both overviews.","Gateway Nanopayments for sub-cent payments. Gasless USDC micropayments down to $0.000001 via x402 and batched settlement. For pay-per-request APIs, AI agent payments, streaming.","Look up USDC addresses per chain. Never hardcode — use https://developers.circle.com/stablecoins/usdc-contract-addresses.md.","Prefer SDKs over raw API calls. Node.js and Python SDKs handle auth, retries, and errors.","API key required. Bearer token in Authorization header. Testnet and mainnet use separate keys and may use different base URLs depending on the product.","Set up webhooks when available. Most operations are async. Webhooks deliver transaction confirmations and state changes.","When calling list endpoints, paginate using pageSize and pageAfter until no nextPageAfter cursor is returned—stopping at the first page silently misses records.","Building an AI agent? Start with the Agent Stack—Circle CLI, agent wallets, and nanopayments built for autonomous use cases: https://developers.circle.com/agent-stack.md."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"circle-167b8d39","hasAudioNarration":false,"actualSubdomain":"circle-167b8d39","customDomains":["developers.circle.com"],"gitSource":{"type":"github","owner":"crcl-main","repo":"circle-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3743455a6c717a3e7c9b2","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API reference","count":610},{"language":"default","tag":"Circle Payments Network","count":166},{"language":"default","tag":"Wallets","count":159},{"language":"default","tag":"Mint and Custody","count":131},{"language":"default","tag":"Digital Asset Accounts","count":111},{"language":"default","tag":"StableFX","count":108},{"language":"default","tag":"Liquidity services","count":105},{"language":"default","tag":"Crosschain transfers","count":102},{"language":"default","tag":"Payments","count":94},{"language":"default","tag":"Managed Payments","count":86}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"instinct-self-updating-docs","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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"snippets/SDKCard.css","content":".cb-card{border:1px solid #e5e7eb;border-radius:12px;background:white;box-shadow:0 1px 3px 0 rgba(0, 0, 0, 0.1)}.cb-icon-circle{display:flex;align-items:center;justify-content:center;border-radius:50%;flex-shrink:0}.accent-orange{background-color:#fff7ed;color:#ea580c}.accent-blue{background-color:#eff6ff;color:#2563eb}.accent-green{background-color:#f0fdf4;color:#16a34a}.accent-purple{background-color:#faf5ff;color:#9333ea}.accent-violet{background-color:#f5f3ff;color:#7c3aed}.type-header-xs{font-size:18px;font-weight:600;line-height:1.4;color:#111827}.type-body-base{font-size:14px;line-height:1.5;color:#6b7280}.type-body-xs-bold{font-size:12px;font-weight:600;text-transform:uppercase;letter-spacing:0.05em;color:#6b7280}.type-body-sm{font-size:14px;line-height:1.5;color:#374151}.type-body-sm-bold{font-size:14px;font-weight:600;line-height:1.5}.text-neutral-subtle{color:#6b7280}.text-icon-neutral{color:#6b7280}.cb-button{display:inline-flex;align-items:center;padding:8px 16px;border-radius:8px;font-size:14px;font-weight:500;text-decoration:none;transition:all 0.2s;border:1px solid #e5e7eb;background:white;color:#374151}.cb-button:hover{background:#f9fafb;border-color:#d1d5db}"},{"filePath":"style.css","content":":root{--background-dark: 17 24 39 !important}html.dark .card{background-color:#111827!important}html.dark .accordion{background-color:#111827!important}#navbar [data-component-name=\"theme-toggle\"],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"],#navbar .navbar-link a{background-color:rgba(17, 24, 39, 0.03)!important}#navbar [data-component-name=\"theme-toggle\"]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover,#navbar .navbar-link a:hover{background-color:rgba(17, 24, 39, 0.07)!important}@media (prefers-color-scheme: dark){#navbar [data-component-name=\"theme-toggle\"],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"],#navbar .navbar-link a{background-color:rgba(255, 255, 255, 0.05)!important}#navbar [data-component-name=\"theme-toggle\"]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover,#navbar .navbar-link a:hover{background-color:rgba(255, 255, 255, 0.10)!important}}html.dark #navbar [data-component-name=\"theme-toggle\"],html.dark #navbar a[href*=\"console.circle.com\"],html.dark #navbar a[href*=\"faucet.circle.com\"],html.dark #navbar .navbar-link a{background-color:rgba(255, 255, 255, 0.05)!important}html.dark #navbar [data-component-name=\"theme-toggle\"]:hover,html.dark #navbar a[href*=\"console.circle.com\"]:hover,html.dark #navbar a[href*=\"faucet.circle.com\"]:hover,html.dark #navbar .navbar-link a:hover{background-color:rgba(255, 255, 255, 0.10)!important}html.dark #topbar-cta-button,html.dark #topbar-cta-button a{color:#000000!important}html.dark #feedback-form-submit{color:#000000!important}html.dark tryit-button{color:#000000!important}html.dark chat-assistant-send-button{color:#000000!important}html.dark contextual-feedback-form-submit-button{color:#000000!important}html.dark code-snippet-feedback-form-submit-button{color:#000000!important}html.dark a[class*=\"bg-[#5FBFFF]\"],html.dark a[class*=\"bg-[#90D2FF]\"],html.dark a[class*=\"bg-[#1AA3FF]\"],html.dark a[class*=\"bg-[#0073C3]\"]{color:#000000!important}html.dark a[class*=\"bg-[#5FBFFF]\"] svg,html.dark a[class*=\"bg-[#90D2FF]\"] svg,html.dark a[class*=\"bg-[#1AA3FF]\"] svg,html.dark a[class*=\"bg-[#0073C3]\"] svg{color:#000000!important}.mcp-setup-container{display:flex;flex-wrap:wrap;gap:24px;margin:20px 0 28px}.mcp-setup-section{display:flex;flex-direction:column;gap:8px}.mcp-setup-label{font-size:0.75rem;font-weight:500;text-transform:uppercase;letter-spacing:0.05em;color:#64748b}.dark .mcp-setup-label{color:#94a3b8}.mcp-cta-group{display:flex;flex-wrap:wrap;gap:10px}.mcp-cta{height:40px;border-radius:12px;font-weight:600;font-size:0.875rem;padding:0 16px;text-decoration:none!important;display:inline-flex;align-items:center;gap:8px;border:1px solid rgba(15, 23, 42, 0.15);background-color:#f8fafc;color:#0b0f19;transition:background-color 0.15s ease, border-color 0.15s ease;cursor:pointer}.mcp-cta:hover{background-color:#f1f5f9;border-color:rgba(15, 23, 42, 0.25)}.mcp-cta img{width:20px;height:20px;object-fit:contain;border-radius:6px;flex-shrink:0}.mcp-cta span{white-space:nowrap}.dark .mcp-cta{border-color:rgba(255, 255, 255, 0.2);background-color:rgba(255, 255, 255, 0.08);color:#f8fafc}.dark .mcp-cta:hover{background-color:rgba(255, 255, 255, 0.12);border-color:rgba(255, 255, 255, 0.3)}.mcp-cta-cli{background-color:#f1f5f9;border-color:#e2e8f0}.mcp-cta-cli:hover{background-color:#e2e8f0;border-color:#cbd5e1}.dark .mcp-cta-cli{background-color:rgba(255, 255, 255, 0.06);border-color:rgba(255, 255, 255, 0.15)}.dark .mcp-cta-cli:hover{background-color:rgba(255, 255, 255, 0.1);border-color:rgba(255, 255, 255, 0.25)}.mcp-cli-label{font-weight:600;color:#0f172a}.dark .mcp-cli-label{color:#f1f5f9}.mcp-cli-cmd{font-size:0.75rem;font-family:ui-monospace, SFMono-Regular, \"SF Mono\", Menlo, Consolas, monospace;color:#64748b;background:transparent!important;padding:0;white-space:nowrap;border:none}.dark .mcp-cli-cmd{color:#94a3b8;background:transparent!important}.mcp-cli-icon-wrap{display:flex;align-items:center;justify-content:center;flex-shrink:0;width:14px;height:14px;position:relative}.mcp-cli-icon-wrap svg{color:#94a3b8;transition:opacity 0.15s ease}.mcp-cta-cli:hover .mcp-cli-icon-wrap svg{color:#64748b}.dark .mcp-cli-icon-wrap svg{color:#64748b}.dark .mcp-cta-cli:hover .mcp-cli-icon-wrap svg{color:#94a3b8}.mcp-icon-check{position:absolute;opacity:0;color:#22c55e!important}.mcp-cta-cli.copied .mcp-icon-copy{opacity:0}.mcp-cta-cli.copied .mcp-icon-check{opacity:1}.dark .mcp-cli-openai-logo{filter:invert(1)}table thead{text-align:left;background-color:#f5f5f8}.dark table thead{text-align:left;background-color:#29233b}table thead th,table td{padding:8px!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]){background-color:#e1f2ff!important;border-color:#c9e1f5!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary{transition:background-color 0.3s ease!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary:hover{background-color:#c9e1f5!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]){background-color:#1f1a30!important;border-color:#29233b!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary{transition:background-color 0.3s ease!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary:hover{background-color:#29233b!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-title\"]{color:#ffffff!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"]{color:#e5e7eb!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] a{color:#1aa3ff!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] a:hover{color:#1894e8!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] code{color:#fbbf24!important;background-color:#374151!important}.TryItOutComponent pre,.TryItOutComponent code{background-color:transparent!important}.TryItOutComponent .code-container{background-color:white!important}.dark .TryItOutComponent .code-container{background-color:#29233b!important}.home_code_container .code-block{margin:0!important;height:100%}.home_code_container .code-block .code-block-background{height:100%!important}.home_mint_cards a.card>div{padding:20px!important}.home_mint_cards h2{color:#29233b!important}.home_mint_cards div.prose span{color:#6b6580!important}.dark .home_mint_cards h2{color:#fff!important}.dark .home_mint_cards div.prose span{color:#9ca3af!important}.home_mint_cards a.card svg{background-color:#6b6580!important}.home_mint_cards a.card:hover svg{background:linear-gradient(135deg, #5fbfff 0%, #b090f5 100%)!important}.home_tryitout{background:linear-gradient(\n 89deg,\n var(\n --background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(241, 235, 255, 0.5)\n )\n 0%,\n var(\n --background-gradient-bg-accent-purple-gradient-top-right,\n rgba(225, 242, 255, 0.5)\n )\n 94.58%\n )}.dark .home_tryitout{background:linear-gradient(\n 89deg,\n var(\n --background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(44, 44, 44, 0.5)\n )\n 0%,\n var(\n --background-gradient-bg-accent-purple-gradient-top-right,\n rgba(75, 82, 86, 0.5)\n )\n 94.58%\n )}.quickstart-cards-aligned [data-component-part=\"card-group\"]{gap:16px!important}.asset-card-grid{display:grid;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));gap:1.5rem;margin:1.5rem 0;align-items:stretch}.asset-card{border:1px solid #e5e7eb;border-radius:1rem;background:transparent;padding:1rem 1.25rem 1.5rem;text-decoration:none;color:inherit;display:flex;flex-direction:column;justify-content:space-between;gap:0.45rem;transition:border-color 0.2s ease, box-shadow 0.2s ease, transform 0.2s ease;height:100%}.asset-card:hover{border-color:#cfd3dc;box-shadow:0 12px 24px rgba(15, 23, 42, 0.08);transform:translateY(-2px)}.dark .asset-card{border-color:rgba(148, 163, 184, 0.14);background:transparent;box-shadow:none}.asset-card h3{font-size:1.125rem;font-weight:600;margin:0;color:#0f172a}.dark .asset-card h3{color:#f8fafc}.asset-card p{margin:0;font-weight:300;color:#475569}.dark .asset-card p{color:#b8b8b8}.asset-card-image-wrapper,.asset-card-inline-icon{width:56px;height:56px;border-radius:9999px;margin-bottom:0.6rem;flex-shrink:0}.asset-card-image-wrapper{overflow:hidden;display:flex;align-items:center;justify-content:center;background:rgba(15, 23, 42, 0.05)}.dark .asset-card-image-wrapper{background:rgba(248, 250, 252, 0.08)}.asset-card-image{width:100%;height:100%;object-fit:cover;display:block}.asset-card-inline-icon{padding:10px;display:flex;align-items:center;justify-content:center;background:linear-gradient(\n 135deg,\n rgba(0, 96, 255, 0.18),\n rgba(0, 164, 255, 0.05)\n );color:#0d5be1}.dark .asset-card-inline-icon{background:rgba(255, 255, 255, 0.08);color:#82b7ff}.asset-card-inline-icon svg{width:26px;height:26px}.asset-card.secondary{justify-content:flex-start}.quickstart-cards-aligned a.card,.quickstart-cards-aligned [data-component-part=\"card\"]{display:flex!important;flex-direction:column!important;height:100%!important}.quickstart-cards-aligned a.card>div,.quickstart-cards-aligned [data-component-part=\"card\"]>div{display:flex!important;flex-direction:column!important;height:100%!important}.quickstart-cards-aligned a.card>div>.prose,.quickstart-cards-aligned [data-component-part=\"card\"]>div>.prose{flex-grow:1!important;display:flex!important;flex-direction:column!important}.quickstart-cards-aligned a.card>div>div:last-child,.quickstart-cards-aligned [data-component-part=\"card\"]>div>div:last-child{margin-top:auto!important}@media (max-width: 1024px){div.quickstart-cards-aligned,.quickstart-cards-aligned{display:flex!important;flex-direction:column!important;gap:4px!important}div.quickstart-cards-aligned [data-component-part=\"card-group\"],div.quickstart-cards-aligned>div,.quickstart-cards-aligned [data-component-part=\"card-group\"],.quickstart-cards-aligned>div{display:flex!important;flex-direction:column!important;gap:4px!important;row-gap:4px!important;grid-row-gap:4px!important;width:100%!important}div.quickstart-cards-aligned a.card,.quickstart-cards-aligned a.card,.quickstart-cards-aligned [data-component-part=\"card\"]{margin-bottom:4px!important;width:100%!important}div.quickstart-cards-aligned a.card:last-child,.quickstart-cards-aligned a.card:last-child,.quickstart-cards-aligned [data-component-part=\"card\"]:last-child{margin-bottom:0!important}}footer,footer>div,footer [data-component-part=\"footer\"],footer [data-component-part=\"footer-section\"]{overflow-x:hidden!important;max-width:100%!important;padding-top:1.75rem!important}footer a,footer [data-component-part=\"footer-link\"],footer .footer-link,#your-privacy-choices-button{overflow-wrap:normal!important;word-wrap:normal!important;word-break:keep-all!important;hyphens:none!important;font-size:0.75rem!important;white-space:normal!important;max-width:100%!important;line-height:1.4!important;min-width:0!important}#footer a,#your-privacy-choices-button{color:#6B6580!important}html.dark #footer a,html.dark #your-privacy-choices-button{color:#8A849C!important}#footer a:hover,#your-privacy-choices-button:hover{color:#4E4763!important}html.dark #footer a:hover,html.dark #your-privacy-choices-button:hover{color:#A7A3B5!important}#your-privacy-choices-button{position:relative;align-self:start}footer .md\\:items-center>div:has(>#your-privacy-choices-button){align-self:flex-start!important}#your-privacy-choices-button::after{content:url(\"https://6778953.fs1.hubspotusercontent-na1.net/hubfs/6778953/legal/opt-out-30x14.svg\");right:-34px;position:absolute}#footer>div{gap:12px;padding-bottom:20px}#footer a[href*=\"mintlify\"],#footer a[href*=\"mintlify\"] span,#footer a[href*=\"mintlify\"] svg{color:#6B6580!important;fill:currentColor!important}html.dark #footer a[href*=\"mintlify\"],html.dark #footer a[href*=\"mintlify\"] span,html.dark #footer a[href*=\"mintlify\"] svg{color:#8A849C!important}#footer a[href*=\"mintlify\"]:hover,#footer a[href*=\"mintlify\"]:hover span,#footer a[href*=\"mintlify\"]:hover svg{color:#4E4763!important}html.dark #footer a[href*=\"mintlify\"]:hover,html.dark #footer a[href*=\"mintlify\"]:hover span,html.dark #footer a[href*=\"mintlify\"]:hover svg{color:#A7A3B5!important}#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex:has([data-powered-by-relocated]){flex:0 0 auto!important;width:auto!important;max-width:200px!important}#footer [data-powered-by-relocated]{flex:0 0 100%!important;display:flex!important;justify-content:flex-end!important;margin-top:0.25rem!important}#footer [data-powered-by-relocated] a[href*=\"mintlify\"]{font-size:0.75rem!important}#footer [data-powered-by-relocated] a[href*=\"mintlify\"] svg{height:0.75rem!important;width:auto!important}#footer [data-powered-by-relocated]>*:not(:has(a[href*=\"mintlify\"])){display:none!important}@media (max-width: 767px){#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex{display:flex!important;justify-content:flex-end!important}#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex>a{display:none!important}}#footer svg[style*=\"mask-image\"]{background-color:#6B6580!important}html.dark #footer svg[style*=\"mask-image\"]{background-color:#8A849C!important}#footer a:hover svg[style*=\"mask-image\"]{background-color:#4E4763!important}html.dark #footer a:hover svg[style*=\"mask-image\"]{background-color:#A7A3B5!important}"}],"page":{"pagePath":"api-reference/xreserve/all/prepare-withdrawal","slug":"/api-reference/xreserve/all/prepare-withdrawal","pageMetadata":{"openapi":"openapi/xreserve.yaml post /v1/prepare-withdrawal","title":"Prepare a withdrawal request","description":"Turns the user's burn transaction data on the remote chain into fully encoded burn intents to send to the `/withdraw` endpoint. This endpoint performs the following:\n- Resolves contract and token addresses across networks.\n- Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.\n- Calculates transfer amounts and fees.\n- Encodes forwarding call data with the calculated transfer amounts.\n- Generates `maxBlockHeight` and `maxFee` values with safety buffers.\n- Returns data in the structure expected by the withdraw endpoint.\n\nNote: The `/withdraw` endpoint requires signatures and the remote chain `burnTxId` in addition to the burn intent prepared by this endpoint.\n","href":"/api-reference/xreserve/all/prepare-withdrawal"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Turns the user’s burn transaction data on the remote chain into fully encoded burn intents to send to the \", _jsx(_components.code, {\n children: \"/withdraw\"\n }), \" endpoint. This endpoint performs the following:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Resolves contract and token addresses across networks.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Calculates transfer amounts and fees.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Encodes forwarding call data with the calculated transfer amounts.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Generates \", _jsx(_components.code, {\n children: \"maxBlockHeight\"\n }), \" and \", _jsx(_components.code, {\n children: \"maxFee\"\n }), \" values with safety buffers.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns data in the structure expected by the withdraw endpoint.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Note: The \", _jsx(_components.code, {\n children: \"/withdraw\"\n }), \" endpoint requires signatures and the remote chain \", _jsx(_components.code, {\n children: \"burnTxId\"\n }), \" in addition to the burn intent prepared by this endpoint.\"]\n })]\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"config":{},"pageMetadata":{"openapi":"openapi/xreserve.yaml post /v1/prepare-withdrawal","title":"Prepare a withdrawal request","description":"Turns the user's burn transaction data on the remote chain into fully encoded burn intents to send to the `/withdraw` endpoint. This endpoint performs the following:\n- Resolves contract and token addresses across networks.\n- Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.\n- Calculates transfer amounts and fees.\n- Encodes forwarding call data with the calculated transfer amounts.\n- Generates `maxBlockHeight` and `maxFee` values with safety buffers.\n- Returns data in the structure expected by the withdraw endpoint.\n\nNote: The `/withdraw` endpoint requires signatures and the remote chain `burnTxId` in addition to the burn intent prepared by this endpoint.\n","href":"/api-reference/xreserve/all/prepare-withdrawal"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/circle-167b8d39/d67aae5e94f8afee/content/gtm.js","/_mintlify/custom/circle-167b8d39/df50992471c6ad37/content/footer-powered-by.js","/_mintlify/custom/circle-167b8d39/749fc460434d1999/circle-fees.js"],"openApiReferenceData":{"operation":{"operationId":"prepareWithdrawal","summary":"Prepare a withdrawal request","description":"Turns the user's burn transaction data on the remote chain into fully encoded burn intents to send to the `/withdraw` endpoint. This endpoint performs the following:\n- Resolves contract and token addresses across networks.\n- Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.\n- Calculates transfer amounts and fees.\n- Encodes forwarding call data with the calculated transfer amounts.\n- Generates `maxBlockHeight` and `maxFee` values with safety buffers.\n- Returns data in the structure expected by the withdraw endpoint.\n\nNote: The `/withdraw` endpoint requires signatures and the remote chain `burnTxId` in addition to the burn intent prepared by this endpoint.\n","tags":["xReserve"],"requestBody":"2d65bae6-571b-40c6-a038-bc2130fc26dc","responses":{"200":"76c95e90-3040-473d-8d99-bb0f796874cd","400":"79d3bdfa-cd95-46fc-966a-b9d41eeb8006","500":"20c31f1d-c968-4560-be55-7381b83dd6cb"},"method":"post","type":"path","servers":["fc27916c-c15a-476d-b173-50d91bcdd5a6","931e37c2-f273-48ef-a74f-753501922ec3"],"security":[],"path":"/v1/prepare-withdrawal","baseUrlOptions":["https://xreserve-api-testnet.circle.com","https://xreserve-api.circle.com"],"title":"Prepare a withdrawal request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Contains data that prepares burn intents for withdrawal.","properties":{"batches":{"type":"array","description":"Array of burn intent batches.","items":{"type":"object","description":"Contains burn intent data used to prepare burn intents.","required":["token","remoteDomain","remoteDepositor","finalDestinationDomain","finalDestinationRecipient","useCircleForwarding"],"properties":{"token":{"type":"string","enum":["USDC"],"description":"Symbol of the token to transfer.","isRequired":true,"uniqueKey":"batches.items.[INDEX].token","typeLabel":"enum\u003cstring>"},"remoteDomain":{"type":"integer","minimum":1,"description":"The remote domain ID. Typically greater than `10000`. Must be different from `finalDestinationDomain`.","isRequired":true,"uniqueKey":"batches.items.[INDEX].remoteDomain","typeLabel":"integer"},"remoteDepositor":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"The remote depositor address as a 32-byte hexadecimal string. This address initiated the withdrawal on the remote chain.","isRequired":true,"uniqueKey":"batches.items.[INDEX].remoteDepositor","typeLabel":"string"},"finalDestinationDomain":{"type":"integer","minimum":0,"description":"The destination domain where forwarded funds are withdrawn, either a CCTP supported domain or another remote domain. Must be different from `remoteDomain`.","isRequired":true,"uniqueKey":"batches.items.[INDEX].finalDestinationDomain","typeLabel":"integer"},"finalDestinationRecipient":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"The recipient address on the final destination domain as a 32-byte hexadecimal string.","isRequired":true,"uniqueKey":"batches.items.[INDEX].finalDestinationRecipient","typeLabel":"string"},"useCircleForwarding":{"type":"boolean","description":"Indicates whether Circle should forward the transaction and release funds on either a CCTP supported blockchain or another remote blockchain.","isRequired":true,"uniqueKey":"batches.items.[INDEX].useCircleForwarding","typeLabel":"boolean"},"valueExcludingFees":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"Crosschain transfer amount excluding fees, in decimal string formatting. Pass either this field or `valueIncludingFees`, but not both.","example":"10.00","uniqueKey":"batches.items.[INDEX].valueExcludingFees","typeLabel":"string"},"valueIncludingFees":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"Crosschain transfer amount including fees, in decimal string formatting. Pass either this field or `valueExcludingFees`, but not both.","example":"10.00","uniqueKey":"batches.items.[INDEX].valueIncludingFees","typeLabel":"string"},"finalDestinationCaller":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Authorized caller address on the final destination chain as a 32-byte hexadecimal string. If this field is present, the caller must be this address.","uniqueKey":"batches.items.[INDEX].finalDestinationCaller","typeLabel":"string"},"salt":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"A salt that is used to ensure uniqueness in the burn intent as a 32-byte hexadecimal string. If omitted, this field is randomly generated.","uniqueKey":"batches.items.[INDEX].salt","typeLabel":"string"},"forwardingOptions":{"type":"object","description":"Options for forwarding the transaction.","properties":{"maxFee":{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$","description":"Maximum fee for redeposits or CCTP forwarding. This required fee is in addition to the `burnIntent.maxFee`.","uniqueKey":"batches.items.[INDEX].forwardingOptions.maxFee","typeLabel":"string"},"hookData":{"type":"string","pattern":"^0x[a-fA-F0-9]*$","description":"Optional hook data for forwarding, in hexadecimal format.","uniqueKey":"batches.items.[INDEX].forwardingOptions.hookData","typeLabel":"string"},"usesFastFinality":{"type":"boolean","description":"Indicates whether to use fast finality. Required for CCTP forwarding.","uniqueKey":"batches.items.[INDEX].forwardingOptions.usesFastFinality","typeLabel":"boolean"}},"uniqueKey":"batches.items.[INDEX].forwardingOptions","typeLabel":"object"}},"uniqueKey":"batches.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"batches","typeLabel":"object[]"}},"required":["batches"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"batches":[{"token":"USDC","remoteDomain":2,"remoteDepositor":"\u003cstring>","finalDestinationDomain":1,"finalDestinationRecipient":"\u003cstring>","useCircleForwarding":true,"valueExcludingFees":"10.00","valueIncludingFees":"10.00","finalDestinationCaller":"\u003cstring>","salt":"\u003cstring>","forwardingOptions":{"maxFee":"\u003cstring>","hookData":"\u003cstring>","usesFastFinality":true}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"76c95e90-3040-473d-8d99-bb0f796874cd":{"description":"Successfully prepared burn intents ready for withdrawal.","content":{"application/json":{"schema":{"type":"object","description":"Contains prepared burn intents.","properties":{"batches":{"type":"array","description":"List of prepared burn intents.","items":{"type":"object","properties":{"burnIntents":{"type":"array","items":{"type":"object","description":"A burn intent representing a single withdrawal request.","required":["maxBlockHeight","maxFee","spec"],"properties":{"maxBlockHeight":{"type":"string","pattern":"^\\d+$","description":"The maximum block height at which the burn intent is valid.","example":"1000000","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].maxBlockHeight","typeLabel":"string"},"maxFee":{"type":"string","pattern":"^\\d+$","description":"The maximum fee allowed for the burn intent in the smallest token unit.","example":"100000","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].maxFee","typeLabel":"string"},"spec":{"type":"object","description":"Contains transfer specifications for a withdrawal.","required":["version","sourceDomain","destinationDomain","sourceContract","destinationContract","sourceToken","destinationToken","sourceDepositor","destinationRecipient","sourceSigner","destinationCaller","value","salt","hookData"],"properties":{"version":{"type":"integer","description":"Transfer specification version.","example":1,"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.version","typeLabel":"integer"},"sourceDomain":{"type":"integer","description":"Source domain ID.","example":0,"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.sourceDomain","typeLabel":"integer"},"destinationDomain":{"type":"integer","description":"Destination domain ID.","example":1,"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.destinationDomain","typeLabel":"integer"},"sourceContract":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Source contract address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.sourceContract","typeLabel":"string"},"destinationContract":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Destination contract address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.destinationContract","typeLabel":"string"},"sourceToken":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Source token address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000c2d8b55f8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.sourceToken","typeLabel":"string"},"destinationToken":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Destination token address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000d3e9c66f9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.destinationToken","typeLabel":"string"},"sourceDepositor":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Source depositor address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000e4fad77fadadadadadadadadadadadadadadadad","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.sourceDepositor","typeLabel":"string"},"destinationRecipient":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Destination recipient address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000f5abc88abebebebebebebebebebebebebebebebe","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.destinationRecipient","typeLabel":"string"},"sourceSigner":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Source signer address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.sourceSigner","typeLabel":"string"},"destinationCaller":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Destination caller address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.destinationCaller","typeLabel":"string"},"value":{"type":"string","pattern":"^\\d+$","description":"The transfer amount in the smallest token unit.","example":"1000000","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.value","typeLabel":"string"},"salt":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Random salt that ensures uniqueness as a 32-byte hexadecimal string.","example":"0xc3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.salt","typeLabel":"string"},"hookData":{"type":"object","description":"Contains structured hook data for withdrawals, including forwarding and remote chain information.","required":["remoteDomain","remoteDepositor","remoteToken","forwardingContractAddress","forwardingCalldata"],"properties":{"remoteDomain":{"type":"integer","description":"Remote chain domain identifier.","example":10001,"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData.remoteDomain","typeLabel":"integer"},"remoteDepositor":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Remote depositor address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData.remoteDepositor","typeLabel":"string"},"remoteToken":{"type":"string","pattern":"^0x[a-fA-F0-9]{64}$","description":"Remote token address as a 32-byte hexadecimal string.","example":"0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData.remoteToken","typeLabel":"string"},"forwardingContractAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Forwarding contract address as a 20-byte hexadecimal string. If you are not forwarding funds, set to `0x0`.","example":"0x0000000000000000000000000000000000000000","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData.forwardingContractAddress","typeLabel":"string"},"forwardingCalldata":{"type":"string","pattern":"^0x([a-fA-F0-9]{8}[a-fA-F0-9]*)?$","description":"Forwarding call data. If you are forwarding funds, set to `0x` + a 4-byte function selector + optional data. If not forwarding, set to `0x`.","example":"0x","isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData.forwardingCalldata","typeLabel":"string"}},"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec.hookData","typeLabel":"object"}},"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX].spec","typeLabel":"object"}},"uniqueKey":"batches.items.[INDEX].burnIntents.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"batches.items.[INDEX].burnIntents","typeLabel":"object[]"},"encoded":{"type":"string","description":"Encoded burn intent data","isRequired":true,"uniqueKey":"batches.items.[INDEX].encoded","typeLabel":"string"},"messageHashToSign":{"type":"string","description":"The message hash to sign before submitting the withdrawal request.","isRequired":true,"uniqueKey":"batches.items.[INDEX].messageHashToSign","typeLabel":"string"}},"required":["burnIntents","encoded","messageHashToSign"],"uniqueKey":"batches.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"batches","typeLabel":"object[]"}},"required":["batches"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"batches":[{"burnIntents":[{"maxBlockHeight":"1000000","maxFee":"100000","spec":{"version":1,"sourceDomain":0,"destinationDomain":1,"sourceContract":"0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6","destinationContract":"0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7","sourceToken":"0x000000000000000000000000c2d8b55f8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c","destinationToken":"0x000000000000000000000000d3e9c66f9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d","sourceDepositor":"0x000000000000000000000000e4fad77fadadadadadadadadadadadadadadadad","destinationRecipient":"0x000000000000000000000000f5abc88abebebebebebebebebebebebebebebebe","sourceSigner":"0x000000000000000000000000a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0","destinationCaller":"0x000000000000000000000000b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1","value":"1000000","salt":"0xc3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4","hookData":{"remoteDomain":10001,"remoteDepositor":"0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6","remoteToken":"0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7","forwardingContractAddress":"0x0000000000000000000000000000000000000000","forwardingCalldata":"0x"}}}],"encoded":"\u003cstring>","messageHashToSign":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"79d3bdfa-cd95-46fc-966a-b9d41eeb8006":{"description":"Standard error response.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response.","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Error message","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Error message"}}},"exampleType":"generated"}},"exampleType":"generated"},"20c31f1d-c968-4560-be55-7381b83dd6cb":{"description":"Standard error response.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response.","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Error message","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Error message"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"fc27916c-c15a-476d-b173-50d91bcdd5a6":{"url":"https://xreserve-api-testnet.circle.com","description":"Testnet"},"931e37c2-f273-48ef-a74f-753501922ec3":{"url":"https://xreserve-api.circle.com","description":"Mainnet"}}},"originalFileLocation":"openapi/xreserve.yaml"},"subdomain":"circle-167b8d39","siteName":"Circle Docs","title":"Prepare a withdrawal request - Circle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-23T21:10:49.645Z","originalFileLocation":"api-reference/xreserve/all/prepare-withdrawal.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=\"Turns the user\u0026#x27;s burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following: - Resolves contract and token addresses across networks. - Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain. - Calculates transfer amounts and fees. - Encodes forwarding call data with the calculated transfer amounts. - Generates maxBlockHeight and maxFee values with safety buffers. - Returns data in the structure expected by the withdraw endpoint. Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Circle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_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/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Prepare a withdrawal request - Circle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Turns the user\u0026#x27;s burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following: - Resolves contract and token addresses across networks. - Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain. - Calculates transfer amounts and fees. - Encodes forwarding call data with the calculated transfer amounts. - Generates maxBlockHeight and maxFee values with safety buffers. - Returns data in the structure expected by the withdraw endpoint. Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Circle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=xReserve\u0026amp;title=Prepare+a+withdrawal+request\u0026amp;description=Turns+the+user%27s+burn+transaction+data+on+the+remote+chain+into+fully+encoded+burn+intents+to+send+to+the+%60%2Fwithdraw%60+endpoint.+This+endpoint+performs+the+follo\u0026amp;theme=b86ce57c82f364033d1c00f9\u0026amp;signature=bd0a5e253aa1064c6ffde6ed4e4662355fa64a445df0b7799391c7eff9a65278\">\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=\"Prepare a withdrawal request - Circle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Turns the user\u0026#x27;s burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following: - Resolves contract and token addresses across networks. - Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain. - Calculates transfer amounts and fees. - Encodes forwarding call data with the calculated transfer amounts. - Generates maxBlockHeight and maxFee values with safety buffers. - Returns data in the structure expected by the withdraw endpoint. Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=xReserve\u0026amp;title=Prepare+a+withdrawal+request\u0026amp;description=Turns+the+user%27s+burn+transaction+data+on+the+remote+chain+into+fully+encoded+burn+intents+to+send+to+the+%60%2Fwithdraw%60+endpoint.+This+endpoint+performs+the+follo\u0026amp;theme=b86ce57c82f364033d1c00f9\u0026amp;signature=bd0a5e253aa1064c6ffde6ed4e4662355fa64a445df0b7799391c7eff9a65278\">\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/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Circle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0073C3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/xreserve/all/prepare-withdrawal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.circle.com/#organization\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/light.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=decfb42837e0eb7c32dd425866902e78\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.circle.com#website\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal#webpage\",\"url\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal\",\"name\":\"Prepare a withdrawal request\",\"description\":\"Turns the user's burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following: - Resolves contract and token addresses across networks. - Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain. - Calculates transfer amounts and fees. - Encodes forwarding call data with the calculated transfer amounts. - Generates maxBlockHeight and maxFee values with safety buffers. - Returns data in the structure expected by the withdraw endpoint. Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.\",\"dateModified\":\"2026-03-23T21:10:49.645Z\",\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"xReserve\",\"item\":\"https://developers.circle.com/api-reference/xreserve/all/get-attestations-by-tx-hash\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Prepare a withdrawal request\",\"item\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal#apireference\",\"headline\":\"Prepare a withdrawal request\",\"name\":\"Prepare a withdrawal request\",\"description\":\"Turns the user's burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following: - Resolves contract and token addresses across networks. - Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain. - Calculates transfer amounts and fees. - Encodes forwarding call data with the calculated transfer amounts. - Generates maxBlockHeight and maxFee values with safety buffers. - Returns data in the structure expected by the withdraw endpoint. Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.\",\"url\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal\",\"mainEntityOfPage\":{\"@id\":\"https://developers.circle.com/api-reference/xreserve/all/prepare-withdrawal#webpage\"},\"dateModified\":\"2026-03-23T21:10:49.645Z\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/xreserve/all/prepare-withdrawal.md","siteName":"Circle Docs","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Assets","pages":[{"title":"Assets","href":"/assets"}]},{"tab":"Build onchain","pages":[{"title":"Build onchain","href":"/build-onchain"}]},{"tab":"Crosschain transfers","pages":[{"title":"Crosschain transfers","href":"/crosschain-transfers"}]},{"tab":"Agent stack","pages":[{"title":"Agent stack","href":"/agent-stack"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/cpn"}]},{"tab":"Liquidity services","pages":[{"title":"Liquidity services","href":"/liquidity-services"}]},{"tab":"API reference","anchors":[{"anchor":"Home","icon":"home","pages":[{"title":"Home","href":"/api-reference"}]},{"anchor":"Wallets","icon":"wallet","pages":[{"title":"Wallets","href":"/api-reference/wallets"}]},{"anchor":"Contracts","icon":"file-contract","pages":[{"title":"Contracts","href":"/api-reference/contracts"}]},{"anchor":"CCTP","icon":"bridge","pages":[{"title":"CCTP","href":"/api-reference/cctp"}]},{"anchor":"Gateway","icon":"dungeon","pages":[{"title":"Gateway","href":"/api-reference/gateway"}]},{"anchor":"x402 facilitators","icon":"handshake","pages":[{"title":"x402 facilitators","href":"/api-reference/x402-facilitators"}]},{"anchor":"Digital Asset Accounts","icon":"money-bill-1-wave","pages":[{"title":"Digital Asset Accounts","href":"/api-reference/digital-asset-accounts"}]},{"anchor":"End User Onboarding","icon":"user-plus","pages":[{"title":"End User Onboarding","href":"/api-reference/end-user-onboarding"}]},{"anchor":"Mint and Custody","icon":"building-columns","pages":[{"title":"Mint and Custody","href":"/api-reference/circle-mint"}]},{"anchor":"Circle Payments Network","icon":"chart-network","pages":[{"title":"Circle Payments Network","href":"/api-reference/cpn"}]},{"anchor":"StableFX","icon":"swap","pages":[{"title":"StableFX","href":"/api-reference/stablefx"}]},{"anchor":"xReserve","icon":"vault","pages":[{"title":"xReserve API","sidebarTitle":"Overview","href":"/api-reference/xreserve"},{"group":"xReserve","pages":[{"openapi":"openapi/xreserve.yaml get /v1/attestations","title":"Get attestations by source transaction hash","href":"/api-reference/xreserve/all/get-attestations-by-tx-hash"},{"openapi":"openapi/xreserve.yaml get /v1/attestations/{depositMessageHash}","title":"Get an attestation for a crosschain transfer","href":"/api-reference/xreserve/all/get-attestation"},{"openapi":"openapi/xreserve.yaml get /v1/remote-domains/{remoteDomain}/attestations","title":"List attestations for crosschain transfers","href":"/api-reference/xreserve/all/list-attestations"},{"openapi":"openapi/xreserve.yaml get /v1/balances/{remoteDomain}","title":"Get token balances on a remote domain","href":"/api-reference/xreserve/all/get-balances"},{"openapi":"openapi/xreserve.yaml get /v1/info","title":"Get domain information","description":"Returns information on source and remote domains, including its supported tokens and configuration details.","href":"/api-reference/xreserve/all/get-info"},{"openapi":"openapi/xreserve.yaml post /v1/prepare-withdrawal","title":"Prepare a withdrawal request","href":"/api-reference/xreserve/all/prepare-withdrawal"},{"openapi":"openapi/xreserve.yaml post /v1/withdraw","title":"Submit signed burn intents for withdrawal","description":"Submits up to five signed burn intent batches per request call. Each batch may contain one burn intent or a set of up to 10.","href":"/api-reference/xreserve/all/submit-withdrawal"},{"openapi":"openapi/xreserve.yaml get /v1/withdrawal/{withdrawalId}","title":"Get withdrawal status","href":"/api-reference/xreserve/all/get-withdrawal-status"}]}]},{"anchor":"Match","pages":[{"title":"Match","href":"/api-reference/circle-match/all/get-account"}]}]},{"tab":"Developer tools","menu":[{"item":"Sample projects","pages":[{"title":"Sample projects","href":"/sample-projects"}]},{"item":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"item":"Release notes","pages":[{"title":"Release notes","href":"/release-notes"}]}],"pages":[{"title":"Developer tools","href":"/sample-projects"}]}]},"basePath":"","title":"Prepare a withdrawal request - Circle Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}