Submits the information requested by the specified RFI of a fiat payout.
Use GET /v1/payouts/{id}/rfi/{rfiId} first to retrieve the fieldRequirements.schema,
which defines the required keys and their validation rules.
After a successful submission the RFI transitions to IN_REVIEW status. The payout
resumes processing once the compliance team approves the submitted information.
Key-value pairs providing the information requested by the RFI. The required keys are described by the fieldRequirements.schema returned in the GET RFI response.
Details of a Request for Information (RFI) associated with a fiat payout.
Show child attributes
Was this page helpful?
{"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":"6aee3a50b934480efcadb359","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":589},{"language":"default","tag":"Wallets","count":159},{"language":"default","tag":"Circle Payments Network","count":158},{"language":"default","tag":"Mint and Custody","count":125},{"language":"default","tag":"StableFX","count":108},{"language":"default","tag":"Digital Asset Accounts","count":104},{"language":"default","tag":"Liquidity services","count":104},{"language":"default","tag":"Crosschain transfers","count":102},{"language":"default","tag":"Payments","count":91},{"language":"default","tag":"Managed Payments","count":75}]},"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":"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},{"name":"comment-mode","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/circle-mint/payouts/submit-payout-rfi","slug":"/api-reference/circle-mint/payouts/submit-payout-rfi","pageMetadata":{"openapi":"openapi/payouts.yaml post /v1/payouts/{id}/rfi/{rfiId}/submit","title":"Submit a payout RFI response","description":"Submits the information requested by the specified RFI of a fiat payout.\nUse `GET /v1/payouts/{id}/rfi/{rfiId}` first to retrieve the `fieldRequirements.schema`,\nwhich defines the required keys and their validation rules.\n\nAfter a successful submission the RFI transitions to `IN_REVIEW` status. The payout\nresumes processing once the compliance team approves the submitted information.\n","href":"/api-reference/circle-mint/payouts/submit-payout-rfi"},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Submits the information requested by the specified RFI of a fiat payout.\\nUse \", _jsx(_components.code, {\n children: \"GET /v1/payouts/{id}/rfi/{rfiId}\"\n }), \" first to retrieve the \", _jsx(_components.code, {\n children: \"fieldRequirements.schema\"\n }), \",\\nwhich defines the required keys and their validation rules.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"After a successful submission the RFI transitions to \", _jsx(_components.code, {\n children: \"IN_REVIEW\"\n }), \" status. The payout\\nresumes processing once the compliance team approves the submitted information.\"]\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/payouts.yaml post /v1/payouts/{id}/rfi/{rfiId}/submit","title":"Submit a payout RFI response","description":"Submits the information requested by the specified RFI of a fiat payout.\nUse `GET /v1/payouts/{id}/rfi/{rfiId}` first to retrieve the `fieldRequirements.schema`,\nwhich defines the required keys and their validation rules.\n\nAfter a successful submission the RFI transitions to `IN_REVIEW` status. The payout\nresumes processing once the compliance team approves the submitted information.\n","href":"/api-reference/circle-mint/payouts/submit-payout-rfi"}}},"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":{"parameters":["6b0fa484-340f-494c-8a02-d3cdaa7a21fe","bd1dac6b-fa26-4278-a353-70a7f0b7f5fa"],"security":["d4472345-1377-4c6f-a9af-b802cb3cf579"],"summary":"Submit a payout RFI response","description":"Submits the information requested by the specified RFI of a fiat payout.\nUse `GET /v1/payouts/{id}/rfi/{rfiId}` first to retrieve the `fieldRequirements.schema`,\nwhich defines the required keys and their validation rules.\n\nAfter a successful submission the RFI transitions to `IN_REVIEW` status. The payout\nresumes processing once the compliance team approves the submitted information.\n","operationId":"submitPayoutRfi","tags":["Payouts"],"requestBody":"07e9cb3e-607d-426e-83ce-cc116cc676e6","responses":{"200":"57e9d500-4c2c-40a4-a958-1da62f740271","400":"71701fed-cc6e-48a6-8062-a55f2413bd71","401":"1bc009cd-7330-497f-a5b3-36e7512421aa","404":"d09bcba9-0c61-4c52-8446-8d912e6547ae"},"method":"post","type":"path","servers":["e56f2e54-c1c5-4855-b205-e7ad557cb36a","b454d6d8-9e4f-4767-895e-24f64c0d9f84"],"path":"/v1/payouts/{id}/rfi/{rfiId}/submit","baseUrlOptions":["https://api-sandbox.circle.com","https://api.circle.com"],"title":"Submit a payout RFI response","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6b0fa484-340f-494c-8a02-d3cdaa7a21fe":{"name":"id","description":"Universally unique identifier (UUID v4) of a resource.","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82fae2b0","isRequired":true,"description":"Universally unique identifier (UUID v4) of a resource.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"bd1dac6b-fa26-4278-a353-70a7f0b7f5fa":{"name":"rfiId","description":"Universally unique identifier (UUID v4) of the RFI.","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"b8627ae8-732b-4d25-b947-1df8f4007a29","isRequired":true,"description":"Universally unique identifier (UUID v4) of the RFI.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for submitting responses to a payout RFI.","required":["fields"],"properties":{"fields":{"type":"object","description":"Key-value pairs providing the information requested by the RFI. The required keys are described by the `fieldRequirements.schema` returned in the GET RFI response.","additionalProperties":true,"example":{"purposeOfFunds":"payroll","sourceOfFunds":"business_revenue"},"isRequired":true,"uniqueKey":"fields","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Submit RFI":{"title":"Submit RFI","value":{"fields":{"purposeOfFunds":"payroll","sourceOfFunds":"business_revenue"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"57e9d500-4c2c-40a4-a958-1da62f740271":{"description":"RFI response submitted successfully. Returns the updated RFI.","headers":{"X-Request-Id":{"description":"Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support.","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"title":"SubmitPayoutRfiResponse","properties":{"data":{"type":"object","description":"Details of a Request for Information (RFI) associated with a fiat payout.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the RFI.","example":"b8627ae8-732b-4d25-b947-1df8f4007a29","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"paymentId":{"type":"string","format":"uuid","description":"Identifier of the payout this RFI is associated with.","example":"f4b26b87-0000-4c42-a8d6-000000000001","uniqueKey":"data.paymentId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Lifecycle status of a payout RFI. `INFORMATION_REQUIRED` means the user must submit answers; `IN_REVIEW` means answers were received and are under review; `APPROVED` means the RFI was resolved successfully; `REJECTED` means the RFI was closed without approval.","enum":["INFORMATION_REQUIRED","IN_REVIEW","APPROVED","REJECTED"],"example":"INFORMATION_REQUIRED","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"level":{"type":"string","description":"Severity level of a payout RFI, indicating the depth of information required. `LEVEL_1` requires basic identity details; `LEVEL_2` requires source-of-funds documentation; `LEVEL_3` requires full enhanced due diligence.","enum":["LEVEL_1","LEVEL_2","LEVEL_3"],"example":"LEVEL_1","uniqueKey":"data.level","typeLabel":"enum\u003cstring>"},"expiresAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after which the RFI can no longer be submitted.","example":"2020-04-17T02:13:30.000Z","uniqueKey":"data.expiresAt","typeLabel":"string\u003cdate-time>"},"fieldRequirements":{"oneOf":[{"type":"object","description":"Schema describing the fields that must be submitted to resolve the RFI.","properties":{"version":{"type":"integer","description":"Schema version number.","example":1,"uniqueKey":"data.fieldRequirements.oneOf.0.version","typeLabel":"integer"},"schema":{"type":"object","description":"JSON Schema object defining the required fields and their validation rules.","additionalProperties":true,"uniqueKey":"data.fieldRequirements.oneOf.0.schema","typeLabel":"object"}},"uniqueKey":"data.fieldRequirements.oneOf.0","typeLabel":"object"},{"type":"null","description":"Schema describing the fields that must be submitted to resolve the RFI.","properties":{"version":{"type":"integer","description":"Schema version number.","example":1},"schema":{"type":"object","description":"JSON Schema object defining the required fields and their validation rules.","additionalProperties":true}},"uniqueKey":"data.fieldRequirements.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fieldRequirements","typeLabel":"object | null"},"fileRequirements":{"oneOf":[{"type":"array","description":"List of file attachments required to resolve the RFI.","items":{"type":"object","properties":{"fileKey":{"type":"string","description":"Identifier for this file requirement. Pass this value as `fileMetadata.fileKey`\nwhen calling `POST /v1/payouts/{id}/rfi/{rfiId}/files`.\n","example":"proofOfFunds","uniqueKey":"data.fileRequirements.oneOf.0.items.[INDEX].fileKey","typeLabel":"string"},"fileName":{"type":"string","description":"Human-readable label for the required file.","example":"Proof of Funds","uniqueKey":"data.fileRequirements.oneOf.0.items.[INDEX].fileName","typeLabel":"string"},"required":{"type":"boolean","description":"Whether this file is mandatory.","example":true,"uniqueKey":"data.fileRequirements.oneOf.0.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"data.fileRequirements.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.fileRequirements.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"List of file attachments required to resolve the RFI.","items":{"type":"object","properties":{"fileKey":{"type":"string","description":"Identifier for this file requirement. Pass this value as `fileMetadata.fileKey`\nwhen calling `POST /v1/payouts/{id}/rfi/{rfiId}/files`.\n","example":"proofOfFunds"},"fileName":{"type":"string","description":"Human-readable label for the required file.","example":"Proof of Funds"},"required":{"type":"boolean","description":"Whether this file is mandatory.","example":true}}},"uniqueKey":"data.fileRequirements.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fileRequirements","typeLabel":"object[] | null"},"certificate":{"oneOf":[{"type":"object","description":"Encryption certificate used to secure file uploads for BFI-generated RFIs.\nPresent when `fileRequirements` is non-empty and the RFI was generated by a BFI (external).\nAbsent for internally-generated RFIs — files for those RFIs are stored with standard\nencryption-at-rest and do not require client-side encryption.\nThe `jwk` field contains an EC public key in JWK format — use it to wrap the AES-128\nfile-encryption key via ECDH-ES+A128KW before calling `POST /v1/payouts/{id}/rfi/{rfiId}/files`.\n","properties":{"jwk":{"type":"object","description":"EC public key in JSON Web Key (JWK) format.","additionalProperties":true,"example":{"kty":"EC","crv":"P-256","x":"f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU","y":"x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"},"uniqueKey":"data.certificate.oneOf.0.jwk","typeLabel":"object"}},"uniqueKey":"data.certificate.oneOf.0","typeLabel":"object"},{"type":"null","description":"Encryption certificate used to secure file uploads for BFI-generated RFIs.\nPresent when `fileRequirements` is non-empty and the RFI was generated by a BFI (external).\nAbsent for internally-generated RFIs — files for those RFIs are stored with standard\nencryption-at-rest and do not require client-side encryption.\nThe `jwk` field contains an EC public key in JWK format — use it to wrap the AES-128\nfile-encryption key via ECDH-ES+A128KW before calling `POST /v1/payouts/{id}/rfi/{rfiId}/files`.\n","properties":{"jwk":{"type":"object","description":"EC public key in JSON Web Key (JWK) format.","additionalProperties":true,"example":{"kty":"EC","crv":"P-256","x":"f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU","y":"x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"}}},"uniqueKey":"data.certificate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.certificate","typeLabel":"object | null"}},"uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"SubmitPayoutRfiResponse · object"},"examples":{"Submitted RFI":{"title":"Submitted RFI","value":{"data":{"id":"b8627ae8-732b-4d25-b947-1df8f4007a29","paymentId":"f4b26b87-0000-4c42-a8d6-000000000001","status":"IN_REVIEW","level":"LEVEL_1","expiresAt":"2020-04-17T02:13:30.000Z","fieldRequirements":{"version":1,"schema":{"type":"object","required":["purposeOfFunds"],"properties":{"purposeOfFunds":{"type":"string"}}}},"fileRequirements":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"71701fed-cc6e-48a6-8062-a55f2413bd71":{"description":"The request cannot be processed due to a client error.","headers":{"X-Request-Id":{"description":"Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support.","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","title":"BadRequest","required":["code","message"],"properties":{"code":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","example":"Something went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"example":{"code":400,"message":"Bad request."},"uniqueKey":"","typeLabel":"BadRequest · object"},"examples":{"response":{"title":"response","value":{"code":400,"message":"Bad request."}}},"exampleType":"examples"}},"exampleType":"examples"},"1bc009cd-7330-497f-a5b3-36e7512421aa":{"description":"The request has not been applied because it lacks valid authentication credentials.","headers":{"X-Request-Id":{"description":"Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support.","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","title":"NotAuthorized","required":["code","message"],"properties":{"code":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","example":"Something went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"example":{"code":401,"message":"Malformed authorization."},"uniqueKey":"","typeLabel":"NotAuthorized · object"},"examples":{"response":{"title":"response","value":{"code":401,"message":"Malformed authorization."}}},"exampleType":"examples"}},"exampleType":"examples"},"d09bcba9-0c61-4c52-8446-8d912e6547ae":{"description":"The specified resource was not found.","headers":{"X-Request-Id":{"description":"Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support.","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","title":"NotFound","required":["code","message"],"properties":{"code":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","example":"Something went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"example":{"code":404,"message":"Not found."},"uniqueKey":"","typeLabel":"NotFound · object"},"examples":{"response":{"title":"response","value":{"code":404,"message":"Not found."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d4472345-1377-4c6f-a9af-b802cb3cf579":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e56f2e54-c1c5-4855-b205-e7ad557cb36a":{"url":"https://api-sandbox.circle.com"},"b454d6d8-9e4f-4767-895e-24f64c0d9f84":{"url":"https://api.circle.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","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":"openapi/payouts.yaml"},"subdomain":"circle-167b8d39","siteName":"Circle Docs","title":"Submit a payout RFI response - Circle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T19:27:56.302Z","originalFileLocation":"api-reference/circle-mint/payouts/submit-payout-rfi.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=\"Submits the information requested by the specified RFI of a fiat payout. Use GET /v1/payouts/{id}/rfi/{rfiId} first to retrieve the fieldRequirements.schema, which defines the required keys and their validation rules. After a successful submission the RFI transitions to IN_REVIEW status. The payout resumes processing once the compliance team approves the submitted information.\">\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=\"Submit a payout RFI response - Circle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits the information requested by the specified RFI of a fiat payout. Use GET /v1/payouts/{id}/rfi/{rfiId} first to retrieve the fieldRequirements.schema, which defines the required keys and their validation rules. After a successful submission the RFI transitions to IN_REVIEW status. The payout resumes processing once the compliance team approves the submitted information.\">\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/circle-mint/payouts/submit-payout-rfi\">\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=Documentation\u0026amp;title=Submit+a+payout+RFI+response\u0026amp;description=Submits+the+information+requested+by+the+specified+RFI+of+a+fiat+payout.%0AUse+%60GET+%2Fv1%2Fpayouts%2F%7Bid%7D%2Frfi%2F%7BrfiId%7D%60+first+to+retrieve+the+%60fieldRequirements.schema%60\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=16ac03de26c705fedc3988a631906cf26d2b43fab2de942191acd9fabfbca68a\">\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=\"Submit a payout RFI response - Circle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits the information requested by the specified RFI of a fiat payout. Use GET /v1/payouts/{id}/rfi/{rfiId} first to retrieve the fieldRequirements.schema, which defines the required keys and their validation rules. After a successful submission the RFI transitions to IN_REVIEW status. The payout resumes processing once the compliance team approves the submitted information.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Submit+a+payout+RFI+response\u0026amp;description=Submits+the+information+requested+by+the+specified+RFI+of+a+fiat+payout.%0AUse+%60GET+%2Fv1%2Fpayouts%2F%7Bid%7D%2Frfi%2F%7BrfiId%7D%60+first+to+retrieve+the+%60fieldRequirements.schema%60\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=16ac03de26c705fedc3988a631906cf26d2b43fab2de942191acd9fabfbca68a\">\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/circle-mint/payouts/submit-payout-rfi\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/circle-mint/payouts/submit-payout-rfi.md\">","siteName":"Circle Docs","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Circle developer docs","sidebarTitle":"Overview","mode":"custom","href":""},{"group":"Build with AI","pages":[{"title":"Arc Studio","href":"/ai/arc-studio"},{"title":"AI skills for building with Circle","sidebarTitle":"Skills","href":"/ai/skills"},{"title":"Use Circle's MCP server in your IDE","sidebarTitle":"MCP server","href":"/ai/mcp"}]}]},{"tab":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","mode":"wide","href":"/assets"},{"group":"USDC","pages":[{"title":"USDC overview","sidebarTitle":"Overview","href":"/stablecoins/what-is-usdc"},{"title":"USDC contract addresses","href":"/stablecoins/usdc-contract-addresses"},{"group":"Transfer USDC","pages":[{"title":"Quickstart: Transfer USDC on EVM chains","sidebarTitle":"Transfer USDC on EVM chains","href":"/stablecoins/quickstarts/transfer-usdc-evm"},{"title":"Quickstart: Transfer USDC on Aptos","sidebarTitle":"Transfer USDC on Aptos","href":"/stablecoins/quickstarts/transfer-usdc-aptos"},{"title":"Quickstart: Transfer USDC on Solana","sidebarTitle":"Transfer USDC on Solana","href":"/stablecoins/quickstart-transfer-10-usdc-on-solana"},{"title":"Quickstart: Set up and transfer USDC on Starknet","sidebarTitle":"Transfer USDC on Starknet","href":"/stablecoins/quickstart-setup-transfer-usdc-starknet"},{"title":"Quickstart: Set up and transfer USDC on Sui","sidebarTitle":"Transfer USDC on Sui","href":"/stablecoins/quickstart-setup-transfer-usdc-sui"},{"title":"Quickstart: Set up a USDC trustline on Stellar","sidebarTitle":"Set up a USDC trustline on Stellar","href":"/stablecoins/quickstarts/setup-usdc-trustline-stellar"},{"title":"Quickstart: Transfer USDC on Stellar","sidebarTitle":"Transfer USDC on Stellar","href":"/stablecoins/quickstarts/transfer-usdc-stellar"},{"title":"Quickstart: Set up a USDC trustline on XRPL","sidebarTitle":"Set up a USDC trustline on XRPL","href":"/stablecoins/quickstart-setup-usdc-trustline-xrpl"}]}]},{"group":"EURC","pages":[{"title":"EURC overview","sidebarTitle":"Overview","href":"/stablecoins/what-is-eurc"},{"title":"EURC contract addresses","href":"/stablecoins/eurc-contract-addresses"},{"title":"Quickstart: Transfer EURC on EVM chains","sidebarTitle":"Transfer EURC on EVM chains","href":"/stablecoins/quickstarts/transfer-eurc-evm"}]},{"group":"cirBTC","pages":[{"title":"cirBTC overview","sidebarTitle":"Overview","href":"/assets/what-is-cirbtc"},{"title":"cirBTC contract addresses","href":"/assets/cirbtc-contract-addresses"}]},{"group":"xReserve","pages":[{"title":"xReserve overview","sidebarTitle":"Overview","href":"/xreserve"},{"group":"Get started","pages":[{"title":"How xReserve works","href":"/xreserve/concepts/how-xreserve-works"},{"title":"xReserve supported blockchains and domains","sidebarTitle":"Supported blockchains and domains","href":"/xreserve/references/supported-blockchains-and-domains"},{"title":"Quickstart: Deposit USDC into xReserve","sidebarTitle":"Deposit USDC into xReserve","href":"/xreserve/tutorials/deposit-usdc-into-xreserve"},{"title":"Quickstart: Deposit into xReserve from CCTP blockchains","sidebarTitle":"Deposit from CCTP blockchains","href":"/xreserve/tutorials/deposit-from-cctp-blockchains"}]},{"group":"Withdrawals","pages":[{"title":"Initiate a withdrawal from xReserve as a remote blockchain","sidebarTitle":"Initiate a withdrawal as a remote blockchain","href":"/xreserve/tutorials/initiate-a-withdrawal-as-a-remote-blockchain"},{"title":"xReserve withdrawal fees","sidebarTitle":"Withdrawal fees","href":"/xreserve/references/fees"}]},{"group":"Learn more","pages":[{"title":"xReserve technical guide","sidebarTitle":"Technical guide","href":"/xreserve/concepts/technical-guide"},{"title":"USDC-backed stablecoin reference specification","href":"/xreserve/concepts/usdc-backed-stablecoin-specification"}]}]},{"group":"USYC","pages":[{"title":"USYC overview","sidebarTitle":"Overview","href":"/tokenized/usyc/overview"},{"group":"Get started","pages":[{"group":"Subscribe and redeem","pages":[{"title":"Quickstart: Subscribe and redeem USYC using the Teller smart contract","sidebarTitle":"Subscribe and redeem USYC using the Teller Contract","href":"/tokenized/usyc/subscribe-and-redeem"},{"title":"Quickstart: Subscribe and redeem USYC using the USYC Portal","sidebarTitle":"Subscribe and redeem USYC using the USYC Portal","href":"/tokenized/usyc/subscribe-and-redeem-portal"},{"title":"Quickstart: Subscribe and redeem USYC on Solana","sidebarTitle":"Subscribe and redeem USYC on Solana","href":"/tokenized/usyc/subscribe-and-redeem-solana"}]}]},{"group":"Learn more","pages":[{"title":"USYC contract addresses","href":"/tokenized/usyc/smart-contracts"},{"title":"API endpoints","href":"/tokenized/usyc/web2-apis"}]}]}]},{"tab":"Build onchain","pages":[{"title":"Build onchain experiences","sidebarTitle":"Overview","mode":"wide","href":"/build-onchain"},{"group":"Wallets","pages":[{"title":"Circle Wallets","sidebarTitle":"Overview","href":"/wallets"},{"group":"Get started","pages":[{"title":"Choose your wallet product and account types","sidebarTitle":"Choose your wallet and account types","href":"/wallets/account-types"},{"title":"Supported blockchains","href":"/wallets/supported-blockchains"},{"group":"Core concepts","pages":[{"title":"Transaction signing and authorization","sidebarTitle":"Transaction signing and authorization","href":"/wallets/signing-and-authorization-models"},{"title":"Key management","sidebarTitle":"Key management","href":"/wallets/key-management"},{"title":"Blockchain infrastructure","sidebarTitle":"Blockchain infrastructure","href":"/wallets/blockchain-infrastructure"},{"title":"Blockchain confirmations","href":"/wallets/blockchain-confirmations"}]}]},{"group":"Wallets: Dev-Controlled","pages":[{"title":"Dev-controlled wallets","sidebarTitle":"Overview","href":"/wallets/dev-controlled"},{"group":"Entity secret","pages":[{"title":"How the entity secret works","href":"/wallets/dev-controlled/entity-secret-management"},{"title":"How-to: Generate and register your entity secret","sidebarTitle":"Generate and register your entity secret","href":"/wallets/dev-controlled/register-entity-secret"}]},{"title":"Quickstart: Create a dev-controlled wallet","sidebarTitle":"Create a dev-controlled wallet","href":"/wallets/dev-controlled/create-your-first-wallet"},{"title":"Send tokens across wallets","sidebarTitle":"Send tokens across wallets","href":"/wallets/dev-controlled/transfer-tokens-across-wallets"},{"group":"Manage wallet creation","pages":[{"title":"How-to: Batch-create wallets for existing users","sidebarTitle":"Batch-create wallets for existing users","href":"/wallets/dev-controlled/batch-create-wallets"},{"title":"How-to: Pre-create wallets and assign on demand","sidebarTitle":"Pre-create wallets and assign on demand","href":"/wallets/dev-controlled/pre-create-wallets"}]},{"group":"Transaction signing","pages":[{"title":"How signing APIs work","sidebarTitle":"How signing APIs work","href":"/wallets/signing-apis"},{"title":"Sign transactions","sidebarTitle":"Sign transactions","href":"/wallets/sign-transactions"},{"title":"EVM testnet chain IDs for signing","sidebarTitle":"EVM testnet chain IDs","href":"/wallets/sign-tx-chain-id"}]},{"title":"How-to: Retire existing wallets","sidebarTitle":"Retire existing wallets","href":"/wallets/dev-controlled/retire-existing-wallets"}]},{"group":"Wallets: User-Controlled","pages":[{"title":"User-controlled wallets","sidebarTitle":"Overview","href":"/wallets/user-controlled"},{"title":"Authentication methods","href":"/wallets/user-controlled/authentication-methods"},{"title":"Build a wallet app","href":"/wallets/user-controlled/build-a-wallet-app"},{"title":"How-to: Transfer tokens","sidebarTitle":"Transfer tokens","href":"/wallets/user-controlled/transfer-tokens"},{"title":"How-to: Request a signature","sidebarTitle":"Request a signature","href":"/wallets/user-controlled/request-a-signature"},{"group":"Account management","pages":[{"title":"How-to: Reset a user's PIN","sidebarTitle":"Reset a user's PIN","href":"/wallets/user-controlled/reset-pin"},{"title":"How-to: Recover an account","sidebarTitle":"Recover an account","href":"/wallets/user-controlled/recover-account"},{"title":"How-to: Remove a user","sidebarTitle":"Remove a user","href":"/wallets/user-controlled/remove-a-user"}]}]},{"group":"Wallets: Modular","pages":[{"title":"Modular wallets","sidebarTitle":"Overview","href":"/wallets/modular"},{"title":"How passkeys and modules work","href":"/wallets/modular/how-passkeys-and-modules-work"},{"title":"Create a modular wallet","sidebarTitle":"Create a modular wallet","href":"/wallets/modular/create-a-modular-wallet"},{"group":"Wallet operations","pages":[{"title":"How-to: Transfer tokens","sidebarTitle":"Transfer tokens","href":"/wallets/modular/transfer-tokens"},{"title":"Batch and parallel user operations","sidebarTitle":"Batch and parallel user operations","href":"/wallets/modular/batch-and-parallel-user-operations"},{"title":"Sign and verify messages","sidebarTitle":"Sign and verify messages","href":"/wallets/modular/sign-and-verify-messages"},{"title":"How-to: Use a modular wallet as an EIP-1193 provider","sidebarTitle":"Use as an EIP-1193 provider","href":"/wallets/modular/use-as-eip-1193-provider"}]},{"title":"How-to: Set up passkey recovery","sidebarTitle":"Set up passkey recovery","href":"/wallets/modular/set-up-passkey-recovery"},{"title":"How-to: Use Dynamic as a signer","sidebarTitle":"Use Dynamic as a signer","href":"/wallets/modular/use-dynamic-as-a-signer"}]},{"group":"Learn more","pages":[{"title":"Gas fees","sidebarTitle":"Gas fees","href":"/wallets/gas-fees"},{"title":"Transaction throughput","href":"/wallets/transaction-limits-and-optimizations"},{"title":"Batch operations for smart contract accounts","sidebarTitle":"Batch operations","href":"/wallets/batch-operations"},{"title":"Unified wallet addressing on EVM blockchains","sidebarTitle":"Unified wallet addressing (EVM)","href":"/wallets/unified-wallet-addressing-evm"},{"title":"Token IDs","sidebarTitle":"Token IDs","href":"/wallets/tokens"},{"title":"Smart contract account (SCA) upgrades","sidebarTitle":"SCA upgrades","href":"/wallets/wallet-upgrades"},{"title":"Compliance requirements","href":"/wallets/compliance-requirements"}]}]},{"group":"Gas fees","pages":[{"group":"Gas Station","pages":[{"title":"Gas Station","sidebarTitle":"Overview","href":"/wallets/gas-station"},{"group":"Quickstarts","pages":[{"title":"Send a gasless transaction","href":"/wallets/gas-station/send-a-gasless-transaction"},{"title":"Quickstart: Create and fund a Solana associated token account (ATA)","sidebarTitle":"Create and fund a Solana ATA","href":"/wallets/gas-station/create-solana-ata"}]},{"group":"References","pages":[{"title":"Gas Station contract addresses","sidebarTitle":"Contract addresses","href":"/wallets/gas-station/contract-addresses"},{"title":"Solana ATA sponsorship","href":"/wallets/gas-station/solana-ata-sponsorship"},{"title":"Billing for sponsored gas fees","href":"/wallets/gas-station/billing"},{"title":"Policy management","href":"/wallets/gas-station/policy-management"}]}]},{"group":"Paymaster","pages":[{"title":"Paymaster","sidebarTitle":"Paymaster Overview","href":"/paymaster"},{"group":"Quickstarts","pages":[{"title":"Quickstart: Circle Paymaster","sidebarTitle":"Build a wallet to pay gas fees in USDC","href":"/paymaster/pay-gas-fees-usdc"}]},{"group":"References","pages":[{"title":"Paymaster addresses and events","sidebarTitle":"Addresses and events","href":"/paymaster/addresses-and-events"}]}]}]},{"group":"Compliance","pages":[{"group":"Compliance Engine","pages":[{"title":"Compliance Engine","sidebarTitle":"Overview","href":"/wallets/compliance-engine"},{"group":"Concepts","pages":[{"title":"Transaction screening","href":"/wallets/compliance-engine/tx-screening"}]},{"group":"Quickstarts","pages":[{"title":"Quickstart: Assess the risk of wallet addresses","sidebarTitle":"Assess the risk of wallet addresses","href":"/wallets/compliance-engine/tx-screening-quickstart"}]},{"group":"Tutorials","pages":[{"title":"Testing guide","sidebarTitle":"Testing transaction screening","href":"/wallets/compliance-engine/tx-screening-testing"},{"title":"Rule management","sidebarTitle":"Transaction screening rule management","href":"/wallets/compliance-engine/tx-screening-rule-management"},{"title":"Alert management","sidebarTitle":"Transaction screening alert management","href":"/wallets/compliance-engine/tx-screening-alert-management"}]}]}]},{"group":"Contracts","pages":[{"title":"Contracts","sidebarTitle":"Circle Contracts overview","href":"/contracts"},{"group":"Concepts","pages":[{"title":"Contracts templates","sidebarTitle":"Templates","href":"/contracts/scp-templates-overview"}]},{"group":"Quickstarts","pages":[{"title":"Quickstart: Deploy a smart contract using bytecode","sidebarTitle":"Deploy a smart contract using bytecode","href":"/contracts/scp-deploy-smart-contract"},{"title":"Quickstart: Deploy an ERC-1155 contract template","sidebarTitle":"Deploy an ERC-1155 contract template","href":"/contracts/deploy-smart-contract-template"},{"title":"Quickstart: Interact with a smart contract","sidebarTitle":"Interact with a smart contract","href":"/contracts/scp-interact-smart-contract"},{"title":"Quickstart: Event monitoring for smart contracts","sidebarTitle":"Event monitoring for smart contracts","href":"/contracts/scp-event-monitoring"}]},{"group":"References","pages":[{"title":"Circle Contracts supported blockchains","sidebarTitle":"Supported blockchains","href":"/contracts/supported-blockchains"},{"title":"Airdrop template","href":"/contracts/airdrop"},{"title":"Token template","href":"/contracts/erc-20-token"},{"title":"Multi-token template","href":"/contracts/erc-1155-multi-token"},{"title":"NFT template","href":"/contracts/erc-721-nft"},{"title":"How-to: Create an API key","sidebarTitle":"Create an API key","href":"/contracts/create-api-key"}]}]}]},{"tab":"Crosschain transfers","pages":[{"title":"Crosschain transfers","sidebarTitle":"Overview","mode":"wide","href":"/crosschain-transfers"},{"title":"Compare crosschain transfer fees","sidebarTitle":"Compare fees","mode":"wide","href":"/crosschain-fees"},{"group":"CCTP for USDC","pages":[{"title":"Cross-Chain Transfer Protocol","sidebarTitle":"CCTP overview","href":"/cctp"},{"group":"Get started","pages":[{"title":"Supported blockchains and domains","href":"/cctp/concepts/supported-chains-and-domains"},{"title":"Finality and block confirmations","href":"/cctp/concepts/finality-and-block-confirmations"},{"group":"Quickstarts","pages":[{"title":"Transfer USDC from Ethereum to Arc","href":"/cctp/quickstarts/transfer-usdc-ethereum-to-arc"},{"title":"Transfer USDC from Solana to Arc","href":"/cctp/quickstarts/transfer-usdc-solana-to-arc"},{"title":"Transfer USDC between Stellar and Arc","href":"/cctp/quickstarts/transfer-usdc-stellar-arc"},{"title":"Transfer USDC between Aptos and Arc","href":"/cctp/quickstarts/transfer-usdc-aptos-arc"},{"title":"Transfer USDC between Starknet and Arc","href":"/cctp/quickstarts/transfer-usdc-starknet-arc"},{"title":"Transfer USDC between Sui and Arc","href":"/cctp/quickstarts/transfer-usdc-sui-arc"}]}]},{"group":"Fees and allowances","pages":[{"title":"CCTP fees","sidebarTitle":"Transfer fees","href":"/cctp/concepts/fees"},{"title":"Fast transfer allowance","sidebarTitle":"Fast transfer allowance","href":"/cctp/concepts/fast-transfer-allowance"},{"title":"Get the fee for your transfer","href":"/cctp/howtos/get-transfer-fee"},{"title":"Get the fast transfer allowance","href":"/cctp/howtos/get-fast-transfer-allowance"}]},{"group":"Upfront fees","pages":[{"title":"Upfront fees for CCTP","sidebarTitle":"Overview","href":"/cctp/concepts/upfront-fees"},{"title":"How upfront fees work","sidebarTitle":"How it works","href":"/cctp/concepts/how-upfront-fees-work"},{"title":"Upfront fee quotes","sidebarTitle":"Fee quotes","href":"/cctp/concepts/upfront-fee-quotes"},{"title":"How-to: Transfer USDC with upfront fees","sidebarTitle":"Transfer USDC with upfront fees","href":"/cctp/howtos/transfer-usdc-with-upfront-fees"}]},{"group":"Forwarding Service","pages":[{"title":"Circle Forwarding Service for CCTP","sidebarTitle":"Overview","href":"/cctp/concepts/forwarding-service"},{"title":"How-to: Transfer USDC with the Forwarding Service","sidebarTitle":"Transfer USDC with the Forwarding Service","href":"/cctp/howtos/transfer-usdc-with-forwarding-service"}]},{"group":"Troubleshoot transfers","pages":[{"title":"Troubleshoot CCTP transfers","href":"/cctp/howtos/troubleshoot-transfers"},{"title":"Resolve attestation issues","href":"/cctp/howtos/resolve-stuck-attestation"},{"title":"Retry a failed mint","href":"/cctp/howtos/retry-failed-mint"}]},{"group":"Blockchain integrations","pages":[{"group":"EVM","pages":[{"title":"Contract addresses","href":"/cctp/references/contract-addresses"},{"title":"EVM contract interfaces","sidebarTitle":"Contract interfaces","href":"/cctp/references/contract-interfaces"}]},{"title":"CCTP Solana Programs and Interfaces","sidebarTitle":"Solana programs and interfaces","href":"/cctp/references/solana-programs"},{"title":"CCTP Starknet contracts and interfaces","sidebarTitle":"Starknet contracts and interfaces","href":"/cctp/references/starknet-contracts"},{"group":"Stellar","pages":[{"title":"CCTP on Stellar","sidebarTitle":"Technical overview","href":"/cctp/references/stellar"},{"title":"CCTP Stellar contracts and interfaces","sidebarTitle":"Contracts and interfaces","href":"/cctp/references/stellar-contracts"}]},{"title":"CCTP Aptos packages and interfaces","sidebarTitle":"Aptos packages and interfaces","href":"/cctp/references/aptos-packages"},{"title":"CCTP Sui packages and interfaces","sidebarTitle":"Sui packages and interfaces","href":"/cctp/references/sui-packages"}]},{"group":"HyperCore","pages":[{"title":"CCTP-enabled HyperCore transfers","href":"/cctp/concepts/cctp-on-hypercore"},{"title":"HyperCore CCTP-enablement contract addresses","href":"/cctp/references/hypercore-contract-addresses"},{"title":"CctpExtensionV2 Contract Interface","href":"/cctp/references/cctp-extension-v2-contract-interface"},{"title":"CoreDepositWallet contract interface","href":"/cctp/references/coredepositwallet-contract-interface"},{"title":"Transfer USDC from Arbitrum to HyperCore","href":"/cctp/howtos/transfer-usdc-from-arbitrum-to-hypercore"},{"title":"How-to: Transfer USDC from Arbitrum to HyperCore with CctpExtensionV2","sidebarTitle":"Transfer with CctpExtensionV2","href":"/cctp/howtos/transfer-usdc-from-arbitrum-to-hypercore-with-cctp-extension-v2"},{"title":"Transfer USDC from Ethereum to HyperCore","href":"/cctp/howtos/transfer-usdc-from-ethereum-to-hypercore"},{"title":"Transfer USDC from Solana to HyperCore","href":"/cctp/howtos/transfer-usdc-from-solana-to-hypercore"},{"title":"Transfer USDC from HyperEVM to HyperCore","href":"/cctp/howtos/transfer-usdc-from-hyperevm-to-hypercore"},{"title":"Withdraw USDC from HyperCore to EVM chains","href":"/cctp/howtos/withdraw-usdc-from-hypercore-to-evm"},{"title":"How-to: Withdraw USDC from HyperCore to Solana","sidebarTitle":"Withdraw USDC from HyperCore to Solana","href":"/cctp/howtos/withdraw-usdc-from-hypercore-to-solana"},{"title":"Withdraw USDC from HyperCore to HyperEVM","href":"/cctp/howtos/withdraw-usdc-from-hypercore-to-hyperevm"}]},{"group":"Reference","pages":[{"title":"CCTP technical guide","sidebarTitle":"Technical guide","href":"/cctp/references/technical-guide"},{"title":"Attestation verification","href":"/cctp/references/attestation-verification"},{"title":"Migrate from CCTP V1 (Legacy) to V2","href":"/cctp/migration-from-v1-to-v2"}]},{"group":"CCTP V1 (Legacy)","pages":[{"title":"Cross-Chain Transfer Protocol V1","sidebarTitle":"CCTP V1 overview","href":"/cctp/v1"},{"group":"Concepts","pages":[{"title":"CCTP message passing V1","sidebarTitle":"Message passing","href":"/cctp/v1/generic-message-passing"},{"title":"CCTP message format V1","sidebarTitle":"Message format","href":"/cctp/v1/message-format"},{"title":"CCTP API hosts and endpoints V1","sidebarTitle":"API hosts and endpoints","href":"/cctp/v1/cctp-apis"},{"title":"CCTP limits V1","sidebarTitle":"Limits","href":"/cctp/v1/limits"}]},{"group":"Quickstarts","pages":[{"title":"Transfer USDC on testnet from Ethereum to Avalanche using CCTP V1","sidebarTitle":"Transfer USDC on testnet from Ethereum to Avalanche","href":"/cctp/v1/transfer-usdc-on-testnet-from-ethereum-to-avalanche"},{"title":"Transfer USDC on testnet between Noble and Ethereum using CCTP V1","sidebarTitle":"Transfer USDC on testnet between Noble and Ethereum","href":"/cctp/v1/transfer-usdc-on-testnet-from-noble-to-ethereum"},{"title":"Transfer USDC on testnet between Sui and Ethereum using CCTP V1","sidebarTitle":"Transfer USDC on testnet between Sui and Ethereum","href":"/cctp/v1/transfer-usdc-on-testnet-from-sui-to-ethereum"},{"title":"Transfer USDC on testnet between Aptos and Base using CCTP V1","sidebarTitle":"Transfer USDC on testnet between Aptos and Base","href":"/cctp/v1/transfer-usdc-on-testnet-from-aptos-to-base"},{"title":"Transfer USDC on devnet between Solana and other chains using CCTP V1","sidebarTitle":"Transfer USDC on devnet between Solana and other chains","href":"/cctp/v1/transfer-testnet-usdc-between-solana-devnet"}]},{"group":"References","pages":[{"title":"CCTP supported blockchains V1","sidebarTitle":"Supported blockchains","href":"/cctp/v1/cctp-supported-blockchains"},{"title":"CCTP EVM contracts and interfaces V1","sidebarTitle":"EVM contracts and interfaces","href":"/cctp/v1/evm-smart-contracts"},{"group":"Non-EVM contracts and interfaces","pages":[{"title":"CCTP Solana programs and interfaces V1","sidebarTitle":"Solana programs and interfaces","href":"/cctp/v1/solana-programs"},{"title":"CCTP Noble Cosmos module V1","sidebarTitle":"Noble Cosmos module and interface","href":"/cctp/v1/noble-cosmos-module"},{"title":"CCTP Sui packages and interfaces V1","sidebarTitle":"Sui packages and interfaces","href":"/cctp/v1/sui-packages"},{"title":"CCTP Aptos packages and interfaces V1","sidebarTitle":"Aptos packages and interfaces","href":"/cctp/v1/aptos-packages"}]},{"title":"CCTP block confirmations V1","sidebarTitle":"Block confirmations","href":"/cctp/v1/required-block-confirmations"},{"title":"CCTP chain domains V1","sidebarTitle":"Chain domains","href":"/cctp/v1/supported-domains"}]}]}]},{"group":"CCTP for non-USDC","pages":[{"title":"CCTP for non-USDC assets","sidebarTitle":"Overview","href":"/cctp/expanded-assets"},{"group":"Get started","pages":[{"title":"Supported blockchains and domains","sidebarTitle":"Supported blockchains","href":"/cctp/expanded-assets/concepts/supported-chains-and-domains"},{"title":"Ownerless and custom tokens","sidebarTitle":"Ownerless versus custom tokens","href":"/cctp/expanded-assets/concepts/ownerless-vs-custom-tokens"},{"group":"Quickstarts","pages":[{"title":"Transfer EURC from Ethereum to Arc","sidebarTitle":"Transfer EURC (Sepolia → Arc)","href":"/cctp/expanded-assets/quickstarts/transfer-eurc-ethereum-to-arc"},{"title":"Configure a custom token","sidebarTitle":"Configure a custom token","href":"/cctp/expanded-assets/quickstarts/configure-custom-token"},{"title":"Deploy a native crosschain token","href":"/cctp/expanded-assets/quickstarts/deploy-native-crosschain-token"},{"title":"Configure an ownerless token","sidebarTitle":"Configure an ownerless token","href":"/cctp/expanded-assets/quickstarts/configure-ownerless-token"}]}]},{"group":"Make your token crosschain","pages":[{"title":"How-to: Manage TokenManager roles","sidebarTitle":"Manage TokenManager roles","href":"/cctp/expanded-assets/howtos/manage-token-manager-roles"},{"title":"How-to: Configure rate limits and transfer caps","sidebarTitle":"Configure rate limits and caps","href":"/cctp/expanded-assets/howtos/configure-rate-limits-and-caps"},{"title":"Denylist layers","sidebarTitle":"Denylist layers","href":"/cctp/expanded-assets/concepts/denylist-layers"},{"title":"How-to: Configure a denylist provider","sidebarTitle":"Configure a denylist provider","href":"/cctp/expanded-assets/howtos/configure-denylist-provider"}]},{"group":"Build for non-USDC assets","pages":[{"title":"CCTP for non-USDC compared to CCTP","sidebarTitle":"Compared to CCTP","href":"/cctp/expanded-assets/concepts/cctp-differences"},{"title":"Hooks","sidebarTitle":"Hooks","href":"/cctp/expanded-assets/concepts/hooks"},{"title":"How-to: Build a hook receiver","sidebarTitle":"Build a hook receiver","href":"/cctp/expanded-assets/howtos/build-hook-receiver"}]},{"group":"Learn more","pages":[{"title":"CCTP for non-USDC architecture","sidebarTitle":"Architecture","href":"/cctp/expanded-assets/concepts/architecture"},{"title":"CCTP for non-USDC fees","sidebarTitle":"Fees","href":"/cctp/expanded-assets/references/fees"},{"title":"CCTP for non-USDC contract addresses","sidebarTitle":"Contract addresses","href":"/cctp/expanded-assets/references/contract-addresses"},{"title":"CCTP for non-USDC contract reference","sidebarTitle":"Contract reference","href":"/cctp/expanded-assets/references/contract-reference"}]}]},{"group":"Gateway","pages":[{"title":"Circle Gateway","sidebarTitle":"Gateway Overview","href":"/gateway"},{"group":"Get started","pages":[{"title":"Gateway supported blockchains","href":"/gateway/references/supported-blockchains"},{"title":"Use EURC and cirBTC with Gateway","sidebarTitle":"EURC and cirBTC","href":"/gateway/concepts/non-usdc-assets"},{"title":"Gateway fees","sidebarTitle":"Fees","href":"/gateway/references/fees"},{"title":"Circle Forwarding Service for Gateway","sidebarTitle":"Forwarding Service","href":"/gateway/references/forwarding-service"},{"group":"Quickstarts","pages":[{"title":"Quickstart: Create and transfer a unified USDC balance on EVM","sidebarTitle":"Create and transfer a unified USDC balance on EVM","href":"/gateway/quickstarts/unified-balance-evm"},{"title":"Quickstart: Create and transfer a unified USDC balance on Solana","sidebarTitle":"Create and transfer a unified USDC balance on Solana","href":"/gateway/quickstarts/unified-balance-solana"},{"title":"How-to: Transfer with the Forwarding Service","sidebarTitle":"Transfer with the Forwarding Service","href":"/gateway/howtos/forwarding-service"}]}]},{"group":"Transfer from a unified balance","pages":[{"title":"How-to: Create a unified USDC balance","sidebarTitle":"Create a unified USDC balance","href":"/gateway/howtos/create-unified-usdc-balance"},{"title":"How-to: Transfer a unified USDC balance instantly","sidebarTitle":"Transfer a unified USDC balance","href":"/gateway/howtos/transfer-unified-usdc-balance"},{"title":"How-to: Manage delegates for Gateway transfers","sidebarTitle":"Manage delegates","href":"/gateway/howtos/manage-delegates"},{"title":"How-to: Transfer USDC from a smart contract account","sidebarTitle":"Transfer from a SCA","href":"/gateway/howtos/transfer-with-erc-1271"}]},{"group":"Webhooks","pages":[{"title":"Gateway webhooks","sidebarTitle":"Webhooks overview","href":"/gateway/webhooks"}]},{"group":"Learn more","pages":[{"title":"Gateway technical guide","sidebarTitle":"Technical guide","href":"/gateway/references/technical-guide"},{"title":"ERC-1271 programmable authorization","sidebarTitle":"ERC-1271 support","href":"/gateway/references/erc-1271"},{"title":"Technical guide for Gateway on Solana","sidebarTitle":"Solana technical guide","href":"/gateway/references/solana"},{"title":"Gateway smart contract addresses on EVM","sidebarTitle":"EVM contract addresses","href":"/gateway/references/contract-addresses"},{"title":"Gateway contract interfaces and events on EVM","sidebarTitle":"EVM contract interfaces and events","href":"/gateway/references/contract-interfaces-and-events"},{"title":"Solana programs and interfaces for Gateway","sidebarTitle":"Solana programs and interfaces","href":"/gateway/references/solana-programs"}]}]}]},{"tab":"Agent stack","pages":[{"title":"Agent stack","sidebarTitle":"Overview","mode":"wide","href":"/agent-stack"},{"group":"Circle CLI","pages":[{"title":"Circle CLI","sidebarTitle":"Overview","href":"/agent-stack/circle-cli"},{"title":"CLI command reference","href":"/agent-stack/circle-cli/command-reference"},{"group":"Agent Wallets","expanded":false,"pages":[{"title":"Agent Wallets","sidebarTitle":"Overview","href":"/agent-stack/agent-wallets"},{"title":"Quickstart: Create an agent wallet","sidebarTitle":"Create an agent wallet","href":"/agent-stack/agent-wallets/quickstart"},{"title":"Agent wallet supported blockchains","sidebarTitle":"Supported blockchains","href":"/agent-stack/agent-wallets/supported-blockchains"},{"group":"Wallet operations","pages":[{"title":"Wallet operations","sidebarTitle":"Overview","href":"/agent-stack/agent-wallets/wallet-operations"},{"title":"How-to: Authenticate an agent wallet","sidebarTitle":"Authenticate","href":"/agent-stack/agent-wallets/wallet-operations/authenticate"},{"title":"How-to: Fund an agent wallet","sidebarTitle":"Fund wallet","href":"/agent-stack/agent-wallets/wallet-operations/fund"},{"title":"How-to: Transfer USDC","sidebarTitle":"Transfer USDC","href":"/agent-stack/agent-wallets/wallet-operations/transfer"},{"title":"How-to: Bridge USDC","sidebarTitle":"Bridge USDC","href":"/agent-stack/agent-wallets/wallet-operations/bridge"},{"title":"How-to: Swap tokens","sidebarTitle":"Swap tokens","href":"/agent-stack/agent-wallets/wallet-operations/swap"},{"title":"How-to: Execute a smart contract","sidebarTitle":"Execute contract","href":"/agent-stack/agent-wallets/wallet-operations/execute-contract"},{"title":"How-to: Sign a message","sidebarTitle":"Sign messages","href":"/agent-stack/agent-wallets/wallet-operations/sign"},{"title":"How-to: Set spending policies","sidebarTitle":"Set policies","href":"/agent-stack/agent-wallets/wallet-operations/custom-policies"}]},{"title":"Agent wallet fees","sidebarTitle":"Fees","href":"/agent-stack/agent-wallets/fees"}]},{"group":"Agent Nanopayments","expanded":false,"pages":[{"title":"Agent Nanopayments","sidebarTitle":"Overview","href":"/agent-stack/agent-nanopayments"},{"title":"Quickstart: Make a nanopayment","sidebarTitle":"Make a nanopayment","href":"/agent-stack/agent-nanopayments/quickstart"},{"group":"Nanopayment operations","pages":[{"title":"Nanopayment operations","sidebarTitle":"Overview","href":"/agent-stack/agent-nanopayments/operations"},{"title":"How-to: Deposit for nanopayments","sidebarTitle":"Deposit for nanopayments","href":"/agent-stack/agent-nanopayments/operations/deposit"},{"title":"How-to: Pay for a service","sidebarTitle":"Pay for a service","href":"/agent-stack/agent-nanopayments/operations/pay-for-service"},{"title":"How-to: Withdraw your balance","sidebarTitle":"Withdraw your balance","href":"/agent-stack/agent-nanopayments/operations/withdraw"}]},{"title":"Seller integration tools","sidebarTitle":"Seller integration tools","href":"/agent-stack/agent-nanopayments/seller-integration-tools"}]}]},{"group":"Agent marketplace","pages":[{"title":"Agent marketplace","sidebarTitle":"Overview","href":"/agent-stack/agent-marketplace"},{"title":"How-to: Become a seller","sidebarTitle":"Become a seller","href":"/agent-stack/agent-marketplace/become-a-seller"},{"title":"How-to: Get listed","sidebarTitle":"Get listed","href":"/agent-stack/agent-marketplace/get-listed"},{"title":"Discover x402 services","openapi":"openapi/agent-marketplace-discovery.yaml get /v2/x402/discovery/resources","href":"/agent-stack/agent-marketplace/discovery-api"}]},{"group":"x402 facilitators","pages":[{"title":"x402 facilitators","sidebarTitle":"Overview","href":"/x402-facilitators"},{"title":"What is x402?","sidebarTitle":"What is x402?","href":"/x402-facilitators/x402"},{"group":"Facilitator Service","expanded":false,"pages":[{"title":"Facilitator Service","sidebarTitle":"Overview","href":"/facilitator-service"},{"title":"How Facilitator Service works","sidebarTitle":"How Facilitator Service works","href":"/facilitator-service/how-it-works"},{"title":"Quickstart: Accept x402 payments with Facilitator Service","sidebarTitle":"Accept x402 payments","href":"/facilitator-service/quickstart"},{"title":"How-to: Set up a Permit2 allowance","sidebarTitle":"Set up a Permit2 allowance","href":"/facilitator-service/set-up-permit2-allowance"},{"group":"Keyless trial","pages":[{"title":"The keyless trial","sidebarTitle":"The keyless trial","href":"/facilitator-service/keyless-trial"},{"title":"How-to: Sign a seller proof","sidebarTitle":"Sign a seller proof","href":"/facilitator-service/sign-seller-proof"}]},{"title":"Supported networks","sidebarTitle":"Supported networks","href":"/facilitator-service/supported-networks"}]},{"group":"Gateway Nanopayments","expanded":false,"pages":[{"title":"Gateway Nanopayments","sidebarTitle":"Overview","href":"/gateway-nanopayments"},{"title":"How batched settlement works","sidebarTitle":"Batched settlement","href":"/gateway-nanopayments/concepts/batched-settlement"},{"group":"Quickstarts","pages":[{"title":"Quickstart: Pay for resources with nanopayments","sidebarTitle":"Pay for resources (buy)","href":"/gateway-nanopayments/quickstarts/buyer"},{"title":"Quickstart: Accept payments with nanopayments","sidebarTitle":"Accept payments (sell)","href":"/gateway-nanopayments/quickstarts/seller"}]},{"group":"Use with x402","pages":[{"title":"How-to: Use nanopayments with x402","sidebarTitle":"Use with x402","href":"/gateway-nanopayments/howtos/x402-integration"},{"title":"How-to: Add nanopayments to an x402 buyer","sidebarTitle":"x402 buyer integration","href":"/gateway-nanopayments/howtos/x402-buyer"},{"title":"How-to: Add nanopayments to an x402 seller","sidebarTitle":"x402 seller integration","href":"/gateway-nanopayments/howtos/x402-seller"},{"title":"How-to: Integrate nanopayments into your existing facilitator","sidebarTitle":"Integrate into your facilitator","href":"/gateway-nanopayments/howtos/facilitator-integration"},{"title":"How-to: Sign EIP-3009 payment authorizations","sidebarTitle":"Sign EIP-3009 authorizations","href":"/gateway-nanopayments/howtos/eip-3009-signing"}]},{"title":"How-to: Reconcile nanopayments as a seller","sidebarTitle":"Reconcile nanopayments","href":"/gateway-nanopayments/howtos/x402-seller-reconciliation"},{"title":"Supported networks","sidebarTitle":"Supported networks","href":"/gateway-nanopayments/supported-networks"}]}]}]},{"tab":"Payments","pages":[{"title":"Circle Payments Network","sidebarTitle":"Overview","mode":"wide","href":"/cpn"},{"group":"Fiat payouts","pages":[{"title":"Fiat payouts","sidebarTitle":"Overview","href":"/cpn/fiat-payouts"},{"title":"Integrate with CPN as an OFI","sidebarTitle":"Quickstart: Integrate with CPN as an OFI","href":"/cpn/quickstarts/integrate-with-cpn-ofi"},{"group":"Guides","expanded":false,"pages":[{"group":"API","pages":[{"title":"CPN integration concepts","sidebarTitle":"Integration concepts","href":"/cpn/concepts/api/api-integration"},{"title":"CPN API changes and compatibility","sidebarTitle":"API compatibility","href":"/cpn/concepts/api/api-changes"},{"title":"JSON Schema","href":"/cpn/concepts/api/json-schema"},{"title":"CPN component states and workflows","sidebarTitle":"Component states and workflows","href":"/cpn/concepts/payments/component-states-and-workflows"}]},{"title":"Mainnet vs. testnet","sidebarTitle":"Mainnet vs. testnet","href":"/cpn/concepts/environments/mainnet-vs-testnet"},{"title":"Quotes","href":"/cpn/concepts/quotes"},{"group":"Payments","pages":[{"title":"Payment","sidebarTitle":"Overview","href":"/cpn/concepts/payments/payments"},{"title":"Payment reference","href":"/cpn/concepts/payments/payment-reference"},{"title":"Supported payment methods","href":"/cpn/references/payments/supported-payment-methods"},{"title":"Payment reason codes","href":"/cpn/references/payments/payment-reason-codes"}]},{"group":"Compliance","pages":[{"title":"CPN supported countries","sidebarTitle":"Supported countries","href":"/cpn/references/compliance/supported-countries"},{"title":"Requests for information","sidebarTitle":"RFI","href":"/cpn/concepts/compliance/rfis"},{"title":"RFI levels","href":"/cpn/references/compliance/rfi-levels"},{"title":"Travel rule requirements","href":"/cpn/references/compliance/travel-rule-requirements"},{"title":"Validating Brazilian tax ID and bank account numbers","href":"/cpn/references/compliance/validating-brazil-tax-account-id"},{"title":"Validating IBAN bank account numbers","href":"/cpn/references/compliance/validating-iban"}]},{"group":"Transactions","pages":[{"title":"Transaction","sidebarTitle":"Overview","href":"/cpn/concepts/transactions/transaction-overview"},{"title":"Transactions V2","href":"/cpn/concepts/transactions/transactions-v2"},{"title":"Wallet nonce management","href":"/cpn/concepts/transactions/wallet-nonce-management"}]},{"group":"Blockchains","pages":[{"title":"Supported blockchains","href":"/cpn/references/blockchains/supported-blockchains"},{"title":"Wallet provider compatibility","href":"/cpn/references/blockchains/wallet-provider-compatibility"},{"title":"Bring your own wallet for CPN","sidebarTitle":"Bring your own wallet","href":"/cpn/concepts/wallets/bring-your-own-wallet"},{"title":"Block confirmation and transaction finality","href":"/cpn/concepts/transactions/block-confirmation-and-finality"},{"title":"Payment smart contract addresses","href":"/cpn/references/blockchains/contract-addresses"}]},{"group":"Webhooks","pages":[{"title":"Webhook retries","href":"/cpn/concepts/webhooks/webhook-retries"},{"title":"Webhook security","href":"/cpn/concepts/webhooks/webhook-security"}]},{"group":"Errors","pages":[{"title":"Payment and transaction failure reasons","href":"/cpn/references/errors/payment-and-transaction-failure-reasons"},{"title":"Payment failure codes","href":"/cpn/references/errors/payment-failure-codes"}]},{"group":"Testing","pages":[{"title":"Magic values for testing","href":"/cpn/references/testing/magic-values"}]}]},{"group":"How-tos","expanded":false,"pages":[{"group":"Wallets and liquidity","pages":[{"title":"How-to: Set up a Circle wallet for CPN payments","sidebarTitle":"Set up a Circle wallet for CPN","href":"/cpn/guides/wallets/setup-circle-wallet-for-cpn-payments"},{"title":"How-to: Set up Circle on/off-ramps for CPN payments","sidebarTitle":"Set up Circle on/off-ramps for CPN","href":"/cpn/guides/circle-liquidity/setup-circle-on-off-ramps-for-cpn-payments"}]},{"group":"Compliance","pages":[{"title":"How-to: Respond to an RFI","href":"/cpn/guides/compliance/respond-to-rfi"}]},{"group":"Payments","pages":[{"title":"Request payment configurations and routes","href":"/cpn/guides/payments/request-payment-config"},{"title":"Integrate with JSON Schema","href":"/cpn/guides/payments/integrate-with-json-schema"},{"title":"How-to: Encrypt travel rule and beneficiary data","sidebarTitle":"Encrypt travel rule and beneficiary data","href":"/cpn/guides/payments/encrypt-travel-rule-beneficiary-data"},{"title":"Encrypt files for RFI transmission","href":"/cpn/guides/payments/encrypt-files"}]},{"group":"Supports","hidden":true,"pages":[{"title":"Create a support ticket","href":"/cpn/guides/supports/create-support-ticket"}]},{"group":"Transactions","pages":[{"title":"Create an onchain transaction","href":"/cpn/guides/transactions/create-an-onchain-txn"},{"title":"How-to: Grant USDC allowance to Permit2","sidebarTitle":"Grant USDC allowance to Permit2","href":"/cpn/guides/transactions/grant-usdc-allowance-to-permit2"},{"title":"How-to: Migrate from transactions V1 to V2","sidebarTitle":"Migrate from transactions V1 to V2","href":"/cpn/guides/transactions/migrate-from-txn-v1-to-v2"}]}]}]},{"group":"Managed Payments","pages":[{"title":"Managed Payments","sidebarTitle":"Overview","href":"/cpn/managed-payments"},{"group":"Quickstarts","pages":[{"title":"Quickstart: Receive stablecoin payins","sidebarTitle":"Receive stablecoin payins","href":"/cpn/managed-payments/quickstarts/receive-stablecoin-payins"},{"title":"Quickstart: Send stablecoin payouts","sidebarTitle":"Send stablecoin payouts","href":"/cpn/managed-payments/quickstarts/send-stablecoin-payouts"}]},{"title":"Settlement flows","sidebarTitle":"Settlement flows","href":"/cpn/managed-payments/concepts/settlement-flows"},{"title":"Stablecoin payin and payout lifecycle","sidebarTitle":"Payin and payout lifecycle","href":"/cpn/managed-payments/concepts/stablecoin-payin-payout-lifecycle"},{"title":"Subaccount architecture","sidebarTitle":"Subaccount architecture","href":"/cpn/managed-payments/concepts/sub-account-architecture"},{"group":"End User Onboarding","pages":[{"title":"End User Onboarding","sidebarTitle":"Overview","href":"/cpn/managed-payments/end-user-onboarding"},{"group":"Get started","pages":[{"title":"Application types and states","sidebarTitle":"Application types and states","href":"/cpn/managed-payments/end-user-onboarding/references/application-states"},{"title":"Submit onboarding application","sidebarTitle":"Submit onboarding application","href":"/cpn/managed-payments/end-user-onboarding/quickstarts/submit-onboarding-application"}]},{"group":"Build applications","pages":[{"title":"How-to: Create and populate applications","sidebarTitle":"Create and populate applications","href":"/cpn/managed-payments/end-user-onboarding/howtos/create-and-populate-applications"},{"title":"How-to: Upload documents","sidebarTitle":"Upload documents","href":"/cpn/managed-payments/end-user-onboarding/howtos/upload-documents"},{"title":"How-to: Submit and track applications","sidebarTitle":"Submit and track applications","href":"/cpn/managed-payments/end-user-onboarding/howtos/submit-and-track-applications"},{"title":"How-to: Handle requests for information","sidebarTitle":"Handle requests for information","href":"/cpn/managed-payments/end-user-onboarding/howtos/handle-rfis"},{"title":"Webhook notifications","sidebarTitle":"Webhook notifications","href":"/cpn/managed-payments/end-user-onboarding/references/webhook-notifications"}]},{"group":"Concepts","pages":[{"title":"Conditional logic","sidebarTitle":"Conditional logic","href":"/cpn/managed-payments/end-user-onboarding/concepts/conditional-logic"},{"title":"Array sections","sidebarTitle":"Array sections","href":"/cpn/managed-payments/end-user-onboarding/concepts/array-sections"}]}]},{"title":"How-to: Refund a stablecoin payin","sidebarTitle":"Refund a stablecoin payin","href":"/cpn/managed-payments/howtos/refund-payin"},{"group":"Learn more","pages":[{"title":"Stablecoin payin states","sidebarTitle":"Stablecoin payin states","href":"/cpn/managed-payments/references/payment-intent-states"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/cpn/managed-payments/references/error-codes"},{"title":"Reporting","sidebarTitle":"Reporting","href":"/cpn/managed-payments/references/reporting"}]}]},{"group":"Stablecoin payments","pages":[{"title":"Stablecoin payments","sidebarTitle":"Overview","href":"/cpn/stablecoin-payments"},{"group":"Get started","pages":[{"title":"Supported blockchains","sidebarTitle":"Supported blockchains","href":"/cpn/stablecoin-payments/references/supported-blockchains"},{"title":"How stablecoin payments work","href":"/cpn/stablecoin-payments/concepts/how-stablecoin-payments-work"}]},{"group":"Payins","pages":[{"title":"How-to: Receive a stablecoin payin","sidebarTitle":"Receive a stablecoin payin","href":"/cpn/stablecoin-payments/howtos/receive-stablecoin-payin"},{"title":"How-to: Refund a stablecoin payin","sidebarTitle":"Refund a stablecoin payin","href":"/cpn/stablecoin-payments/howtos/refund-stablecoin-payin"}]},{"group":"Payouts","pages":[{"title":"How-to: Send a stablecoin payout","sidebarTitle":"Send a stablecoin payout","href":"/cpn/stablecoin-payments/howtos/send-stablecoin-payout"}]},{"group":"Learn more","pages":[{"title":"Webhook events","sidebarTitle":"Webhook events","href":"/cpn/stablecoin-payments/references/webhook-events"}]}]}]},{"tab":"Liquidity services","pages":[{"title":"Liquidity services","sidebarTitle":"Overview","mode":"wide","href":"/liquidity-services"},{"group":"Mint","pages":[{"title":"Circle Mint","sidebarTitle":"Mint overview","href":"/circle-mint"},{"group":"Get started","pages":[{"title":"Set up your account and API key","sidebarTitle":"Set up your Mint account","href":"/circle-mint/quickstarts/getting-started"},{"title":"Supported chains and currencies","sidebarTitle":"Supported chains and currencies","href":"/circle-mint/references/supported-chains-and-currencies"},{"title":"Blockchain confirmations","sidebarTitle":"Blockchain confirmations","href":"/circle-mint/references/blockchain-confirmations"},{"title":"Supported countries","sidebarTitle":"Supported countries","href":"/circle-mint/references/supported-countries"},{"title":"Quickstart: Mint and redeem USDC","sidebarTitle":"Mint and redeem USDC","href":"/circle-mint/quickstarts/mint-and-redeem"},{"title":"Quickstart: Mint and redeem cirBTC","sidebarTitle":"Mint and redeem cirBTC","href":"/circle-mint/quickstarts/mint-and-redeem-cirbtc"}]},{"group":"Mint and redeem","pages":[{"title":"How minting and redemption works","href":"/circle-mint/concepts/how-minting-works"},{"title":"How-to: Deposit fiat","sidebarTitle":"Deposit fiat","href":"/circle-mint/howtos/deposit-fiat"},{"title":"How-to: Withdraw fiat","sidebarTitle":"Withdraw fiat","href":"/circle-mint/howtos/withdraw-fiat"},{"title":"How-to: Transfer USDC onchain","sidebarTitle":"Transfer USDC onchain","href":"/circle-mint/howtos/transfer-on-chain"}]},{"group":"Exchange currencies","pages":[{"title":"Cross-currency exchange","href":"/circle-mint/concepts/cross-currency-exchange"},{"title":"How-to: Exchange currencies","sidebarTitle":"Exchange currencies","href":"/circle-mint/howtos/exchange-currencies"}]},{"group":"Credit","pages":[{"title":"Credit API","href":"/circle-mint/concepts/credit-api"},{"title":"Quickstart: Reserve and repay a settlement advance","sidebarTitle":"Reserve and repay a settlement advance","href":"/circle-mint/quickstarts/settlement-advance"},{"title":"Quickstart: Draw and repay a line of credit","sidebarTitle":"Draw and repay a line of credit","href":"/circle-mint/quickstarts/line-of-credit"}]},{"group":"Digital Asset-Backed Borrowing","pages":[{"title":"How Digital Asset-Backed Borrowing works","sidebarTitle":"How it works","href":"/circle-mint/concepts/digital-asset-backed-borrowing"},{"title":"Quickstart: Borrow USDC against cirBTC collateral","sidebarTitle":"Borrow USDC with cirBTC","href":"/circle-mint/quickstarts/borrow-with-cirbtc"},{"title":"How-to: Repay a loan","sidebarTitle":"Repay a loan","href":"/circle-mint/howtos/repay-loan"},{"title":"How-to: Add collateral to a loan","sidebarTitle":"Add collateral to a loan","href":"/circle-mint/howtos/add-collateral"},{"title":"How-to: Add another wallet owner","sidebarTitle":"Add another wallet owner","href":"/circle-mint/howtos/add-wallet-owner"}]},{"group":"Institutional distribution","pages":[{"title":"Institutional API","href":"/circle-mint/concepts/institutional-api"},{"title":"Manage institutional subaccounts","sidebarTitle":"Manage institutional subaccounts","href":"/circle-mint/quickstarts/manage-institutional-subaccounts"}]},{"group":"Learn more","pages":[{"title":"CAMT.053 daily statements","sidebarTitle":"CAMT.053 statements","href":"/circle-mint/references/camt053-statements"},{"title":"Supported payment rails","sidebarTitle":"Supported payment rails","href":"/circle-mint/references/supported-payment-rails"},{"title":"Webhook notifications","sidebarTitle":"Webhook notifications","href":"/circle-mint/references/webhook-notifications"},{"title":"Sandbox to production","sidebarTitle":"Sandbox to production","href":"/circle-mint/references/sandbox-and-testing"},{"title":"Travel rule compliance","sidebarTitle":"Travel rule compliance","href":"/circle-mint/references/travel-rule-compliance"},{"group":"mTLS Authentication","pages":[{"title":"How mTLS authentication works","sidebarTitle":"How mTLS works","href":"/circle-mint/mtls-authentication"},{"title":"How-to: Set up mTLS authentication","sidebarTitle":"Set up mTLS authentication","href":"/circle-mint/set-up-mtls-authentication"},{"title":"How-to: Rotate an mTLS API key","sidebarTitle":"Rotate an mTLS API key","href":"/circle-mint/rotate-mtls-api-key"},{"title":"How-to: Rotate an mTLS client certificate","sidebarTitle":"Rotate an mTLS client certificate","href":"/circle-mint/rotate-mtls-certificate"}]}]}]},{"group":"Match","pages":[{"title":"Circle Match","sidebarTitle":"Circle Match overview","href":"/circle-match"},{"group":"Get started","pages":[{"title":"Place your first order","sidebarTitle":"Place your first order","href":"/circle-match/quickstarts/place-your-first-order"},{"group":"Concepts","pages":[{"title":"How Match works","href":"/circle-match/concepts/how-it-works"},{"title":"Match funding model","href":"/circle-match/concepts/funding-model"}]}]},{"group":"Place orders","pages":[{"title":"How-to: Place and manage orders","sidebarTitle":"Place and manage orders","href":"/circle-match/howtos/place-orders"},{"title":"How-to: Cancel and modify orders","sidebarTitle":"Cancel and modify orders","href":"/circle-match/howtos/cancel-and-modify-orders"}]},{"group":"Manage your account","pages":[{"title":"How-to: Fund your account","sidebarTitle":"Fund your account","href":"/circle-match/howtos/fund-your-account"},{"title":"How-to: Withdraw funds","sidebarTitle":"Withdraw funds","href":"/circle-match/howtos/withdraw-funds"},{"title":"How-to: Monitor your account","sidebarTitle":"Monitor your account","href":"/circle-match/howtos/monitor-account"}]},{"group":"Real-time updates","pages":[{"title":"How-to: Subscribe to real-time updates","sidebarTitle":"Subscribe to real-time updates","href":"/circle-match/howtos/subscribe-to-real-time-updates"},{"title":"WebSocket reference","sidebarTitle":"WebSocket reference","href":"/circle-match/references/websocket-reference"}]}]},{"group":"StableFX","pages":[{"title":"StableFX","sidebarTitle":"StableFX overview","href":"/stablefx"},{"group":"Get started","pages":[{"title":"StableFX supported currencies","sidebarTitle":"Supported currencies","href":"/stablefx/references/supported-currencies"},{"title":"StableFX Talos integration for makers","sidebarTitle":"Talos integration for makers","href":"/stablefx/concepts/maker-talos-integration"},{"group":"Quickstarts","pages":[{"title":"Quickstart: Create an FX trade as a taker","sidebarTitle":"Create an FX trade as a taker","href":"/stablefx/quickstarts/fx-trade-taker"},{"title":"Quickstart: Fulfill an FX trade as a maker","sidebarTitle":"Fulfill an FX trade as a maker","href":"/stablefx/quickstarts/fx-trade-maker"},{"title":"Execute your first trade in the Console","sidebarTitle":"First trade","href":"/stablefx/quickstarts/console-first-trade"}]}]},{"group":"Console","pages":[{"title":"StableFX Console","sidebarTitle":"Console overview","href":"/stablefx/concepts/console-overview"},{"title":"How-to: Generate a StableFX API key","sidebarTitle":"Generate an API key","href":"/stablefx/howtos/get-api-key"},{"title":"How-to: Connect your wallet","sidebarTitle":"Connect wallet","href":"/stablefx/howtos/connect-wallet-console"},{"title":"How-to: Create a trade in the Console","sidebarTitle":"Create a trade","href":"/stablefx/howtos/create-trade-console"},{"title":"How-to: Fulfill a trade as a maker","sidebarTitle":"Fulfill a trade","href":"/stablefx/howtos/fulfill-trade-console"},{"title":"How-to: Settle trades in the Console","sidebarTitle":"Settle trades","href":"/stablefx/howtos/settle-trades-console"},{"title":"Console roles and permissions","sidebarTitle":"Roles \u0026 permissions","href":"/stablefx/references/console-roles-permissions"}]},{"title":"Grant USDC allowance to Permit2","href":"/stablefx/howtos/grant-usdc-allowance-permit2"},{"title":"How-to: Fund a trade with a settlement advance","sidebarTitle":"Fund a trade with a settlement advance","href":"/stablefx/howtos/fund-trade-settlement-advance"},{"title":"Test your StableFX integration as a taker","href":"/stablefx/tutorials/test-stablefx-integration-taker"},{"title":"Test your StableFX integration as a maker","href":"/stablefx/tutorials/test-stablefx-integration-maker"},{"group":"Learn more","pages":[{"title":"StableFX technical guide","sidebarTitle":"Technical guide","href":"/stablefx/concepts/technical-guide"},{"title":"StableFX risk buffers","sidebarTitle":"Risk buffers","href":"/stablefx/concepts/risk-buffers"},{"title":"StableFX settlement advance","sidebarTitle":"Settlement advance","href":"/stablefx/concepts/settlement-advance"},{"title":"StableFX contract interfaces","sidebarTitle":"Contract interfaces","href":"/stablefx/references/contract-interfaces"},{"title":"StableFX trade states","sidebarTitle":"Trade states","href":"/stablefx/references/trade-states"},{"title":"Magic numbers for testing StableFX","sidebarTitle":"Magic numbers for testing","href":"/stablefx/references/testing-magic-numbers"}]}]},{"group":"Digital Asset Accounts","pages":[{"title":"Digital Asset Accounts","sidebarTitle":"Digital Asset Accounts overview","href":"/digital-asset-accounts"},{"group":"Get started","pages":[{"title":"Account structure","sidebarTitle":"Account structure","href":"/digital-asset-accounts/concepts/account-structure"},{"title":"EEA operations under MiCA","sidebarTitle":"EEA and MiCA","href":"/digital-asset-accounts/concepts/eea-and-mica"},{"title":"Supported currencies and blockchains","sidebarTitle":"Supported currencies and blockchains","href":"/digital-asset-accounts/references/supported-currencies-and-blockchains"},{"title":"Onboard customers","sidebarTitle":"Onboard customers","href":"/digital-asset-accounts/quickstarts/onboard-customers"},{"title":"How-to: Onboard EEA customers","sidebarTitle":"Onboard EEA customers","href":"/digital-asset-accounts/howtos/onboard-eea-customers"},{"title":"Fund your digital asset account with a wire deposit","sidebarTitle":"Fund account with wire deposit","href":"/digital-asset-accounts/quickstarts/fund-account-with-wire-deposit"}]},{"group":"Fiat operations","pages":[{"title":"How-to: Wire deposits and withdrawals","sidebarTitle":"Wire deposits and withdrawals","href":"/digital-asset-accounts/howtos/wire-deposits-and-withdrawals"}]},{"group":"Crypto operations","pages":[{"title":"How-to: Create deposit addresses","sidebarTitle":"Create deposit addresses","href":"/digital-asset-accounts/howtos/create-deposit-addresses"},{"title":"How-to: Send crypto transfers","sidebarTitle":"Send crypto transfers","href":"/digital-asset-accounts/howtos/crypto-transfers"},{"title":"How-to: Use self-hosted wallets","sidebarTitle":"Use self-hosted wallets","href":"/digital-asset-accounts/howtos/self-hosted-wallets"}]},{"group":"Internal transfers","pages":[{"title":"How-to: Transfer funds internally","sidebarTitle":"Transfer funds internally","href":"/digital-asset-accounts/howtos/internal-transfers"}]},{"group":"Strong Customer Authentication","pages":[{"title":"How Strong Customer Authentication works","sidebarTitle":"How SCA works","href":"/digital-asset-accounts/concepts/strong-customer-authentication"},{"title":"How-to: Implement Strong Customer Authentication","sidebarTitle":"Implement SCA","href":"/digital-asset-accounts/howtos/strong-customer-authentication"}]},{"group":"Learn more","pages":[{"title":"Direct end-user custody model","sidebarTitle":"Custody model","href":"/digital-asset-accounts/concepts/custody-model"},{"group":"Compliance obligations","pages":[{"title":"Compliance obligations","href":"/digital-asset-accounts/references/compliance-obligations"},{"title":"Regulated customer notices","sidebarTitle":"Regulated customer notices","href":"/digital-asset-accounts/references/compliance-obligations/regulated-customer-notices"},{"title":"Record retention","sidebarTitle":"Record retention","href":"/digital-asset-accounts/references/compliance-obligations/record-retention"}]},{"title":"EEA API behavior","sidebarTitle":"EEA API behavior","href":"/digital-asset-accounts/references/eea-api-behavior"},{"title":"Receipts and disclosures","href":"/digital-asset-accounts/references/receipts-and-disclosures"},{"title":"Limits and risk ratings","sidebarTitle":"Limits and risk ratings","href":"/digital-asset-accounts/concepts/limits-and-risk-ratings"},{"title":"Transaction states","sidebarTitle":"Transaction states","href":"/digital-asset-accounts/references/transaction-states"},{"title":"Sandbox environment","sidebarTitle":"Sandbox environment","href":"/digital-asset-accounts/references/testing-in-sandbox"},{"title":"Going to production","sidebarTitle":"Going to production","href":"/digital-asset-accounts/references/going-to-production"}]}]},{"group":"End User Onboarding","pages":[{"title":"End User Onboarding","sidebarTitle":"Overview","href":"/end-user-onboarding"},{"group":"Get started","pages":[{"title":"Application types and states","sidebarTitle":"Application types and states","href":"/end-user-onboarding/references/application-states"},{"title":"Submit onboarding application","sidebarTitle":"Submit onboarding application","href":"/end-user-onboarding/quickstarts/submit-onboarding-application"}]},{"group":"Build applications","pages":[{"title":"How-to: Create and populate applications","sidebarTitle":"Create and populate applications","href":"/end-user-onboarding/howtos/create-and-populate-applications"},{"title":"How-to: Upload documents","sidebarTitle":"Upload documents","href":"/end-user-onboarding/howtos/upload-documents"},{"title":"Document file rules","sidebarTitle":"Document file rules","href":"/end-user-onboarding/references/document-file-rules"},{"title":"How-to: Collect device risk signals","sidebarTitle":"Collect device risk signals","href":"/end-user-onboarding/howtos/collect-device-risk-signals"},{"title":"How-to: Submit and track applications","sidebarTitle":"Submit and track applications","href":"/end-user-onboarding/howtos/submit-and-track-applications"},{"title":"How-to: Handle requests for information","sidebarTitle":"Handle requests for information","href":"/end-user-onboarding/howtos/handle-rfis"},{"title":"Webhook notifications","sidebarTitle":"Webhook notifications","href":"/end-user-onboarding/references/webhook-notifications"},{"title":"Magic numbers for testing End User Onboarding","sidebarTitle":"Magic numbers for testing","href":"/end-user-onboarding/references/testing-magic-numbers"}]},{"group":"Concepts","pages":[{"title":"Conditional logic","sidebarTitle":"Conditional logic","href":"/end-user-onboarding/concepts/conditional-logic"},{"title":"Array sections","sidebarTitle":"Array sections","href":"/end-user-onboarding/concepts/array-sections"}]}]}]},{"tab":"API reference","anchors":[{"anchor":"Home","icon":"home","pages":[{"title":"API reference","sidebarTitle":"API reference overview","mode":"wide","href":"/api-reference"},{"title":"API keys","href":"/api-reference/keys"},{"title":"Idempotent requests","href":"/api-reference/idempotent-requests"},{"title":"API errors","sidebarTitle":"Errors","href":"/api-reference/errors"},{"title":"OpenAPI Specifications","sidebarTitle":"OpenAPI Specs","href":"/api-reference/openapi-specifications"},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/api-reference/webhooks"},{"title":"How-to: Set up a webhook endpoint","sidebarTitle":"Set up an endpoint","href":"/api-reference/webhook-endpoints"},{"title":"How-to: Verify webhook signatures","sidebarTitle":"Verify webhook signatures","href":"/api-reference/verify-webhook-signatures"}]},{"group":"Audit Logs","pages":[{"openapi":"openapi/openapi-public.yaml get /v1/auditLogs","title":"List audit logs","href":"/api-reference/audit-logs/list-audit-logs"},{"openapi":"openapi/openapi-public.yaml get /v1/auditLogs/{id}","title":"Get an audit log by ID","href":"/api-reference/audit-logs/get-audit-log-by-id"}]}]},{"anchor":"Wallets","icon":"wallet","pages":[{"title":"Wallets API","sidebarTitle":"Overview","href":"/api-reference/wallets"},{"title":"Postman collection","href":"/api-reference/wallets/postman"},{"title":"Wallets API rate limits","sidebarTitle":"Rate limits","href":"/api-reference/wallets/rate-limits"},{"title":"Wallets API error codes","sidebarTitle":"Error codes","href":"/api-reference/wallets/error-codes"},{"title":"Transaction states and errors","href":"/api-reference/wallets/transaction-states-and-errors"},{"group":"API overview","pages":[{"group":"Health","pages":[{"openapi":"openapi/configurations_2.yaml get /ping","title":"Ping","href":"/api-reference/wallets/common/ping"}]},{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/configurations_2.yaml get /v2/notifications/subscriptions","title":"Get all notification subscriptions","href":"/api-reference/wallets/common/get-subscriptions"},{"openapi":"openapi/configurations_2.yaml post /v2/notifications/subscriptions","title":"Create a notification subscription","href":"/api-reference/wallets/common/create-subscription"},{"openapi":"openapi/configurations_2.yaml get /v2/notifications/subscriptions/{id}","title":"Retrieve a notification subscription","href":"/api-reference/wallets/common/get-subscription"},{"openapi":"openapi/configurations_2.yaml patch /v2/notifications/subscriptions/{id}","title":"Update a notification subscription","href":"/api-reference/wallets/common/update-subscription"},{"openapi":"openapi/configurations_2.yaml delete /v2/notifications/subscriptions/{id}","title":"Delete a notification subscription","href":"/api-reference/wallets/common/delete-subscription"},{"openapi":"openapi/configurations_2.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/wallets/common/get-notification-signature"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/configurations_2.yaml webhook transactionsInbound","title":"Inbound transaction notification","href":"/api-reference/wallets/common/transactions-inbound"},{"openapi":"openapi/configurations_2.yaml webhook transactionsOutbound","title":"Outbound transaction notification","href":"/api-reference/wallets/common/transactions-outbound"},{"openapi":"openapi/configurations_2.yaml webhook challengesInitialize","title":"Challenge notification","href":"/api-reference/wallets/common/challenges-initialize"}]}]},{"group":"Configurations","pages":[{"group":"Faucet","pages":[{"openapi":"openapi/configurations_1.yaml post /v1/faucet/drips","title":"Request testnet tokens","href":"/api-reference/wallets/programmable-wallets/request-testnet-tokens"}]},{"group":"Monitor Tokens","pages":[{"openapi":"openapi/configurations_1.yaml get /v1/w3s/config/entity/monitoredTokens","title":"Retrieve existing monitored tokens.","href":"/api-reference/wallets/programmable-wallets/list-monitored-tokens"},{"openapi":"openapi/configurations_1.yaml post /v1/w3s/config/entity/monitoredTokens","title":"Set monitored tokens","href":"/api-reference/wallets/programmable-wallets/create-monitored-tokens"},{"openapi":"openapi/configurations_1.yaml put /v1/w3s/config/entity/monitoredTokens","title":"Update monitored tokens","href":"/api-reference/wallets/programmable-wallets/update-monitored-tokens"},{"openapi":"openapi/configurations_1.yaml put /v1/w3s/config/entity/monitoredTokens/scope","title":"Update monitored tokens scope","href":"/api-reference/wallets/programmable-wallets/update-monitored-tokens-scope"},{"openapi":"openapi/configurations_1.yaml post /v1/w3s/config/entity/monitoredTokens/delete","title":"Delete monitored tokens","href":"/api-reference/wallets/programmable-wallets/delete-monitored-tokens"}]},{"group":"Developer Account","pages":[{"openapi":"openapi/configurations_1.yaml get /v1/w3s/config/entity/publicKey","title":"Get public key for entity","href":"/api-reference/wallets/programmable-wallets/get-public-key"},{"openapi":"openapi/configurations_1.yaml get /v1/w3s/config/entity","title":"Get configuration for entity","href":"/api-reference/wallets/programmable-wallets/get-entity-config"}]}]},{"group":"Developer-controlled","pages":[{"group":"Wallets","pages":[{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/wallets","title":"Create wallets","href":"/api-reference/wallets/developer-controlled-wallets/create-wallet"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/wallets","title":"List wallets","href":"/api-reference/wallets/developer-controlled-wallets/get-wallets"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/wallets/{id}","title":"Retrieve a wallet","href":"/api-reference/wallets/developer-controlled-wallets/get-wallet"},{"openapi":"openapi/developer-controlled-wallets.yaml put /v1/w3s/wallets/{id}","title":"Update a wallet","href":"/api-reference/wallets/developer-controlled-wallets/update-wallet"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/developer/wallets/balances","title":"List wallets with balances","href":"/api-reference/wallets/developer-controlled-wallets/get-wallets-with-balances"},{"openapi":"openapi/developer-controlled-wallets.yaml put /v1/w3s/developer/wallets/derive","title":"Derive wallet by address","href":"/api-reference/wallets/developer-controlled-wallets/derive-wallet-by-address"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/wallets/{id}/balances","title":"Get token balance for a wallet","href":"/api-reference/wallets/developer-controlled-wallets/list-wallet-balance"},{"openapi":"openapi/developer-controlled-wallets.yaml put /v1/w3s/developer/wallets/{id}/blockchains/{blockchain}","title":"Derive a wallet","href":"/api-reference/wallets/developer-controlled-wallets/derive-wallet"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/wallets/{id}/nfts","title":"Get NFTs for a wallet","href":"/api-reference/wallets/developer-controlled-wallets/list-wallet-nfts"}]},{"group":"Signing","pages":[{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/sign/message","title":"Sign message","href":"/api-reference/wallets/developer-controlled-wallets/sign-message"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/sign/typedData","title":"Sign typed data","href":"/api-reference/wallets/developer-controlled-wallets/sign-typed-data"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/sign/transaction","title":"Sign transaction","href":"/api-reference/wallets/developer-controlled-wallets/sign-transaction"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/sign/delegateAction","title":"Sign delegate action","href":"/api-reference/wallets/developer-controlled-wallets/sign-delegate-action"}]},{"group":"Transactions","pages":[{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/transactions","title":"List transactions","href":"/api-reference/wallets/developer-controlled-wallets/list-transactions"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/transactions/{id}","title":"Get a transaction","href":"/api-reference/wallets/developer-controlled-wallets/get-transaction"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/transactions/lowestNonceTransaction","title":"Get the lowest nonce pending transaction for a wallet","href":"/api-reference/wallets/developer-controlled-wallets/get-lowest-nonce-transaction"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/developer/transactions/feeParameters","title":"Get fee parameters of a blockchain","href":"/api-reference/wallets/developer-controlled-wallets/get-fee-parameters"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/transactions/transfer","title":"Create a transfer transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-developer-transaction-transfer"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/transactions/validateAddress","title":"Validate an address","href":"/api-reference/wallets/developer-controlled-wallets/create-validate-address"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/transactions/contractExecution/estimateFee","title":"Estimate fee for a contract execution transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-transaction-estimate-fee"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/transactions/transfer/estimateFee","title":"Estimate fee for a transfer transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-transfer-estimate-fee"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/transactions/contractExecution","title":"Create a contract execution transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-developer-transaction-contract-execution"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/transactions/walletUpgrade","title":"Create a wallet upgrade transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-developer-transaction-wallet-upgrade"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/transactions/{id}/cancel","title":"Cancel a transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-developer-transaction-cancel"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/transactions/{id}/accelerate","title":"Accelerate a transaction","href":"/api-reference/wallets/developer-controlled-wallets/create-developer-transaction-accelerate"}]},{"group":"Wallet Sets","pages":[{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/walletSets","title":"Get all wallet sets","href":"/api-reference/wallets/developer-controlled-wallets/get-wallet-sets"},{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/walletSets/{id}","title":"Get a wallet set","href":"/api-reference/wallets/developer-controlled-wallets/get-wallet-set"},{"openapi":"openapi/developer-controlled-wallets.yaml post /v1/w3s/developer/walletSets","title":"Create a new wallet set","href":"/api-reference/wallets/developer-controlled-wallets/create-wallet-set"},{"openapi":"openapi/developer-controlled-wallets.yaml put /v1/w3s/developer/walletSets/{id}","title":"Update a wallet set","href":"/api-reference/wallets/developer-controlled-wallets/update-wallet-set"}]},{"group":"Token Lookup","pages":[{"openapi":"openapi/developer-controlled-wallets.yaml get /v1/w3s/tokens/{id}","title":"Get token details","href":"/api-reference/wallets/developer-controlled-wallets/get-token-id"}]}]},{"group":"User-controlled","pages":[{"group":"Users","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/initialize","title":"Create a challenge for user initialization with wallet creation","href":"/api-reference/wallets/user-controlled-wallets/create-user-with-pin-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/users","title":"List users","href":"/api-reference/wallets/user-controlled-wallets/list-users"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/users/{id}","title":"Get a user by ID","href":"/api-reference/wallets/user-controlled-wallets/get-user"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/user/challenges","title":"List challenges","href":"/api-reference/wallets/user-controlled-wallets/list-user-challenges"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/user/challenges/{id}","title":"Get a challenge","href":"/api-reference/wallets/user-controlled-wallets/get-user-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/user","title":"Get user","href":"/api-reference/wallets/user-controlled-wallets/get-user-by-token"}]},{"group":"Wallets","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/wallets","title":"Create wallets","href":"/api-reference/wallets/user-controlled-wallets/create-user-wallet"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/wallets/{id}/balances","title":"Get token balance for a wallet","href":"/api-reference/wallets/user-controlled-wallets/list-wallet-balance"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/wallets/{id}/nfts","title":"Get NFTs for a wallet","href":"/api-reference/wallets/user-controlled-wallets/list-wallet-nfts"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/wallets/{id}","title":"Get a wallet","href":"/api-reference/wallets/user-controlled-wallets/get-wallet"},{"openapi":"openapi/user-controlled-wallets.yaml put /v1/w3s/wallets/{id}","title":"Update a wallet","href":"/api-reference/wallets/user-controlled-wallets/update-wallet"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/wallets","title":"List wallets","href":"/api-reference/wallets/user-controlled-wallets/list-wallets"}]},{"group":"Transactions","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/transactions/transfer","title":"Create a challenge for a transfer","href":"/api-reference/wallets/user-controlled-wallets/create-user-transaction-transfer-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/transactions/{id}/accelerate","title":"Create a Challenge to accelerate a transaction","href":"/api-reference/wallets/user-controlled-wallets/create-user-transaction-accelerate-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/transactions/{id}/cancel","title":"Create a challenge to cancel a transaction","href":"/api-reference/wallets/user-controlled-wallets/create-user-transaction-cancel-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/transactions/contractExecution","title":"Create a challenge for contract execution","href":"/api-reference/wallets/user-controlled-wallets/create-user-transaction-contract-execution-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/transactions/walletUpgrade","title":"Create a challenge for a wallet upgrade","href":"/api-reference/wallets/user-controlled-wallets/create-user-transaction-wallet-upgrade-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/transactions","title":"List transactions","href":"/api-reference/wallets/user-controlled-wallets/list-transactions"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/transactions/{id}","title":"Get a transaction","href":"/api-reference/wallets/user-controlled-wallets/get-transaction"},{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/transactions/lowestNonceTransaction","title":"Get the lowest nonce pending transaction for a wallet","href":"/api-reference/wallets/user-controlled-wallets/get-lowest-nonce-transaction"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/transactions/transfer/estimateFee","title":"Estimate fee for a transfer transaction","href":"/api-reference/wallets/user-controlled-wallets/create-transfer-estimate-fee"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/transactions/contractExecution/estimateFee","title":"Estimate fee for a contract execution transaction","href":"/api-reference/wallets/user-controlled-wallets/create-transaction-estimate-fee"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/transactions/validateAddress","title":"Validate an address","href":"/api-reference/wallets/user-controlled-wallets/create-validate-address"}]},{"group":"Signing","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/sign/message","title":"Create a challenge to sign message","href":"/api-reference/wallets/user-controlled-wallets/sign-user-message"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/sign/typedData","title":"Create a challenge to sign typed data","href":"/api-reference/wallets/user-controlled-wallets/sign-user-typed-data"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/sign/transaction","title":"Create a challenge to sign transaction","href":"/api-reference/wallets/user-controlled-wallets/sign-user-transaction"}]},{"group":"PIN Authentication","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users","title":"Create a user","href":"/api-reference/wallets/user-controlled-wallets/create-user"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users/token","title":"Create a user token","href":"/api-reference/wallets/user-controlled-wallets/get-user-token"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/pin","title":"Create a challenge for PIN setup","href":"/api-reference/wallets/user-controlled-wallets/create-user-pin-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml put /v1/w3s/user/pin","title":"Create a challenge to update PIN","href":"/api-reference/wallets/user-controlled-wallets/update-user-pin-challenge"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/user/pin/restore","title":"Create a challenge for PIN restore","href":"/api-reference/wallets/user-controlled-wallets/create-user-pin-restore-challenge"}]},{"group":"Token Lookup","pages":[{"openapi":"openapi/user-controlled-wallets.yaml get /v1/w3s/tokens/{id}","title":"Get token details","href":"/api-reference/wallets/user-controlled-wallets/get-token-id"}]},{"group":"Social/ Email Authentication","pages":[{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users/social/token","title":"Get deviceToken to perform social login","href":"/api-reference/wallets/user-controlled-wallets/create-device-token-social-login"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users/email/token","title":"Get a deviceToken to log in with email OTP","href":"/api-reference/wallets/user-controlled-wallets/create-device-token-email-login"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users/token/refresh","title":"Get a new userToken with the refreshToken","href":"/api-reference/wallets/user-controlled-wallets/refresh-user-token"},{"openapi":"openapi/user-controlled-wallets.yaml post /v1/w3s/users/email/resendOTP","title":"Resend an OTP email to the user","href":"/api-reference/wallets/user-controlled-wallets/resend-otp"}]}]},{"group":"Modular","pages":[{"group":"Transfers","pages":[{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/transfers","title":"List transfers","href":"/api-reference/wallets/buidl/list-transfers"},{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/transfers/{id}","title":"Retrieve a transfer","href":"/api-reference/wallets/buidl/get-transfer"}]},{"group":"UserOps","pages":[{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/userOps","title":"List user operations","href":"/api-reference/wallets/buidl/list-user-ops"},{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/userOps/{id}","title":"Retrieve a user operation","href":"/api-reference/wallets/buidl/get-user-op"}]},{"group":"Wallets","pages":[{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/wallets/{id}/balances","title":"Get wallet balances","href":"/api-reference/wallets/buidl/list-wallet-balances-by-id"},{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/wallets/{id}/nfts","title":"Get wallet NFTs","href":"/api-reference/wallets/buidl/list-wallet-nfts-by-id"},{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/wallets/{blockchain}/{address}/balances","title":"Get wallet balances by blockchain and address","href":"/api-reference/wallets/buidl/list-wallet-balances-by-blockchain-address"},{"openapi":"openapi/buidl-wallets.yaml get /v1/w3s/buidl/wallets/{blockchain}/{address}/nfts","title":"Get wallet NFTs by blockchain and address","href":"/api-reference/wallets/buidl/list-wallet-nfts-by-blockchain-address"}]}]},{"group":"Compliance Engine","pages":[{"group":"Address Screening","pages":[{"openapi":"openapi/compliance.yaml post /v1/w3s/compliance/screening/addresses","title":"Screen a blockchain address","href":"/api-reference/wallets/compliance/screen-address"}]}]}]},{"anchor":"Contracts","icon":"file-contract","pages":[{"title":"Contracts API","sidebarTitle":"Overview","href":"/api-reference/contracts"},{"title":"Postman collection","href":"/api-reference/contracts/postman"},{"title":"Contracts API error codes","sidebarTitle":"Error codes","href":"/api-reference/contracts/error-codes"},{"group":"API overview","pages":[{"group":"Health","pages":[{"openapi":"openapi/configurations_2.yaml get /ping","title":"Ping","href":"/api-reference/contracts/common/ping"}]},{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/configurations_2.yaml get /v2/notifications/subscriptions","title":"Get all notification subscriptions","href":"/api-reference/contracts/common/get-subscriptions"},{"openapi":"openapi/configurations_2.yaml post /v2/notifications/subscriptions","title":"Create a notification subscription","href":"/api-reference/contracts/common/create-subscription"},{"openapi":"openapi/configurations_2.yaml get /v2/notifications/subscriptions/{id}","title":"Retrieve a notification subscription","href":"/api-reference/contracts/common/get-subscription"},{"openapi":"openapi/configurations_2.yaml patch /v2/notifications/subscriptions/{id}","title":"Update a notification subscription","href":"/api-reference/contracts/common/update-subscription"},{"openapi":"openapi/configurations_2.yaml delete /v2/notifications/subscriptions/{id}","title":"Delete a notification subscription","href":"/api-reference/contracts/common/delete-subscription"},{"openapi":"openapi/configurations_2.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/contracts/common/get-notification-signature"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/configurations_2.yaml webhook transactionsInbound","title":"Inbound transaction notification","href":"/api-reference/contracts/common/transactions-inbound"},{"openapi":"openapi/configurations_2.yaml webhook transactionsOutbound","title":"Outbound transaction notification","href":"/api-reference/contracts/common/transactions-outbound"},{"openapi":"openapi/configurations_2.yaml webhook challengesInitialize","title":"Challenge notification","href":"/api-reference/contracts/common/challenges-initialize"}]}]},{"group":"Contracts","pages":[{"group":"Templates","pages":[{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/templates/{id}/deploy/estimateFee","title":"Estimate fee for a contract template deployment","href":"/api-reference/contracts/smart-contract-platform/estimate-contract-template-deploy"},{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/templates/{id}/deploy","title":"Deploy a contract from a template","href":"/api-reference/contracts/smart-contract-platform/deploy-contract-template"}]},{"group":"Interact","pages":[{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/contracts/query","title":"Execute a query function on a contract","href":"/api-reference/contracts/smart-contract-platform/query-contract"}]},{"group":"View / Update","pages":[{"openapi":"openapi/smart-contract-platform.yaml get /v1/w3s/contracts","title":"List contracts","href":"/api-reference/contracts/smart-contract-platform/list-contracts"},{"openapi":"openapi/smart-contract-platform.yaml get /v1/w3s/contracts/{id}","title":"Get a contract","href":"/api-reference/contracts/smart-contract-platform/get-contract"},{"openapi":"openapi/smart-contract-platform.yaml patch /v1/w3s/contracts/{id}","title":"Update a contract","href":"/api-reference/contracts/smart-contract-platform/update-contract"}]},{"group":"Deploy / Import","pages":[{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/contracts/import","title":"Import a contract","href":"/api-reference/contracts/smart-contract-platform/import-contract"},{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/contracts/deploy/estimateFee","title":"Estimate a contract deployment","href":"/api-reference/contracts/smart-contract-platform/estimate-contract-deploy"},{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/contracts/deploy","title":"Deploy a contract","href":"/api-reference/contracts/smart-contract-platform/deploy-contract"}]},{"group":"Event Monitors","pages":[{"openapi":"openapi/smart-contract-platform.yaml get /v1/w3s/contracts/monitors","title":"Get Event Monitors","href":"/api-reference/contracts/smart-contract-platform/get-event-monitors"},{"openapi":"openapi/smart-contract-platform.yaml post /v1/w3s/contracts/monitors","title":"Create Event Monitor","href":"/api-reference/contracts/smart-contract-platform/create-event-monitor"},{"openapi":"openapi/smart-contract-platform.yaml put /v1/w3s/contracts/monitors/{id}","title":"Update an Event Monitor","href":"/api-reference/contracts/smart-contract-platform/update-event-monitor"},{"openapi":"openapi/smart-contract-platform.yaml delete /v1/w3s/contracts/monitors/{id}","title":"Delete Event Monitor","href":"/api-reference/contracts/smart-contract-platform/delete-event-monitor"},{"openapi":"openapi/smart-contract-platform.yaml get /v1/w3s/contracts/events","title":"Get Event Logs","href":"/api-reference/contracts/smart-contract-platform/list-event-logs"}]}]}]},{"anchor":"CCTP","icon":"bridge","pages":[{"title":"CCTP API","sidebarTitle":"Overview","href":"/api-reference/cctp"},{"group":"CCTP","pages":[{"group":"CCTP V1 (Legacy)","pages":[{"openapi":"openapi/cctp.yaml get /v1/attestations/{messageHash}","title":"Get an attestation","href":"/api-reference/cctp/all/get-attestation"},{"openapi":"openapi/cctp.yaml get /v1/publicKeys","title":"List attestation public keys","href":"/api-reference/cctp/all/get-public-keys"},{"openapi":"openapi/cctp.yaml get /v1/messages/{sourceDomainId}/{transactionHash}","title":"Get a list of messages","href":"/api-reference/cctp/all/get-messages"}]},{"group":"CCTP","pages":[{"openapi":"openapi/cctp.yaml get /v2/publicKeys","title":"Get public keys","href":"/api-reference/cctp/all/get-public-keys-v2"},{"openapi":"openapi/cctp.yaml get /v2/messages/{sourceDomainId}","title":"Get messages and attestations","href":"/api-reference/cctp/all/get-messages-v2"},{"openapi":"openapi/cctp.yaml post /v2/reattest/{nonce}","title":"Re-attest a pre-finality message","href":"/api-reference/cctp/all/reattest-message"},{"openapi":"openapi/cctp.yaml get /v2/fastBurn/USDC/allowance","title":"Get USDC Fast Transfer allowance","href":"/api-reference/cctp/all/get-fast-burn-usdc-allowance"},{"openapi":"openapi/cctp.yaml get /v2/burn/USDC/fees/{sourceDomainId}/{destDomainId}","title":"Get USDC transfer fees","href":"/api-reference/cctp/all/get-burn-usdc-fees"}]},{"group":"Quotes","pages":[{"openapi":"openapi/cctp.yaml post /v2/quote/burn/usdc/{sourceDomainId}/{destDomainId}","title":"Create a USDC transfer quote","href":"/api-reference/cctp/all/create-usdc-burn-quote"}]}]}]},{"anchor":"Gateway","icon":"dungeon","pages":[{"title":"Gateway API","sidebarTitle":"Overview","href":"/api-reference/gateway"},{"group":"Gateway","pages":[{"group":"Gateway","pages":[{"openapi":"openapi/gateway.yaml post /v1/balances","title":"Get token balances for specified addresses","href":"/api-reference/gateway/all/get-token-balances"},{"openapi":"openapi/gateway.yaml post /v1/estimate","title":"Estimate fees and expiration block heights for a transfer","href":"/api-reference/gateway/all/estimate-transfer"},{"openapi":"openapi/gateway.yaml get /v1/info","title":"Get Gateway info for supported domains and tokens","href":"/api-reference/gateway/all/get-gateway-info"},{"openapi":"openapi/gateway.yaml post /v1/transfer","title":"Create a transfer attestation for transferring tokens","href":"/api-reference/gateway/all/create-transfer-attestation"},{"openapi":"openapi/gateway.yaml get /v1/transfer/{id}","title":"Get a transfer by ID","href":"/api-reference/gateway/all/get-transfer-by-id"},{"openapi":"openapi/gateway.yaml get /v1/transferSpec/{transferSpecHash}","title":"Get full TransferSpec by transferSpecHash","href":"/api-reference/gateway/all/get-transfer-spec"},{"openapi":"openapi/gateway.yaml post /v1/deposits","title":"Get pending deposits for specified addresses","href":"/api-reference/gateway/all/get-deposits"}]},{"group":"Gateway Batch","pages":[{"openapi":"openapi/gateway.yaml post /v1/batch/submit","title":"Submit an EIP-3009 authorization to be batched","href":"/api-reference/gateway/all/submit-batch-authorization"}]},{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/gateway.yaml get /v2/notifications/subscriptions/permissionless","title":"Get all webhook subscriptions","href":"/api-reference/gateway/all/get-permissionless-subscriptions"},{"openapi":"openapi/gateway.yaml post /v2/notifications/subscriptions/permissionless","title":"Create a webhook subscription","href":"/api-reference/gateway/all/create-permissionless-subscription"},{"openapi":"openapi/gateway.yaml get /v2/notifications/subscriptions/permissionless/{id}","title":"Retrieve a webhook subscription","href":"/api-reference/gateway/all/get-permissionless-subscription"},{"openapi":"openapi/gateway.yaml patch /v2/notifications/subscriptions/permissionless/{id}","title":"Update a webhook subscription","href":"/api-reference/gateway/all/update-permissionless-subscription"},{"openapi":"openapi/gateway.yaml delete /v2/notifications/subscriptions/permissionless/{id}","title":"Delete a webhook subscription","href":"/api-reference/gateway/all/delete-permissionless-subscription"},{"openapi":"openapi/gateway.yaml post /v2/notifications/subscriptions/permissionless/{id}/testConnection","title":"Test subscription connection","href":"/api-reference/gateway/all/test-permissionless-subscription-connection"},{"openapi":"openapi/gateway.yaml post /v2/notifications/subscriptions/permissionless/{id}/test","title":"Send a test notification","href":"/api-reference/gateway/all/send-permissionless-subscription-test-notification"},{"openapi":"openapi/gateway.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/gateway/all/get-permissionless-notification-signature"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/gateway.yaml webhook depositFinalized","title":"Deposit finalized","href":"/api-reference/gateway/all/deposit-finalized"},{"openapi":"openapi/gateway.yaml webhook mintFinalized","title":"Mint finalized","href":"/api-reference/gateway/all/mint-finalized"},{"openapi":"openapi/gateway.yaml webhook mintForwarded","title":"Mint forwarded","href":"/api-reference/gateway/all/mint-forwarded"}]}]}]},{"anchor":"x402 facilitators","icon":"handshake","pages":[{"title":"x402 facilitators API","sidebarTitle":"Overview","href":"/api-reference/x402-facilitators"},{"group":"Facilitator Service","pages":[{"group":"Payments","pages":[{"openapi":"openapi/facilitator-service.yaml post /v1/facilitator/x402/verify","title":"Verify an x402 payment","href":"/api-reference/facilitator-service/all/verify-payment"},{"openapi":"openapi/facilitator-service.yaml post /v1/facilitator/x402/settle","title":"Settle an x402 payment","href":"/api-reference/facilitator-service/all/settle-payment"},{"openapi":"openapi/facilitator-service.yaml get /v1/facilitator/x402/status/{paymentId}","title":"Get payment status","href":"/api-reference/facilitator-service/all/get-payment-status"}]},{"group":"Supported payment kinds","pages":[{"openapi":"openapi/facilitator-service.yaml get /v1/facilitator/x402/supported","title":"Get supported x402 payment kinds","href":"/api-reference/facilitator-service/all/get-supported"}]},{"title":"Facilitator Service API errors","sidebarTitle":"Errors","href":"/api-reference/facilitator-service/errors"}]},{"group":"Gateway Nanopayments","pages":[{"group":"Settlement","pages":[{"openapi":"openapi/gateway-nanopayments.yaml post /v1/x402/settle","title":"Settle an x402 payment","href":"/api-reference/gateway-nanopayments/settle-x402payment"},{"openapi":"openapi/gateway-nanopayments.yaml post /v1/x402/verify","title":"Verify an x402 payment payload","href":"/api-reference/gateway-nanopayments/verify-x402payment"}]},{"group":"Batched transfers","pages":[{"openapi":"openapi/gateway-nanopayments.yaml get /v1/x402/transfers","title":"Search x402 transfers","href":"/api-reference/gateway-nanopayments/search-x402transfers"},{"openapi":"openapi/gateway-nanopayments.yaml get /v1/x402/transfers/{id}","title":"Get an x402 transfer by ID","href":"/api-reference/gateway-nanopayments/get-x402transfer-by-id"}]},{"group":"Supported payment kinds","pages":[{"openapi":"openapi/gateway-nanopayments.yaml get /v1/x402/supported","title":"Get supported x402 payment kinds","href":"/api-reference/gateway-nanopayments/get-supported-x402payment-kinds"}]}]}]},{"anchor":"Digital Asset Accounts","icon":"money-bill-1-wave","pages":[{"title":"Digital Asset Accounts API","sidebarTitle":"Overview","href":"/api-reference/digital-asset-accounts"},{"group":"Accounts","pages":[{"group":"Accounts","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts","title":"List all accounts","href":"/api-reference/digital-asset-accounts/all/list-accounts"},{"openapi":"openapi/accounts.yaml post /v1/accounts","title":"Create an account","href":"/api-reference/digital-asset-accounts/all/create-account"},{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}","title":"Get an account","href":"/api-reference/digital-asset-accounts/all/get-account"},{"openapi":"openapi/accounts.yaml put /v1/accounts/{accountId}","title":"Update an account","href":"/api-reference/digital-asset-accounts/all/update-account"},{"openapi":"openapi/accounts.yaml post /v1/accounts/{accountId}/archive","title":"Archive an account","href":"/api-reference/digital-asset-accounts/all/archive-account"}]},{"group":"Account Groups","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/groups","title":"List custody account groups","href":"/api-reference/digital-asset-accounts/all/list-account-groups"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups","title":"Create a custody account group","href":"/api-reference/digital-asset-accounts/all/create-account-group"},{"openapi":"openapi/accounts.yaml get /v1/accounts/groups/{groupId}","title":"Get a custody account group","href":"/api-reference/digital-asset-accounts/all/get-account-group"},{"openapi":"openapi/accounts.yaml put /v1/accounts/groups/{groupId}","title":"Update a custody account group","href":"/api-reference/digital-asset-accounts/all/update-account-group"},{"openapi":"openapi/accounts.yaml delete /v1/accounts/groups/{groupId}","title":"Delete a custody account group","href":"/api-reference/digital-asset-accounts/all/delete-account-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/assign","title":"Bulk-assign accounts to a custody account group","href":"/api-reference/digital-asset-accounts/all/assign-accounts-to-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/unassign","title":"Bulk-unassign accounts from a custody account group","href":"/api-reference/digital-asset-accounts/all/unassign-accounts-from-group"}]},{"group":"Limits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}/limits/usage","title":"List account limits and usage","href":"/api-reference/digital-asset-accounts/all/list-account-limits-usage"}]},{"group":"Transactions","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/transactions","title":"List all account transactions","href":"/api-reference/digital-asset-accounts/all/list-account-transactions"}]}]},{"group":"First-party bank operations","pages":[{"group":"Wires","pages":[{"openapi":"openapi/accounts.yaml get /v1/banks/wires","title":"List all wire bank accounts","href":"/api-reference/digital-asset-accounts/all/list-wire-accounts"},{"openapi":"openapi/accounts.yaml post /v1/banks/wires","title":"Create a wire bank account","href":"/api-reference/digital-asset-accounts/all/create-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}","title":"Get a wire bank account","href":"/api-reference/digital-asset-accounts/all/get-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}/instructions","title":"Get wire instructions","href":"/api-reference/digital-asset-accounts/all/get-wire-account-instructions"}]},{"group":"ACH","pages":[{"openapi":"openapi/accounts.yaml get /v1/banks/ach","title":"List all ACH bank accounts","href":"/api-reference/digital-asset-accounts/all/list-achaccounts"},{"openapi":"openapi/accounts.yaml post /v1/banks/ach","title":"Create an ACH bank account","href":"/api-reference/digital-asset-accounts/all/create-achaccount"},{"openapi":"openapi/accounts.yaml get /v1/banks/ach/{id}","title":"Get an ACH bank account","href":"/api-reference/digital-asset-accounts/all/get-achaccount"},{"openapi":"openapi/accounts.yaml get /v1/banks/ach/{id}/instructions","title":"Get ACH instructions","href":"/api-reference/digital-asset-accounts/all/get-achaccount-instructions"}]},{"group":"Deposits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits","title":"List all account bank deposits","href":"/api-reference/digital-asset-accounts/all/list-account-deposits"},{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits/{id}","title":"Get an account bank deposit","href":"/api-reference/digital-asset-accounts/all/get-account-deposit"}]},{"group":"Withdrawals","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals","title":"List all account bank withdrawals","href":"/api-reference/digital-asset-accounts/all/list-account-withdrawals"},{"openapi":"openapi/accounts.yaml post /v1/accounts/withdrawals","title":"Create an account bank withdrawal","href":"/api-reference/digital-asset-accounts/all/create-account-withdrawal"},{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals/{id}","title":"Get an account bank withdrawal","href":"/api-reference/digital-asset-accounts/all/get-account-withdrawal"}]}]},{"group":"First-party crypto operations","pages":[{"group":"Deposit Addresses","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/addresses/deposit","title":"List all account deposit addresses","href":"/api-reference/digital-asset-accounts/all/list-account-deposit-addresses"},{"openapi":"openapi/accounts.yaml post /v1/accounts/addresses/deposit","title":"Create an account deposit address","href":"/api-reference/digital-asset-accounts/all/create-account-deposit-address"},{"openapi":"openapi/accounts.yaml get /v1/accounts/addresses/deposit/{id}","title":"Get an account deposit address","href":"/api-reference/digital-asset-accounts/all/get-account-deposit-address"}]},{"group":"Recipient Addresses","pages":[{"openapi":"openapi/accounts.yaml get /v1/addresses/recipient","title":"List all recipient addresses","href":"/api-reference/digital-asset-accounts/all/list-recipient-addresses"},{"openapi":"openapi/accounts.yaml post /v1/addresses/recipient","title":"Create a recipient address","href":"/api-reference/digital-asset-accounts/all/create-recipient-address"},{"openapi":"openapi/accounts.yaml get /v1/addresses/recipient/{id}","title":"Get a recipient address","href":"/api-reference/digital-asset-accounts/all/get-recipient-address"},{"openapi":"openapi/accounts.yaml delete /v1/addresses/recipient/{id}","title":"Delete a recipient address","href":"/api-reference/digital-asset-accounts/all/delete-recipient-address"},{"openapi":"openapi/accounts.yaml post /v1/addresses/recipient/{id}/verification/resend","title":"Resend a recipient address verification challenge","href":"/api-reference/digital-asset-accounts/all/resend-recipient-verification-challenge"}]},{"group":"Transfers","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/transfers","title":"List all account transfers","href":"/api-reference/digital-asset-accounts/all/list-account-transfers"},{"openapi":"openapi/accounts.yaml post /v1/accounts/transfers","title":"Create an account transfer","href":"/api-reference/digital-asset-accounts/all/create-account-transfer"},{"openapi":"openapi/accounts.yaml get /v1/accounts/transfers/{id}","title":"Get an account transfer","href":"/api-reference/digital-asset-accounts/all/get-account-transfer"}]}]},{"group":"Third-party crypto operations","pages":[{"group":"Crypto Payment Intents","pages":[{"openapi":"openapi/accounts.yaml get /v1/paymentIntents","title":"List all payment intents","href":"/api-reference/digital-asset-accounts/all/list-payment-intents"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents","title":"Create a payment intent","href":"/api-reference/digital-asset-accounts/all/create-payment-intent"},{"openapi":"openapi/accounts.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","href":"/api-reference/digital-asset-accounts/all/get-payment-intent"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents/{id}/expire","title":"Expire a payment intent","href":"/api-reference/digital-asset-accounts/all/expire-payment-intent"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents/{id}/refund","title":"Refund a payment intent","href":"/api-reference/digital-asset-accounts/all/refund-payment-intent"}]},{"group":"Crypto Payments","pages":[{"openapi":"openapi/accounts.yaml get /v1/payments","title":"List all crypto payments","href":"/api-reference/digital-asset-accounts/all/list-payments"},{"openapi":"openapi/accounts.yaml get /v1/payments/{id}","title":"Get a crypto payment","href":"/api-reference/digital-asset-accounts/all/get-payment"}]},{"group":"Crypto Address Book","pages":[{"openapi":"openapi/accounts.yaml get /v1/addressBook/recipients","title":"List all address book recipients","href":"/api-reference/digital-asset-accounts/all/list-address-book-recipients"},{"openapi":"openapi/accounts.yaml post /v1/addressBook/recipients","title":"Create an address book recipient","href":"/api-reference/digital-asset-accounts/all/create-address-book-recipient"},{"openapi":"openapi/accounts.yaml get /v1/addressBook/recipients/{id}","title":"Get an address book recipient","href":"/api-reference/digital-asset-accounts/all/get-address-book-recipient"},{"openapi":"openapi/accounts.yaml patch /v1/addressBook/recipients/{id}","title":"Modify an address book recipient","href":"/api-reference/digital-asset-accounts/all/modify-address-book-recipient"},{"openapi":"openapi/accounts.yaml delete /v1/addressBook/recipients/{id}","title":"Delete an address book recipient","href":"/api-reference/digital-asset-accounts/all/delete-address-book-recipient"}]},{"group":"Crypto Payouts","pages":[{"openapi":"openapi/accounts.yaml get /v1/payouts","title":"List all crypto payouts","href":"/api-reference/digital-asset-accounts/all/list-payouts"},{"openapi":"openapi/accounts.yaml post /v1/payouts","title":"Create a crypto payout","href":"/api-reference/digital-asset-accounts/all/create-payout"},{"openapi":"openapi/accounts.yaml get /v1/payouts/{id}","title":"Get a crypto payout","href":"/api-reference/digital-asset-accounts/all/get-payout"}]}]},{"group":"Cross-currency API","pages":[{"group":"FX Trades","pages":[{"openapi":"openapi/accounts.yaml post /v1/exchange/quotes","title":"Create an FX quote","href":"/api-reference/digital-asset-accounts/all/create-fx-quote"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades","title":"List all FX trades","href":"/api-reference/digital-asset-accounts/all/list-fx-trades"},{"openapi":"openapi/accounts.yaml post /v1/exchange/trades","title":"Create an FX trade","href":"/api-reference/digital-asset-accounts/all/create-fx-trade"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/{id}","title":"Get an FX trade","href":"/api-reference/digital-asset-accounts/all/get-fx-trade"}]},{"group":"FX Settlements","pages":[{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/settlements","title":"List all FX settlements","href":"/api-reference/digital-asset-accounts/all/list-fx-settlements"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/settlements/{id}","title":"Get an FX settlement","href":"/api-reference/digital-asset-accounts/all/get-fx-settlement"}]}]},{"group":"Notifications","pages":[{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/accounts.yaml get /v2/notifications/subscriptions","title":"Get all webhook subscriptions","href":"/api-reference/digital-asset-accounts/all/get-subscriptions"},{"openapi":"openapi/accounts.yaml post /v2/notifications/subscriptions","title":"Create a webhook subscription","href":"/api-reference/digital-asset-accounts/all/create-subscription"},{"openapi":"openapi/accounts.yaml get /v2/notifications/subscriptions/{id}","title":"Get a webhook subscription","href":"/api-reference/digital-asset-accounts/all/get-subscription"},{"openapi":"openapi/accounts.yaml patch /v2/notifications/subscriptions/{id}","title":"Update a webhook subscription","href":"/api-reference/digital-asset-accounts/all/update-subscription"},{"openapi":"openapi/accounts.yaml delete /v2/notifications/subscriptions/{id}","title":"Delete a webhook subscription","href":"/api-reference/digital-asset-accounts/all/delete-subscription"},{"openapi":"openapi/accounts.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/digital-asset-accounts/all/get-notification-signature"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/accounts.yaml webhook custodyTransfer","title":"Transfer state change","href":"/api-reference/digital-asset-accounts/all/custody-transfer"},{"openapi":"openapi/accounts.yaml webhook mintDeposits","title":"Deposit state change","href":"/api-reference/digital-asset-accounts/all/mint-deposits"},{"openapi":"openapi/accounts.yaml webhook mintPayout","title":"Payout state change","href":"/api-reference/digital-asset-accounts/all/mint-payout"},{"openapi":"openapi/accounts.yaml webhook mintWire","title":"Wire state change","href":"/api-reference/digital-asset-accounts/all/mint-wire"},{"openapi":"openapi/accounts.yaml webhook mintAddressBookRecipients","title":"Recipient address state change","href":"/api-reference/digital-asset-accounts/all/mint-address-book-recipients"},{"openapi":"openapi/accounts.yaml webhook bankAccountsCreated","title":"Bank account created","href":"/api-reference/digital-asset-accounts/all/bank-accounts-created"},{"openapi":"openapi/accounts.yaml webhook bankAccountsUpdated","title":"Bank account updated","href":"/api-reference/digital-asset-accounts/all/bank-accounts-updated"},{"openapi":"openapi/accounts.yaml webhook bankAccountsDenied","title":"Bank account denied","href":"/api-reference/digital-asset-accounts/all/bank-accounts-denied"}]}]},{"group":"Security","pages":[{"group":"Passkeys","pages":[{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys/registrations","title":"Open a passkey registration session","href":"/api-reference/digital-asset-accounts/all/open-passkey-registration"},{"openapi":"openapi/accounts.yaml get /v1/accounts/passkeys","title":"List passkeys","href":"/api-reference/digital-asset-accounts/all/list-passkeys"},{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys","title":"Complete passkey registration","href":"/api-reference/digital-asset-accounts/all/complete-passkey-registration"},{"openapi":"openapi/accounts.yaml delete /v1/accounts/passkeys/{passkeyId}","title":"Revoke a passkey","href":"/api-reference/digital-asset-accounts/all/revoke-passkey"},{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys/challenges","title":"Create an SCA challenge","href":"/api-reference/digital-asset-accounts/all/create-sca-challenge"}]}]}]},{"anchor":"End User Onboarding","icon":"user-plus","pages":[{"title":"End User Onboarding API","sidebarTitle":"Overview","href":"/api-reference/end-user-onboarding"},{"title":"End User Onboarding API error codes","sidebarTitle":"Error codes","href":"/api-reference/end-user-onboarding/error-codes"},{"group":"End User Onboarding","pages":[{"group":"Partner clients","pages":[{"openapi":"openapi/customer-orchestration.yaml post /v1/partner/clients","title":"Create a partner client","href":"/api-reference/end-user-onboarding/create-partner-client"},{"openapi":"openapi/customer-orchestration.yaml get /v1/partner/clients/{clientEntityId}","title":"Get a partner client","href":"/api-reference/end-user-onboarding/get-partner-client"},{"openapi":"openapi/customer-orchestration.yaml get /v1/partner/clients","title":"List partner clients","href":"/api-reference/end-user-onboarding/list-partner-clients"}]},{"group":"Partner applications","pages":[{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications","title":"List applications for the authenticated partner","href":"/api-reference/end-user-onboarding/list-applications"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}","title":"Retrieve an application by ID","href":"/api-reference/end-user-onboarding/get-application"},{"openapi":"openapi/partner-openapi.yaml delete /v1/onboarding/partner/applications/{applicationId}","title":"Cancel an application","href":"/api-reference/end-user-onboarding/cancel-application"},{"openapi":"openapi/partner-openapi.yaml patch /v1/onboarding/partner/applications/{applicationId}/data","title":"Save data for multiple sections in a single request","href":"/api-reference/end-user-onboarding/bulk-save"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/data","title":"Retrieve data for all visible sections","href":"/api-reference/end-user-onboarding/get-all-data"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/schema","title":"Get the JSON Schema (draft 2020-12) for an application's template","href":"/api-reference/end-user-onboarding/get-application-schema"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/certifications","title":"List active certifications for an application","href":"/api-reference/end-user-onboarding/get-certifications"},{"openapi":"openapi/partner-openapi.yaml post /v1/onboarding/partner/applications/{applicationId}/submit","title":"Submit an application","href":"/api-reference/end-user-onboarding/submit-application"}]},{"group":"Partner documents","pages":[{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/documents","title":"List documents for an application","href":"/api-reference/end-user-onboarding/list-documents"},{"openapi":"openapi/partner-openapi.yaml post /v1/onboarding/partner/applications/{applicationId}/documents","title":"Upload a document for an application","href":"/api-reference/end-user-onboarding/upload-document"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/documents/{documentId}","title":"Download a document","href":"/api-reference/end-user-onboarding/download-document"},{"openapi":"openapi/partner-openapi.yaml delete /v1/onboarding/partner/applications/{applicationId}/documents/{documentId}","title":"Delete a document","href":"/api-reference/end-user-onboarding/delete-document"}]},{"group":"Partner RFIs","pages":[{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/rfis","title":"List RFI bundles for an application","href":"/api-reference/end-user-onboarding/list-rfis"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/rfis/{rfiId}","title":"Get RFI detail with comment history","href":"/api-reference/end-user-onboarding/get-rfi"},{"openapi":"openapi/partner-openapi.yaml patch /v1/onboarding/partner/applications/{applicationId}/rfis/{rfiId}","title":"Submit field data in response to an UPDATE_FIELD or NEW_FIELD RFI","href":"/api-reference/end-user-onboarding/update-rfidata"},{"openapi":"openapi/partner-openapi.yaml post /v1/onboarding/partner/applications/{applicationId}/rfis/{rfiId}/comments","title":"Add a comment to an RFI","href":"/api-reference/end-user-onboarding/create-comment"},{"openapi":"openapi/partner-openapi.yaml put /v1/onboarding/partner/applications/{applicationId}/rfis/{rfiId}/comments/{commentId}","title":"Update a comment on an RFI","href":"/api-reference/end-user-onboarding/update-comment"},{"openapi":"openapi/partner-openapi.yaml delete /v1/onboarding/partner/applications/{applicationId}/rfis/{rfiId}/comments/{commentId}","title":"Delete a comment on an RFI","href":"/api-reference/end-user-onboarding/delete-comment"}]},{"group":"Partner sections","pages":[{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/sections","title":"List sections for an application","href":"/api-reference/end-user-onboarding/list-sections"},{"openapi":"openapi/partner-openapi.yaml get /v1/onboarding/partner/applications/{applicationId}/sections/{sectionName}","title":"Retrieve section data for an application","href":"/api-reference/end-user-onboarding/get-section"},{"openapi":"openapi/partner-openapi.yaml put /v1/onboarding/partner/applications/{applicationId}/sections/{sectionName}","title":"Save section data for an application","href":"/api-reference/end-user-onboarding/save-section"},{"openapi":"openapi/partner-openapi.yaml delete /v1/onboarding/partner/applications/{applicationId}/sections/{sectionName}/{refId}","title":"Remove an entity from an array section","href":"/api-reference/end-user-onboarding/remove-entity"}]}]}]},{"anchor":"Mint and Custody","icon":"building-columns","pages":[{"title":"Circle Mint and Custody API","sidebarTitle":"Overview","href":"/api-reference/circle-mint"},{"title":"Postman collection","href":"/api-reference/circle-mint/postman"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/api-reference/circle-mint/error-codes"},{"group":"API overview","pages":[{"group":"Health","pages":[{"openapi":"openapi/general.yaml get /ping","title":"Ping","href":"/api-reference/circle-mint/general/ping"}]},{"group":"Management","pages":[{"openapi":"openapi/general.yaml get /v1/configuration","title":"Get configuration info","href":"/api-reference/circle-mint/general/get-account-config"}]},{"group":"Subscriptions","pages":[{"openapi":"openapi/general.yaml get /v1/notifications/subscriptions","title":"List all notification subscriptions","href":"/api-reference/circle-mint/general/list-subscriptions"},{"openapi":"openapi/general.yaml post /v1/notifications/subscriptions","title":"Create a notification subscription","href":"/api-reference/circle-mint/general/create-subscription"},{"openapi":"openapi/general.yaml delete /v1/notifications/subscriptions/{id}","title":"Remove a notification subscription","href":"/api-reference/circle-mint/general/delete-subscription"}]},{"group":"Stablecoins","pages":[{"openapi":"openapi/general.yaml get /v1/stablecoins","title":"List all stablecoins","href":"/api-reference/circle-mint/general/list-stablecoins"},{"openapi":"openapi/general.yaml get /v1/stablecoins/address-statuses","title":"List stablecoin address statuses","href":"/api-reference/circle-mint/general/list-stablecoin-address-statuses"}]}]},{"group":"Custody API","pages":[{"group":"Accounts","pages":[{"group":"Accounts","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts","title":"List all accounts","href":"/api-reference/circle-mint/accounts/list-accounts"},{"openapi":"openapi/accounts.yaml post /v1/accounts","title":"Create an account","href":"/api-reference/circle-mint/accounts/create-account"},{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}","title":"Get an account","href":"/api-reference/circle-mint/accounts/get-account"},{"openapi":"openapi/accounts.yaml put /v1/accounts/{accountId}","title":"Update an account","href":"/api-reference/circle-mint/accounts/update-account"},{"openapi":"openapi/accounts.yaml post /v1/accounts/{accountId}/archive","title":"Archive an account","href":"/api-reference/circle-mint/accounts/archive-account"}]},{"group":"Account Groups","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/groups","title":"List custody account groups","href":"/api-reference/circle-mint/accounts/list-account-groups"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups","title":"Create a custody account group","href":"/api-reference/circle-mint/accounts/create-account-group"},{"openapi":"openapi/accounts.yaml get /v1/accounts/groups/{groupId}","title":"Get a custody account group","href":"/api-reference/circle-mint/accounts/get-account-group"},{"openapi":"openapi/accounts.yaml put /v1/accounts/groups/{groupId}","title":"Update a custody account group","href":"/api-reference/circle-mint/accounts/update-account-group"},{"openapi":"openapi/accounts.yaml delete /v1/accounts/groups/{groupId}","title":"Delete a custody account group","href":"/api-reference/circle-mint/accounts/delete-account-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/assign","title":"Bulk-assign accounts to a custody account group","href":"/api-reference/circle-mint/accounts/assign-accounts-to-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/unassign","title":"Bulk-unassign accounts from a custody account group","href":"/api-reference/circle-mint/accounts/unassign-accounts-from-group"}]},{"group":"Limits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}/limits/usage","title":"List account limits and usage","href":"/api-reference/circle-mint/accounts/list-account-limits-usage"}]},{"group":"Transactions","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/transactions","title":"List all account transactions","href":"/api-reference/circle-mint/accounts/list-account-transactions"}]}]},{"group":"Balances","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/balances","title":"List all balances","href":"/api-reference/circle-mint/account/list-business-balances"}]},{"group":"Transfers","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/transfers","title":"List all transfers","href":"/api-reference/circle-mint/account/list-business-transfers"},{"openapi":"openapi/account.yaml post /v1/businessAccount/transfers","title":"Create a transfer","href":"/api-reference/circle-mint/account/create-business-transfer"},{"openapi":"openapi/account.yaml get /v1/businessAccount/transfers/{id}","title":"Get a transfer","href":"/api-reference/circle-mint/account/get-business-transfer"},{"openapi":"openapi/account.yaml get /v1/businessAccount/associatedAccounts","title":"Get associated accounts","href":"/api-reference/circle-mint/account/get-associated-accounts"}]},{"group":"Deposits","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/deposits","title":"List fiat deposits","href":"/api-reference/circle-mint/account/list-business-deposits"},{"openapi":"openapi/account.yaml get /v1/businessAccount/deposits/{id}","title":"Get a deposit by ID","href":"/api-reference/circle-mint/account/get-business-deposit-by-id"}]},{"group":"Reporting","pages":[{"openapi":"openapi/account.yaml get /v1/reports","title":"List reports","href":"/api-reference/circle-mint/account/list-reports"},{"openapi":"openapi/account.yaml post /v1/reports","title":"Request a report","href":"/api-reference/circle-mint/account/request-report"},{"openapi":"openapi/account.yaml get /v1/reports/{id}","title":"Get report by ID","href":"/api-reference/circle-mint/account/get-report-by-id"},{"openapi":"openapi/account.yaml get /v1/reports/{id}/content","title":"Download report content","href":"/api-reference/circle-mint/account/get-report-content"}]},{"group":"Addresses","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/wallets/addresses/deposit","title":"List all deposit addresses","href":"/api-reference/circle-mint/account/get-business-deposit-address"},{"openapi":"openapi/account.yaml post /v1/businessAccount/wallets/addresses/deposit","title":"Create a deposit address","href":"/api-reference/circle-mint/account/create-business-deposit-address"},{"openapi":"openapi/account.yaml get /v1/businessAccount/wallets/addresses/recipient","title":"List all recipient addresses","href":"/api-reference/circle-mint/account/list-business-recipient-addresses"},{"openapi":"openapi/account.yaml post /v1/businessAccount/wallets/addresses/recipient","title":"Create a recipient address","href":"/api-reference/circle-mint/account/create-business-recipient-address"},{"openapi":"openapi/account.yaml delete /v1/businessAccount/wallets/addresses/recipient/{id}","title":"Delete a recipient address","href":"/api-reference/circle-mint/account/delete-business-recipient-address"},{"openapi":"openapi/account.yaml get /v1/businessAccount/wallets/addresses/vasps","title":"List recipient VASPs","href":"/api-reference/circle-mint/account/list-business-recipient-vasps"}]}]},{"group":"Mint API","pages":[{"group":"Payouts","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/payouts","title":"List all payouts","href":"/api-reference/circle-mint/account/list-business-payouts"},{"openapi":"openapi/account.yaml post /v1/businessAccount/payouts","title":"Create a payout","href":"/api-reference/circle-mint/account/create-business-payout"},{"openapi":"openapi/account.yaml get /v1/businessAccount/payouts/{id}","title":"Get a payout","href":"/api-reference/circle-mint/account/get-business-payout"},{"openapi":"openapi/account.yaml get /v1/fees/redemption/dailyReports","title":"List redemption fee calculations","href":"/api-reference/circle-mint/account/list-net-burn-fee-daily-calculations"}]},{"group":"Wires","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/wires","title":"List all wire bank accounts","href":"/api-reference/circle-mint/account/list-business-wire-accounts"},{"openapi":"openapi/account.yaml post /v1/businessAccount/banks/wires","title":"Create a wire bank account","href":"/api-reference/circle-mint/account/create-business-wire-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/wires/{id}","title":"Get a wire bank account","href":"/api-reference/circle-mint/account/get-business-wire-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/wires/{id}/instructions","title":"Get wire instructions","href":"/api-reference/circle-mint/account/get-business-wire-account-instructions"}]},{"group":"Payments","pages":[{"openapi":"openapi/account.yaml post /v1/mocks/payments/wire","title":"Create a mock Wire payment","href":"/api-reference/circle-mint/account/create-mock-wire-payment"}]},{"group":"CUBIX","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/cubix","title":"List all CUBIX bank accounts.","href":"/api-reference/circle-mint/account/list-business-cubix-accounts"},{"openapi":"openapi/account.yaml post /v1/businessAccount/banks/cubix","title":"Create a CUBIX bank account","href":"/api-reference/circle-mint/account/create-business-cubix-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/cubix/{id}","title":"Get a CUBIX bank account","href":"/api-reference/circle-mint/account/get-business-cubix-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/cubix/{id}/instructions","title":"Get CUBIX instructions","href":"/api-reference/circle-mint/account/get-business-cubix-account-instructions"}]},{"group":"PIX","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/pix","title":"List all PIX bank accounts.","href":"/api-reference/circle-mint/account/list-business-pix-accounts"},{"openapi":"openapi/account.yaml post /v1/businessAccount/banks/pix","title":"Create a PIX bank account","href":"/api-reference/circle-mint/account/create-business-pix-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/pix/{id}","title":"Get a PIX bank account","href":"/api-reference/circle-mint/account/get-business-pix-account"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/pix/{id}/instructions","title":"Get PIX instructions","href":"/api-reference/circle-mint/account/get-business-pix-account-instructions"}]},{"group":"Settlement Bank Routing","pages":[{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/wires/{fiatAccountId}/routingInfo","title":"Get wire routing info","href":"/api-reference/circle-mint/account/get-wire-routing-info"},{"openapi":"openapi/account.yaml put /v1/businessAccount/banks/wires/{fiatAccountId}/routingPreferences","title":"Update wire routing preferences","href":"/api-reference/circle-mint/account/update-wire-routing-preferences"},{"openapi":"openapi/account.yaml get /v1/businessAccount/banks/pix/{fiatAccountId}/routingInfo","title":"Get PIX routing info","href":"/api-reference/circle-mint/account/get-pix-routing-info"},{"openapi":"openapi/account.yaml put /v1/businessAccount/banks/pix/{fiatAccountId}/routingPreferences","title":"Update PIX routing preferences","href":"/api-reference/circle-mint/account/update-pix-routing-preferences"}]}]},{"group":"Cross-currency API","pages":[{"group":"Trades","pages":[{"openapi":"openapi/cross-currency.yaml post /v1/exchange/quotes","title":"Get quote","href":"/api-reference/circle-mint/cross-currency/get-quote"},{"openapi":"openapi/cross-currency.yaml get /v1/exchange/trades","title":"Get all FX trades","href":"/api-reference/circle-mint/cross-currency/get-fx-trades"},{"openapi":"openapi/cross-currency.yaml post /v1/exchange/trades","title":"Create FX trade","href":"/api-reference/circle-mint/cross-currency/create-fx-trade"},{"openapi":"openapi/cross-currency.yaml get /v1/exchange/trades/{id}","title":"Get FX trade","href":"/api-reference/circle-mint/cross-currency/get-fx-trade-id"},{"openapi":"openapi/cross-currency.yaml put /v1/exchange/fxConfigs/accounts","title":"Create FX account","href":"/api-reference/circle-mint/cross-currency/create-fx-account"},{"openapi":"openapi/cross-currency.yaml get /v1/exchange/fxConfigs/dailyLimits","title":"Get daily currency exchange limits","href":"/api-reference/circle-mint/cross-currency/get-daily-fx-limits"}]},{"group":"Settlements","pages":[{"openapi":"openapi/cross-currency.yaml get /v1/exchange/trades/settlements","title":"Get all settlements","href":"/api-reference/circle-mint/cross-currency/get-settlements"},{"openapi":"openapi/cross-currency.yaml get /v1/exchange/trades/settlements/{id}","title":"Get settlement","href":"/api-reference/circle-mint/cross-currency/get-settlement-id"},{"openapi":"openapi/cross-currency.yaml get /v1/exchange/trades/settlements/instructions/{currency}","title":"Get settlement instructions","href":"/api-reference/circle-mint/cross-currency/get-settlement-instructions"}]},{"group":"Payments","pages":[{"openapi":"openapi/cross-currency.yaml post /v1/mocks/payments/pix","title":"Create a mock PIX payment","href":"/api-reference/circle-mint/cross-currency/create-mock-pix-payment"}]}]},{"group":"Reserve management API","pages":[{"group":"Reserve Management","pages":[{"openapi":"openapi/reserve-management.yaml post /v2/reserveManagement/dailyCustodyBalances","title":"Create daily custody balance report","href":"/api-reference/circle-mint/reserve-management/report-daily-custody-balances"}]}]},{"group":"Credit API","pages":[{"group":"Credit","pages":[{"openapi":"openapi/credit.yaml get /v1/credit","title":"Get credit line details","href":"/api-reference/circle-mint/credit/get-credit-line"}]},{"group":"Credit Repayments","pages":[{"openapi":"openapi/credit.yaml get /v1/credit/repaymentAccounts/{fiatAccountId}","title":"Get repayment account details","href":"/api-reference/circle-mint/credit/get-repayment-account-detail"},{"openapi":"openapi/credit.yaml get /v1/credit/repayments","title":"List all credit repayments","href":"/api-reference/circle-mint/credit/list-credit-repayments"},{"openapi":"openapi/credit.yaml get /v1/credit/repayments/{id}","title":"Get a credit repayment","href":"/api-reference/circle-mint/credit/get-credit-repayment"},{"openapi":"openapi/credit.yaml post /v1/credit/cryptoRepayment","title":"Initiate a crypto repayment","href":"/api-reference/circle-mint/credit/create-credit-crypto-repayment"},{"openapi":"openapi/credit.yaml post /v1/credit/mocks/repayments","title":"Create a mock wire repayment","href":"/api-reference/circle-mint/credit/create-mock-wire-repayment"}]},{"group":"Credit Transfers","pages":[{"openapi":"openapi/credit.yaml get /v1/credit/transfers","title":"List all credit transfers","href":"/api-reference/circle-mint/credit/list-credit-transfers"},{"openapi":"openapi/credit.yaml post /v1/credit/transfers","title":"Create a credit transfer","href":"/api-reference/circle-mint/credit/create-credit-transfer"},{"openapi":"openapi/credit.yaml get /v1/credit/transfers/{id}","title":"Get a credit transfer","href":"/api-reference/circle-mint/credit/get-credit-transfer"},{"openapi":"openapi/credit.yaml post /v1/credit/transfers/reserveFunds","title":"Reserve funds for a credit transfer","href":"/api-reference/circle-mint/credit/reserve-credit-transfer-funds"},{"openapi":"openapi/credit.yaml put /v1/credit/transfers/{id}/requestReservedFunds","title":"Request reserved funds","href":"/api-reference/circle-mint/credit/request-credit-transfer-reserved-funds"},{"openapi":"openapi/credit.yaml put /v1/credit/transfers/{id}/cancelReserve","title":"Cancel reserved funds","href":"/api-reference/circle-mint/credit/cancel-credit-transfer-reserve"}]},{"group":"Credit Fees","pages":[{"openapi":"openapi/credit.yaml get /v1/credit/fees","title":"List all credit fees","href":"/api-reference/circle-mint/credit/list-credit-fees"},{"openapi":"openapi/credit.yaml get /v1/credit/fees/{id}","title":"Get a credit fee","href":"/api-reference/circle-mint/credit/get-credit-fee"}]}]},{"group":"Digital Asset-Backed Borrowing","pages":[{"group":"Borrow Wallets","pages":[{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/wallets","title":"Get the wallet","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-wallets"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/wallets","title":"Create a wallet","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-wallet"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/wallets/owners","title":"Add a wallet owner","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/add-borrow-wallet-owner"}]},{"group":"Borrow Loans","pages":[{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/loans","title":"List all loans","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-loans"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/loans","title":"Create a loan (borrow)","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-loan"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/loans/{id}","title":"Get a loan","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/get-borrow-loan"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/loans/{id}/repayments","title":"Create a repayment","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-repayment"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/loans/{id}/collateral","title":"Add collateral","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/add-borrow-loan-collateral"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml post /v1/borrow/loans/{id}/residual-sweep","title":"Trigger a residual collateral sweep","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/create-borrow-loan-residual-sweep"}]},{"group":"Borrow Jobs","pages":[{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/jobs","title":"List all jobs","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-jobs"},{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/jobs/{id}","title":"Get a job","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/get-borrow-job"}]},{"group":"Borrow Markets","pages":[{"openapi":"openapi/digital-asset-backed-borrowing.yaml get /v1/borrow/markets","title":"List all markets","href":"/api-reference/circle-mint/digital-asset-backed-borrowing/list-borrow-markets"}]}]},{"group":"Webhook events","pages":[{"openapi":"openapi/mint-webhooks.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/circle-mint/webhooks/get-notification-signature"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyTransfer","title":"Transfer state change","href":"/api-reference/circle-mint/webhooks/custody-transfer"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyWrappedTokenReceive","title":"Wrapped token deposit received","href":"/api-reference/circle-mint/webhooks/custody-wrapped-token-receive"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyWrappedTokenMintInitiated","title":"Wrapped token mint started","href":"/api-reference/circle-mint/webhooks/custody-wrapped-token-mint-initiated"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyWrappedTokenWithdrawal","title":"Wrapped token withdrawal","href":"/api-reference/circle-mint/webhooks/custody-wrapped-token-withdrawal"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyWrappedTokenRedeemInitiated","title":"Wrapped token redeem started","href":"/api-reference/circle-mint/webhooks/custody-wrapped-token-redeem-initiated"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyApprovalWorkflowTransferApproved","title":"Transfer approved via approval workflow","href":"/api-reference/circle-mint/webhooks/custody-approval-workflow-transfer-approved"},{"openapi":"openapi/mint-webhooks.yaml webhook custodyApprovalWorkflowTransferRejected","title":"Transfer rejected via approval workflow","href":"/api-reference/circle-mint/webhooks/custody-approval-workflow-transfer-rejected"},{"openapi":"openapi/mint-webhooks.yaml webhook fxTrade","title":"FX trade state change","href":"/api-reference/circle-mint/webhooks/fx-trade"},{"openapi":"openapi/mint-webhooks.yaml webhook fxSettlement","title":"FX settlement state change","href":"/api-reference/circle-mint/webhooks/fx-settlement"},{"openapi":"openapi/mint-webhooks.yaml webhook onboardingApplicationApproved","title":"Application approved","href":"/api-reference/circle-mint/webhooks/onboarding-application-approved"},{"openapi":"openapi/mint-webhooks.yaml webhook onboardingApplicationDenied","title":"Application denied","href":"/api-reference/circle-mint/webhooks/onboarding-application-denied"},{"openapi":"openapi/mint-webhooks.yaml webhook onboardingApplicationCancelled","title":"Application cancelled","href":"/api-reference/circle-mint/webhooks/onboarding-application-cancelled"},{"openapi":"openapi/mint-webhooks.yaml webhook onboardingApplicationRfiRequested","title":"Information requested","href":"/api-reference/circle-mint/webhooks/onboarding-application-rfi-requested"},{"openapi":"openapi/mint-webhooks.yaml webhook onboardingPeriodicReviewRequested","title":"Periodic review requested","href":"/api-reference/circle-mint/webhooks/onboarding-periodic-review-requested"},{"openapi":"openapi/mint-webhooks.yaml webhook mintPayments","title":"Payment state change","href":"/api-reference/circle-mint/webhooks/mint-payments"},{"openapi":"openapi/mint-webhooks.yaml webhook mintPayout","title":"Payout state change","href":"/api-reference/circle-mint/webhooks/mint-payout"},{"openapi":"openapi/mint-webhooks.yaml webhook mintDeposits","title":"Deposit state change","href":"/api-reference/circle-mint/webhooks/mint-deposits"},{"openapi":"openapi/mint-webhooks.yaml webhook mintPaymentIntents","title":"Payment intent state change","href":"/api-reference/circle-mint/webhooks/mint-payment-intents"},{"openapi":"openapi/mint-webhooks.yaml webhook mintWire","title":"Wire state change","href":"/api-reference/circle-mint/webhooks/mint-wire"},{"openapi":"openapi/mint-webhooks.yaml webhook mintReturns","title":"Return state change","href":"/api-reference/circle-mint/webhooks/mint-returns"},{"openapi":"openapi/mint-webhooks.yaml webhook mintAddressBookRecipients","title":"Recipient address state change","href":"/api-reference/circle-mint/webhooks/mint-address-book-recipients"},{"openapi":"openapi/mint-webhooks.yaml webhook mintAccounts","title":"Subaccount status change","href":"/api-reference/circle-mint/webhooks/mint-accounts"},{"openapi":"openapi/mint-webhooks.yaml webhook mintExternalEntities","title":"External entity compliance decision","href":"/api-reference/circle-mint/webhooks/mint-external-entities"},{"openapi":"openapi/mint-webhooks.yaml webhook bankAccountsCreated","title":"Bank account created","href":"/api-reference/circle-mint/webhooks/bank-accounts-created"},{"openapi":"openapi/mint-webhooks.yaml webhook bankAccountsUpdated","title":"Bank account updated","href":"/api-reference/circle-mint/webhooks/bank-accounts-updated"},{"openapi":"openapi/mint-webhooks.yaml webhook bankAccountsDenied","title":"Bank account denied","href":"/api-reference/circle-mint/webhooks/bank-accounts-denied"},{"openapi":"openapi/mint-webhooks.yaml webhook mintCreditTransfers","title":"Credit transfer state change","href":"/api-reference/circle-mint/webhooks/mint-credit-transfers"},{"openapi":"openapi/mint-webhooks.yaml webhook mintCreditFees","title":"Credit fee state change","href":"/api-reference/circle-mint/webhooks/mint-credit-fees"},{"openapi":"openapi/mint-webhooks.yaml webhook mintCreditRepayments","title":"Credit repayment state change","href":"/api-reference/circle-mint/webhooks/mint-credit-repayments"}]}]},{"anchor":"Circle Payments Network","icon":"chart-network","pages":[{"title":"Circle Payments Network API","sidebarTitle":"Overview","href":"/api-reference/cpn"},{"title":"Postman collection","href":"/api-reference/cpn/postman"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/api-reference/cpn/error-codes"},{"group":"API overview","pages":[{"group":"Health","pages":[{"openapi":"openapi/configurations.yaml get /ping","title":"Ping","href":"/api-reference/cpn/common/ping"}]},{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/configurations.yaml get /v2/cpn/notifications/subscriptions","title":"Get all webhook subscriptions","href":"/api-reference/cpn/common/get-subscriptions"},{"openapi":"openapi/configurations.yaml post /v2/cpn/notifications/subscriptions","title":"Create a webhook subscription","href":"/api-reference/cpn/common/create-subscription"},{"openapi":"openapi/configurations.yaml get /v2/cpn/notifications/subscriptions/{id}","title":"Get a notification subscription","href":"/api-reference/cpn/common/get-subscription"},{"openapi":"openapi/configurations.yaml patch /v2/cpn/notifications/subscriptions/{id}","title":"Update a notification subscription","href":"/api-reference/cpn/common/update-subscription"},{"openapi":"openapi/configurations.yaml delete /v2/cpn/notifications/subscriptions/{id}","title":"Delete a notification subscription","href":"/api-reference/cpn/common/delete-subscription"},{"openapi":"openapi/configurations.yaml get /v2/cpn/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/cpn/common/get-notification-signature"}]}]},{"group":"Fiat payouts","pages":[{"group":"Configurations","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/overview","title":"Get payment configurations","href":"/api-reference/cpn/cpn-platform/get-payment-configurations-overview"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/routes","title":"Get supported payment routes","href":"/api-reference/cpn/cpn-platform/list-routes"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/enabledRoutes","title":"Retrieve all ofi-enabled payment routes","href":"/api-reference/cpn/cpn-platform/list-ofi-enabled-routes"}]},{"group":"Quotes","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/quotes","title":"Create a quote","href":"/api-reference/cpn/cpn-platform/create-quotes"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/quotes/{quoteId}","title":"Get details of a quote","href":"/api-reference/cpn/cpn-platform/get-quote"}]},{"group":"Payments","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments","title":"List payments","href":"/api-reference/cpn/cpn-platform/list-payments"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments","title":"Create a payment","href":"/api-reference/cpn/cpn-platform/create-payment"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/requirements","title":"Get payment requirements for a quote","href":"/api-reference/cpn/cpn-platform/get-payment-requirements"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}","title":"Get a payment","href":"/api-reference/cpn/cpn-platform/get-payment"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/refunds/{refundId}","title":"Get refund details","href":"/api-reference/cpn/cpn-platform/get-refund"}]},{"group":"Transactions","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions","title":"Create a transaction","href":"/api-reference/cpn/cpn-platform/create-transaction"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/transactions/{transactionId}","title":"Get a transaction","href":"/api-reference/cpn/cpn-platform/get-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions/{transactionId}/submit","title":"Submit a signed transaction for broadcast","href":"/api-reference/cpn/cpn-platform/submit-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions/accelerate","title":"Accelerate a stuck transaction","href":"/api-reference/cpn/cpn-platform/accelerate-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v2/cpn/payments/{paymentId}/transactions","title":"Create a transaction (V2)","href":"/api-reference/cpn/cpn-platform/create-transaction-v2"},{"openapi":"openapi/cpn-ofi.yaml get /v2/cpn/payments/{paymentId}/transactions/{transactionId}","title":"Get a transaction by ID (V2)","href":"/api-reference/cpn/cpn-platform/get-transaction-v2"},{"openapi":"openapi/cpn-ofi.yaml post /v2/cpn/payments/{paymentId}/transactions/{transactionId}/submit","title":"Submit a signed transaction for broadcast (V2)","href":"/api-reference/cpn/cpn-platform/submit-transaction-v2"}]},{"group":"Requests for information","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/rfis/{rfiId}","title":"Get details for an RFI","href":"/api-reference/cpn/cpn-platform/get-rfi"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/rfis/{rfiId}/submit","title":"Submit RFI data","href":"/api-reference/cpn/cpn-platform/submit-rfi"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/rfis/{rfiId}/files","title":"Upload RFI file","href":"/api-reference/cpn/cpn-platform/upload-rfi-file"}]},{"group":"Support tickets","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/supportTickets","title":"Create a support ticket","href":"/api-reference/cpn/cpn-platform/create-support-ticket"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/cpn-ofi.yaml webhook paymentCryptoFundsPending","title":"Payment awaiting crypto funds","href":"/api-reference/cpn/cpn-platform/payment-crypto-funds-pending"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentFiatPaymentInitiated","title":"Payment fiat payment initiated","href":"/api-reference/cpn/cpn-platform/payment-fiat-payment-initiated"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentCompleted","title":"Payment completed","href":"/api-reference/cpn/cpn-platform/payment-completed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentFailed","title":"Payment failed","href":"/api-reference/cpn/cpn-platform/payment-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentDelayed","title":"Payment delayed","href":"/api-reference/cpn/cpn-platform/payment-delayed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentInManualReview","title":"Payment in manual review","href":"/api-reference/cpn/cpn-platform/payment-in-manual-review"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiInformationRequired","title":"RFI information required","href":"/api-reference/cpn/cpn-platform/rfi-information-required"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiInReview","title":"RFI in review","href":"/api-reference/cpn/cpn-platform/rfi-in-review"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiApproved","title":"RFI approved","href":"/api-reference/cpn/cpn-platform/rfi-approved"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiRejected","title":"RFI rejected","href":"/api-reference/cpn/cpn-platform/rfi-rejected"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionBroadcasted","title":"Transaction broadcasted","href":"/api-reference/cpn/cpn-platform/transaction-broadcasted"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionCompleted","title":"Transaction completed","href":"/api-reference/cpn/cpn-platform/transaction-completed"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionFailed","title":"Transaction failed","href":"/api-reference/cpn/cpn-platform/transaction-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook refundCreated","title":"Refund created","href":"/api-reference/cpn/cpn-platform/refund-created"},{"openapi":"openapi/cpn-ofi.yaml webhook refundFailed","title":"Refund failed","href":"/api-reference/cpn/cpn-platform/refund-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook refundCompleted","title":"Refund completed","href":"/api-reference/cpn/cpn-platform/refund-completed"}]}]},{"group":"Managed Payments","pages":[{"group":"Accounts","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts","title":"List all accounts","href":"/api-reference/cpn/managed-payments/accounts/list-accounts"},{"openapi":"openapi/accounts.yaml post /v1/accounts","title":"Create an account","href":"/api-reference/cpn/managed-payments/accounts/create-account"},{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}","title":"Get an account","href":"/api-reference/cpn/managed-payments/accounts/get-account"},{"openapi":"openapi/accounts.yaml post /v1/accounts/{accountId}/archive","title":"Archive an account","href":"/api-reference/cpn/managed-payments/accounts/archive-account"}]},{"group":"Wires","pages":[{"openapi":"openapi/accounts.yaml get /v1/banks/wires","title":"List all wire bank accounts","href":"/api-reference/cpn/managed-payments/wires/list-account-wire-accounts"},{"openapi":"openapi/accounts.yaml post /v1/banks/wires","title":"Create a wire bank account","href":"/api-reference/cpn/managed-payments/wires/create-account-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}","title":"Get a wire bank account","href":"/api-reference/cpn/managed-payments/wires/get-account-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}/instructions","title":"Get wire instructions","href":"/api-reference/cpn/managed-payments/wires/get-account-wire-account-instructions"}]},{"group":"Deposits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits","title":"List all account bank deposits","href":"/api-reference/cpn/managed-payments/deposits/list-account-deposits"},{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits/{id}","title":"Get an account bank deposit","href":"/api-reference/cpn/managed-payments/deposits/get-account-deposit"}]},{"group":"Withdrawals","pages":[{"openapi":"openapi/accounts.yaml post /v1/accounts/withdrawals","title":"Create an account bank withdrawal","href":"/api-reference/cpn/managed-payments/withdrawals/create-account-withdrawal"},{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals","title":"List all account bank withdrawals","href":"/api-reference/cpn/managed-payments/withdrawals/list-account-withdrawals"},{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals/{id}","title":"Get an account bank withdrawal","href":"/api-reference/cpn/managed-payments/withdrawals/get-account-withdrawal"}]},{"group":"Internal transfers","pages":[{"openapi":"openapi/managed-payments.yaml post /v1/accounts/transfers","title":"Create an account transfer","href":"/api-reference/cpn/managed-payments/transfers/create-account-transfer"},{"openapi":"openapi/managed-payments.yaml get /v1/accounts/transfers","title":"List all account transfers","href":"/api-reference/cpn/managed-payments/transfers/list-account-transfers"},{"openapi":"openapi/managed-payments.yaml get /v1/accounts/transfers/{id}","title":"Get an account transfer","href":"/api-reference/cpn/managed-payments/transfers/get-account-transfer"}]},{"group":"Credit","pages":[{"openapi":"openapi/managed-payments.yaml post /v1/managedPayments/credit/lines/{lineId}/transfers","title":"Borrow against line of credit","href":"/api-reference/cpn/managed-payments/credit/create-managed-payments-credit-transfer"},{"openapi":"openapi/managed-payments.yaml get /v1/managedPayments/credit/lines","title":"Get credit line details","href":"/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-line"},{"openapi":"openapi/managed-payments.yaml get /v1/managedPayments/credit/lines/{lineId}/transfers/{transferId}","title":"Get a credit transfer","href":"/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-transfer"},{"openapi":"openapi/managed-payments.yaml get /v1/managedPayments/credit/lines/{lineId}/transfers","title":"List credit transfers","href":"/api-reference/cpn/managed-payments/credit/list-managed-payments-credit-transfers"},{"openapi":"openapi/managed-payments.yaml get /v1/managedPayments/credit/lines/{lineId}/wireInstructions","title":"Get repayment wire instructions","href":"/api-reference/cpn/managed-payments/credit/get-managed-payments-credit-wire-instructions"}]},{"group":"Stablecoin payins","pages":[{"group":"Payment intents","pages":[{"openapi":"openapi/payments.yaml get /v1/paymentIntents","title":"List all payment intents","href":"/api-reference/cpn/managed-payments/payment-intents/list-payment-intents"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents","title":"Create a payment intent","href":"/api-reference/cpn/managed-payments/payment-intents/create-payment-intent"},{"openapi":"openapi/payments.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","href":"/api-reference/cpn/managed-payments/payment-intents/get-payment-intent"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents/{id}/expire","title":"Expire a payment intent","href":"/api-reference/cpn/managed-payments/payment-intents/expire-payment-intent"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents/{id}/refund","title":"Refund a payment intent","href":"/api-reference/cpn/managed-payments/payment-intents/refund-payment-intent"}]},{"group":"Payments","pages":[{"openapi":"openapi/payments.yaml get /v1/payments","title":"List all payments","href":"/api-reference/cpn/managed-payments/payments/list-payments"},{"openapi":"openapi/payments.yaml get /v1/payments/{id}","title":"Get a payment","href":"/api-reference/cpn/managed-payments/payments/get-payment"}]},{"group":"Refund addresses","pages":[{"openapi":"openapi/payments.yaml post /v1/payments/refundAddresses","title":"Create a crypto payment refund address","href":"/api-reference/cpn/managed-payments/refund-addresses/create-payment-refund-address"}]}]},{"group":"Stablecoin payouts","pages":[{"group":"Address book","pages":[{"openapi":"openapi/payouts.yaml get /v1/addressBook/recipients","title":"List all recipients","href":"/api-reference/cpn/managed-payments/address-book/list-address-book-recipients"},{"openapi":"openapi/payouts.yaml post /v1/addressBook/recipients","title":"Create a recipient","href":"/api-reference/cpn/managed-payments/address-book/create-address-book-recipient"},{"openapi":"openapi/payouts.yaml get /v1/addressBook/recipients/{id}","title":"Get a recipient","href":"/api-reference/cpn/managed-payments/address-book/get-address-book-recipient"},{"openapi":"openapi/payouts.yaml patch /v1/addressBook/recipients/{id}","title":"Modify a recipient","href":"/api-reference/cpn/managed-payments/address-book/modify-address-book-recipient"},{"openapi":"openapi/payouts.yaml delete /v1/addressBook/recipients/{id}","title":"Delete a recipient","href":"/api-reference/cpn/managed-payments/address-book/delete-address-book-recipient"}]},{"group":"Payouts","pages":[{"openapi":"openapi/payouts.yaml get /v1/payouts","title":"List all payouts","href":"/api-reference/cpn/managed-payments/payouts/list-payouts"},{"openapi":"openapi/payouts.yaml post /v1/payouts","title":"Create a payout","href":"/api-reference/cpn/managed-payments/payouts/create-payout"},{"openapi":"openapi/payouts.yaml get /v1/payouts/{id}","title":"Get a payout","href":"/api-reference/cpn/managed-payments/payouts/get-payout"}]}]},{"group":"Reporting","pages":[{"openapi":"openapi/account.yaml get /v1/reports","title":"List reports","href":"/api-reference/circle-mint/account/list-reports"},{"openapi":"openapi/account.yaml post /v1/reports","title":"Request a report","href":"/api-reference/circle-mint/account/request-report"},{"openapi":"openapi/account.yaml get /v1/reports/{id}","title":"Get report by ID","href":"/api-reference/circle-mint/account/get-report-by-id"},{"openapi":"openapi/account.yaml get /v1/reports/{id}/content","title":"Download report content","href":"/api-reference/circle-mint/account/get-report-content"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/managed-payments-webhooks.yaml webhook custodyTransfer","title":"Transfer state change","href":"/api-reference/cpn/managed-payments/webhooks/custody-transfer"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintPaymentIntents","title":"Payment intent state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-payment-intents"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintPayments","title":"Payment state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-payments"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintDeposits","title":"Deposit state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-deposits"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintPayout","title":"Payout state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-payout"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintWire","title":"Wire state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-wire"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintAddressBookRecipients","title":"Recipient address state change","href":"/api-reference/cpn/managed-payments/webhooks/mint-address-book-recipients"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintAccounts","title":"Subaccount status change","href":"/api-reference/cpn/managed-payments/webhooks/mint-accounts"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook mintExternalEntities","title":"External entity compliance decision","href":"/api-reference/cpn/managed-payments/webhooks/mint-external-entities"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook onboardingApplicationApproved","title":"Application approved","href":"/api-reference/cpn/managed-payments/webhooks/onboarding-application-approved"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook onboardingApplicationDenied","title":"Application denied","href":"/api-reference/cpn/managed-payments/webhooks/onboarding-application-denied"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook onboardingApplicationCancelled","title":"Application cancelled","href":"/api-reference/cpn/managed-payments/webhooks/onboarding-application-cancelled"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook onboardingApplicationRfiRequested","title":"Information requested","href":"/api-reference/cpn/managed-payments/webhooks/onboarding-application-rfi-requested"},{"openapi":"openapi/managed-payments-webhooks.yaml webhook onboardingPeriodicReviewRequested","title":"Periodic review requested","href":"/api-reference/cpn/managed-payments/webhooks/onboarding-periodic-review-requested"}]}]},{"group":"Stablecoin payments","pages":[{"group":"Stablecoin payins","pages":[{"group":"Payments","pages":[{"openapi":"openapi/payments.yaml get /v1/payments","title":"List all payments","href":"/api-reference/circle-mint/payments/list-payments"},{"openapi":"openapi/payments.yaml get /v1/payments/{id}","title":"Get a payment","href":"/api-reference/circle-mint/payments/get-payment"}]},{"group":"Payment intents","pages":[{"openapi":"openapi/payments.yaml get /v1/paymentIntents","title":"List all payment intents","href":"/api-reference/circle-mint/payments/list-payment-intents"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents","title":"Create a payment intent","href":"/api-reference/circle-mint/payments/create-payment-intent"},{"openapi":"openapi/payments.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","href":"/api-reference/circle-mint/payments/get-payment-intent"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents/{id}/expire","title":"Expire a payment intent","href":"/api-reference/circle-mint/payments/expire-payment-intent"},{"openapi":"openapi/payments.yaml post /v1/paymentIntents/{id}/refund","title":"Refund a payment intent","href":"/api-reference/circle-mint/payments/refund-payment-intent"}]},{"group":"Crypto Payment Refund Addresses","pages":[{"openapi":"openapi/payments.yaml post /v1/payments/refundAddresses","title":"Create a crypto payment refund address","href":"/api-reference/circle-mint/payments/create-payment-refund-address"}]}]},{"group":"Stablecoin payouts","pages":[{"group":"Payouts","pages":[{"openapi":"openapi/payouts.yaml get /v1/payouts","title":"List all payouts","href":"/api-reference/circle-mint/payouts/list-payouts"},{"openapi":"openapi/payouts.yaml post /v1/payouts","title":"Create a payout","href":"/api-reference/circle-mint/payouts/create-payout"},{"openapi":"openapi/payouts.yaml get /v1/payouts/{id}","title":"Get a payout","href":"/api-reference/circle-mint/payouts/get-payout"}]},{"group":"Address book","pages":[{"openapi":"openapi/payouts.yaml get /v1/addressBook/recipients","title":"List all recipients","href":"/api-reference/circle-mint/payouts/list-address-book-recipients"},{"openapi":"openapi/payouts.yaml post /v1/addressBook/recipients","title":"Create a recipient","href":"/api-reference/circle-mint/payouts/create-address-book-recipient"},{"openapi":"openapi/payouts.yaml get /v1/addressBook/recipients/{id}","title":"Get a recipient","href":"/api-reference/circle-mint/payouts/get-address-book-recipient"},{"openapi":"openapi/payouts.yaml patch /v1/addressBook/recipients/{id}","title":"Modify a recipient","href":"/api-reference/circle-mint/payouts/modify-address-book-recipient"},{"openapi":"openapi/payouts.yaml delete /v1/addressBook/recipients/{id}","title":"Delete a recipient","href":"/api-reference/circle-mint/payouts/delete-address-book-recipient"},{"openapi":"openapi/payouts.yaml get /v1/addressBook/vasps","title":"List VASPs","href":"/api-reference/circle-mint/payouts/list-address-book-vasps"}]}]}]},{"group":"Circle Payments Network","pages":[{"group":"Configurations","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/overview","title":"Get payment configurations","href":"/api-reference/cpn/cpn-platform/get-payment-configurations-overview"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/routes","title":"Get supported payment routes","href":"/api-reference/cpn/cpn-platform/list-routes"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/configurations/enabledRoutes","title":"Retrieve all ofi-enabled payment routes","href":"/api-reference/cpn/cpn-platform/list-ofi-enabled-routes"}]},{"group":"Quotes","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/quotes","title":"Create a quote","href":"/api-reference/cpn/cpn-platform/create-quotes"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/quotes/{quoteId}","title":"Get details of a quote","href":"/api-reference/cpn/cpn-platform/get-quote"}]},{"group":"Payments","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments","title":"List payments","href":"/api-reference/cpn/cpn-platform/list-payments"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments","title":"Create a payment","href":"/api-reference/cpn/cpn-platform/create-payment"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/requirements","title":"Get payment requirements for a quote","href":"/api-reference/cpn/cpn-platform/get-payment-requirements"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}","title":"Get a payment","href":"/api-reference/cpn/cpn-platform/get-payment"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/refunds/{refundId}","title":"Get refund details","href":"/api-reference/cpn/cpn-platform/get-refund"}]},{"group":"Transactions","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions","title":"Create a transaction","href":"/api-reference/cpn/cpn-platform/create-transaction"},{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/transactions/{transactionId}","title":"Get a transaction","href":"/api-reference/cpn/cpn-platform/get-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions/{transactionId}/submit","title":"Submit a signed transaction for broadcast","href":"/api-reference/cpn/cpn-platform/submit-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions/accelerate","title":"Accelerate a stuck transaction","href":"/api-reference/cpn/cpn-platform/accelerate-transaction"},{"openapi":"openapi/cpn-ofi.yaml post /v2/cpn/payments/{paymentId}/transactions","title":"Create a transaction (V2)","href":"/api-reference/cpn/cpn-platform/create-transaction-v2"},{"openapi":"openapi/cpn-ofi.yaml get /v2/cpn/payments/{paymentId}/transactions/{transactionId}","title":"Get a transaction by ID (V2)","href":"/api-reference/cpn/cpn-platform/get-transaction-v2"},{"openapi":"openapi/cpn-ofi.yaml post /v2/cpn/payments/{paymentId}/transactions/{transactionId}/submit","title":"Submit a signed transaction for broadcast (V2)","href":"/api-reference/cpn/cpn-platform/submit-transaction-v2"}]},{"group":"Requests for Information","pages":[{"openapi":"openapi/cpn-ofi.yaml get /v1/cpn/payments/{paymentId}/rfis/{rfiId}","title":"Get details for an RFI","href":"/api-reference/cpn/cpn-platform/get-rfi"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/rfis/{rfiId}/submit","title":"Submit RFI data","href":"/api-reference/cpn/cpn-platform/submit-rfi"},{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/rfis/{rfiId}/files","title":"Upload RFI file","href":"/api-reference/cpn/cpn-platform/upload-rfi-file"}]},{"group":"Support Tickets","pages":[{"openapi":"openapi/cpn-ofi.yaml post /v1/cpn/supportTickets","title":"Create a support ticket","href":"/api-reference/cpn/cpn-platform/create-support-ticket"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/cpn-ofi.yaml webhook paymentCryptoFundsPending","title":"Payment awaiting crypto funds","href":"/api-reference/cpn/cpn-platform/payment-crypto-funds-pending"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentFiatPaymentInitiated","title":"Payment fiat payment initiated","href":"/api-reference/cpn/cpn-platform/payment-fiat-payment-initiated"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentCompleted","title":"Payment completed","href":"/api-reference/cpn/cpn-platform/payment-completed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentFailed","title":"Payment failed","href":"/api-reference/cpn/cpn-platform/payment-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentDelayed","title":"Payment delayed","href":"/api-reference/cpn/cpn-platform/payment-delayed"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentInManualReview","title":"Payment in manual review","href":"/api-reference/cpn/cpn-platform/payment-in-manual-review"},{"openapi":"openapi/cpn-ofi.yaml webhook paymentRfiEmailInitiated","title":"Payment RFI email initiated","href":"/api-reference/cpn/cpn-platform/payment-rfi-email-initiated"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiInformationRequired","title":"RFI information required","href":"/api-reference/cpn/cpn-platform/rfi-information-required"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiInReview","title":"RFI in review","href":"/api-reference/cpn/cpn-platform/rfi-in-review"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiApproved","title":"RFI approved","href":"/api-reference/cpn/cpn-platform/rfi-approved"},{"openapi":"openapi/cpn-ofi.yaml webhook rfiRejected","title":"RFI rejected","href":"/api-reference/cpn/cpn-platform/rfi-rejected"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionBroadcasted","title":"Transaction broadcasted","href":"/api-reference/cpn/cpn-platform/transaction-broadcasted"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionCompleted","title":"Transaction completed","href":"/api-reference/cpn/cpn-platform/transaction-completed"},{"openapi":"openapi/cpn-ofi.yaml webhook transactionFailed","title":"Transaction failed","href":"/api-reference/cpn/cpn-platform/transaction-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook refundCreated","title":"Refund created","href":"/api-reference/cpn/cpn-platform/refund-created"},{"openapi":"openapi/cpn-ofi.yaml webhook refundFailed","title":"Refund failed","href":"/api-reference/cpn/cpn-platform/refund-failed"},{"openapi":"openapi/cpn-ofi.yaml webhook refundCompleted","title":"Refund completed","href":"/api-reference/cpn/cpn-platform/refund-completed"}]}]}]},{"anchor":"StableFX","icon":"swap","pages":[{"title":"StableFX API","sidebarTitle":"Overview","href":"/api-reference/stablefx"},{"title":"Postman collection","href":"/api-reference/stablefx/postman"},{"title":"StableFX API rate limits","sidebarTitle":"Rate limits","href":"/api-reference/stablefx/rate-limits"},{"group":"StableFX","pages":[{"group":"Quotes","pages":[{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/quotes","title":"Create a quote","href":"/api-reference/stablefx/all/create-quote"}]},{"group":"Trades","pages":[{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/trades","title":"Get all trades","href":"/api-reference/stablefx/all/list-trades"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/trades","title":"Create a trade","href":"/api-reference/stablefx/all/create-trade"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/trades/{tradeId}","title":"Get a trade","href":"/api-reference/stablefx/all/get-trade-by-id"}]},{"group":"Signatures","pages":[{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/signatures","title":"Register a trade signature","href":"/api-reference/stablefx/all/register-trade-signature"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/signatures/presign/{tradeId}","title":"Generate trade presign data","href":"/api-reference/stablefx/all/generate-trade-signature-data"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/signatures/funding/presign","title":"Generate funding presign data","href":"/api-reference/stablefx/all/generate-funding-presign-data"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/signatures/settlementAdvances/presign","title":"Get settlement advance Permit2 typed data for signing","href":"/api-reference/stablefx/all/presign-settlement-advance"}]},{"group":"Fees","pages":[{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/fees/{tradeId}","title":"Get fee for a trade","href":"/api-reference/stablefx/all/get-trade-fee"}]},{"group":"Funding","pages":[{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/fund","title":"Fund trades","href":"/api-reference/stablefx/all/fund-trade"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/stablefx.yaml webhook tradeConfirmed","title":"Trade confirmed","href":"/api-reference/stablefx/all/trade-confirmed"},{"openapi":"openapi/stablefx.yaml webhook tradePendingSettlement","title":"Trade pending settlement","href":"/api-reference/stablefx/all/trade-pending-settlement"},{"openapi":"openapi/stablefx.yaml webhook tradeMakerFunded","title":"Trade maker funded","href":"/api-reference/stablefx/all/trade-maker-funded"},{"openapi":"openapi/stablefx.yaml webhook tradeTakerFunded","title":"Trade taker funded","href":"/api-reference/stablefx/all/trade-taker-funded"},{"openapi":"openapi/stablefx.yaml webhook tradeCompleted","title":"Trade completed","href":"/api-reference/stablefx/all/trade-completed"},{"openapi":"openapi/stablefx.yaml webhook tradeRefunded","title":"Trade refunded","href":"/api-reference/stablefx/all/trade-refunded"},{"openapi":"openapi/stablefx.yaml webhook tradeFailed","title":"Trade failed","href":"/api-reference/stablefx/all/trade-failed"},{"openapi":"openapi/stablefx.yaml webhook tradeBreached","title":"Trade breached","href":"/api-reference/stablefx/all/trade-breached"},{"openapi":"openapi/stablefx.yaml webhook contractRecordTradeFailed","title":"Record trade operation failed","href":"/api-reference/stablefx/all/contract-record-trade-failed"},{"openapi":"openapi/stablefx.yaml webhook contractMakerDeliverFailed","title":"Maker deliver operation failed","href":"/api-reference/stablefx/all/contract-maker-deliver-failed"},{"openapi":"openapi/stablefx.yaml webhook contractTakerDeliverFailed","title":"Taker deliver operation failed","href":"/api-reference/stablefx/all/contract-taker-deliver-failed"},{"openapi":"openapi/stablefx.yaml webhook tradeMakerDelegateFunded","title":"Trade maker delegate funded","href":"/api-reference/stablefx/all/trade-maker-delegate-funded"},{"openapi":"openapi/stablefx.yaml webhook tradeTakerDelegateFunded","title":"Trade taker delegate funded","href":"/api-reference/stablefx/all/trade-taker-delegate-funded"},{"openapi":"openapi/stablefx.yaml webhook contractMakerDelegateDeliverFailed","title":"Contract maker delegate deliver failed","href":"/api-reference/stablefx/all/contract-maker-delegate-deliver-failed"},{"openapi":"openapi/stablefx.yaml webhook contractTakerDelegateDeliverFailed","title":"Contract taker delegate deliver failed","href":"/api-reference/stablefx/all/contract-taker-delegate-deliver-failed"}]},{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/stablefx.yaml get /v2/stablefx/notifications/subscriptions","title":"Get all webhook subscriptions","href":"/api-reference/stablefx/all/get-subscriptions"},{"openapi":"openapi/stablefx.yaml post /v2/stablefx/notifications/subscriptions","title":"Create a webhook subscription","href":"/api-reference/stablefx/all/create-subscription"},{"openapi":"openapi/stablefx.yaml get /v2/stablefx/notifications/subscriptions/{id}","title":"Get a notification subscription","href":"/api-reference/stablefx/all/get-subscription"},{"openapi":"openapi/stablefx.yaml patch /v2/stablefx/notifications/subscriptions/{id}","title":"Update a notification subscription","href":"/api-reference/stablefx/all/update-subscription"},{"openapi":"openapi/stablefx.yaml delete /v2/stablefx/notifications/subscriptions/{id}","title":"Delete a notification subscription","href":"/api-reference/stablefx/all/delete-subscription"},{"openapi":"openapi/stablefx.yaml get /v2/stablefx/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/stablefx/all/get-notification-signature"}]},{"group":"Settlement Advance","pages":[{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances/credit","title":"Get settlement advance credit line","href":"/api-reference/stablefx/all/get-settlement-advance-credit"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/settlementAdvances/reserve","title":"Reserve settlement advance credit","href":"/api-reference/stablefx/all/reserve-settlement-advance"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances/reservations","title":"List settlement advance reservations","href":"/api-reference/stablefx/all/list-settlement-advance-reservations"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances/reservations/{reservationId}","title":"Get a settlement advance reservation","href":"/api-reference/stablefx/all/get-settlement-advance-reservation"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/settlementAdvances/reservations/{reservationId}/cancel","title":"Cancel a settlement advance reservation","href":"/api-reference/stablefx/all/cancel-settlement-advance-reservation"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances","title":"List settlement advances","href":"/api-reference/stablefx/all/list-settlement-advances"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/settlementAdvances","title":"Request a settlement advance","href":"/api-reference/stablefx/all/request-settlement-advance"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances/{advanceId}","title":"Get settlement advance detail","href":"/api-reference/stablefx/all/get-settlement-advance-detail"},{"openapi":"openapi/stablefx.yaml post /v1/exchange/stablefx/settlementAdvances/repayments","title":"Repay a settlement advance","href":"/api-reference/stablefx/all/repay-settlement-advance"},{"openapi":"openapi/stablefx.yaml get /v1/exchange/stablefx/settlementAdvances/repayments/{repaymentId}","title":"Get a settlement advance repayment","href":"/api-reference/stablefx/all/get-settlement-advance-repayment"}]}]}]},{"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","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","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","groups":[{"group":"Match","pages":[{"group":"Account","pages":[{"openapi":"openapi/match.yaml get /v1/match/account","title":"Get account summary","href":"/api-reference/circle-match/all/get-account"}]},{"group":"Orders","pages":[{"openapi":"openapi/match.yaml get /v1/match/orders","title":"List orders","href":"/api-reference/circle-match/all/list-orders"},{"openapi":"openapi/match.yaml post /v1/match/orders","title":"Place an order","href":"/api-reference/circle-match/all/place-order"},{"openapi":"openapi/match.yaml get /v1/match/orders/{id}","title":"Get an order","href":"/api-reference/circle-match/all/get-order"},{"openapi":"openapi/match.yaml post /v1/match/orders/cancel","title":"Cancel an order","href":"/api-reference/circle-match/all/cancel-order"},{"openapi":"openapi/match.yaml post /v1/match/orders/cancel-all","title":"Cancel all orders","href":"/api-reference/circle-match/all/cancel-all-orders"},{"openapi":"openapi/match.yaml post /v1/match/orders/modify","title":"Modify an order","href":"/api-reference/circle-match/all/modify-order"}]},{"group":"Withdrawals","pages":[{"openapi":"openapi/match.yaml post /v1/match/withdrawals","title":"Withdraw funds","href":"/api-reference/circle-match/all/create-withdrawal"}]},{"group":"WebSocket","pages":[{"openapi":"openapi/match.yaml post /v1/match/ws/ticket","title":"Create a WebSocket ticket","href":"/api-reference/circle-match/all/create-ws-ticket"}]}]}]}]},{"tab":"Developer tools","menu":[{"item":"Sample projects","pages":[{"title":"Browse sample projects","sidebarTitle":"Sample projects","href":"/sample-projects"}]},{"item":"SDKs","pages":[{"title":"SDKs","sidebarTitle":"SDKs","mode":"wide","href":"/sdks"},{"group":"Developer-controlled wallets","expanded":true,"pages":[{"group":"Server SDKs","expanded":true,"pages":[{"title":"Getting started with the developer-controlled wallets Node.js SDK","sidebarTitle":"Node.js SDK","href":"/sdks/developer-controlled-wallets-nodejs-sdk"},{"title":"Getting started with the developer-controlled wallets Python SDK","sidebarTitle":"Python SDK","href":"/sdks/developer-controlled-wallets-python-sdk"}]}]},{"group":"User-controlled wallets","expanded":true,"pages":[{"title":"User-controlled wallets client SDKs","sidebarTitle":"Overview","href":"/sdks/user-controlled/overview"},{"group":"Client SDKs","expanded":true,"pages":[{"title":"Web SDK","href":"/sdks/user-controlled/web-sdk"},{"title":"iOS mobile SDK","href":"/sdks/user-controlled/ios-sdk"},{"title":"Android mobile SDK","href":"/sdks/user-controlled/android-sdk"},{"title":"React Native SDK","href":"/sdks/user-controlled/react-native-sdk"},{"group":"UI customization","expanded":true,"pages":[{"title":"Confirmation UIs","href":"/sdks/user-controlled/confirmation-uis"},{"title":"Web SDK UI customizations","href":"/sdks/user-controlled/web-sdk-ui-customizations"},{"title":"iOS SDK UI customization API","href":"/sdks/user-controlled/ios-sdk-ui-customization-api"},{"title":"Android SDK UI customization API","href":"/sdks/user-controlled/android-sdk-ui-customization-api"},{"title":"React Native SDK UI customization API","href":"/sdks/user-controlled/react-native-sdk-ui-customization-api"}]},{"title":"User-controlled wallet SDK error codes","sidebarTitle":"Error codes","href":"/sdks/user-controlled/error-codes"}]},{"group":"Server SDKs","expanded":true,"pages":[{"title":"Getting started with the user-controlled wallets Node.js SDK","sidebarTitle":"Node.js SDK","href":"/sdks/user-controlled-wallets-nodejs-sdk"},{"title":"Getting started with the user-controlled wallets Python SDK","sidebarTitle":"Python SDK","href":"/sdks/user-controlled-wallets-python-sdk"}]}]},{"group":"Modular wallets","expanded":true,"pages":[{"title":"Modular wallets client SDKs","sidebarTitle":"Overview","href":"/sdks/modular/overview"},{"group":"Client SDKs","expanded":true,"pages":[{"title":"Modular wallets Web SDK","sidebarTitle":"Web SDK","href":"/sdks/modular/web-sdk"},{"title":"Modular wallets iOS SDK","sidebarTitle":"iOS mobile SDK","href":"/sdks/modular/ios-sdk"},{"title":"Modular wallets Android SDK","sidebarTitle":"Android mobile SDK","href":"/sdks/modular/android-sdk"}]}]},{"group":"Digital Asset Accounts","expanded":true,"pages":[{"group":"Client SDKs","expanded":true,"pages":[{"title":"DAA web SDK reference","sidebarTitle":"Web SDK","href":"/sdks/daa/web-sdk"}]}]},{"group":"Contracts","expanded":true,"pages":[{"group":"Server SDKs","expanded":true,"pages":[{"title":"Getting started with the Contracts Node.js SDK","sidebarTitle":"Node.js SDK","href":"/sdks/contracts-nodejs-sdk"},{"title":"Getting started with the Contracts Python SDK","sidebarTitle":"Python SDK","href":"/sdks/contracts-python-sdk"}]}]},{"group":"Gateway Nanopayments","expanded":true,"pages":[{"group":"Client SDKs","expanded":true,"pages":[{"title":"Gateway Nanopayments SDK reference","sidebarTitle":"Gateway Nanopayments SDK","href":"/sdks/gateway-nanopayments-sdk"}]}]},{"group":"Migration guides","expanded":true,"pages":[{"title":"Server-side SDK Pydantic v2 upgrade","href":"/sdks/pydantic-v2-upgrade"}]}]},{"item":"Release notes","pages":[{"title":"Release notes","href":"/release-notes"},{"group":"2026","pages":[{"title":"Release notes - Agent stack - 2026","sidebarTitle":"Agent stack","href":"/release-notes/agent-stack-2026"},{"title":"Release notes - CCTP - 2026","sidebarTitle":"CCTP","href":"/release-notes/cctp-2026"},{"title":"Release notes - Gateway - 2026","sidebarTitle":"Gateway","href":"/release-notes/gateway-2026"},{"title":"Release notes - xReserve - 2026","sidebarTitle":"xReserve","href":"/release-notes/xreserve-2026"},{"title":"Release notes - Wallets - 2026","sidebarTitle":"Wallets","href":"/release-notes/wallets-2026"},{"title":"Release notes - Bridge Kit - 2026","sidebarTitle":"Bridge Kit","href":"/release-notes/bridge-kit-2026"},{"title":"Release notes - USDC - 2026","sidebarTitle":"USDC","href":"/release-notes/usdc-2026"},{"title":"Release notes - EURC - 2026","sidebarTitle":"EURC","href":"/release-notes/eurc-2026"},{"title":"Release notes - Mint - 2026","sidebarTitle":"Mint","href":"/release-notes/mint-2026"},{"title":"Release notes - Circle Payments Network - 2026","sidebarTitle":"Circle Payments Network","href":"/release-notes/cpn-2026"},{"title":"Release notes - StableFX - 2026","sidebarTitle":"StableFX","href":"/release-notes/stablefx-2026"},{"title":"Release notes - Digital Asset Accounts - 2026","sidebarTitle":"Digital Asset Accounts","href":"/release-notes/digital-asset-accounts-2026"},{"title":"Release notes - Partner Onboarding - 2026","sidebarTitle":"Partner Onboarding","href":"/release-notes/partner-onboarding-2026"}]},{"group":"2025","pages":[{"title":"Release notes - Developer Services - 2025","sidebarTitle":"Developer Services","href":"/release-notes/w3s-2025"},{"title":"Release notes - Circle Mint - 2025","sidebarTitle":"Circle Mint","href":"/release-notes/circle-mint-2025"},{"title":"Release notes - Stablecoins - 2025","sidebarTitle":"Stablecoins","href":"/release-notes/stablecoins-2025"},{"title":"Release notes - Tokenized Funds - 2025","sidebarTitle":"Tokenized Funds","href":"/release-notes/tokenized-funds-2025"},{"title":"Release notes - Circle Payments Network - 2025","sidebarTitle":"Circle Payments Network","href":"/release-notes/cpn-2025"},{"title":"Release notes - StableFX - 2025","sidebarTitle":"StableFX","href":"/release-notes/stablefx-2025"}]},{"group":"2024","pages":[{"title":"Release notes - Developer Services - 2024","sidebarTitle":"Developer Services","href":"/release-notes/w3s-2024"},{"title":"Release notes - Circle Mint - 2024","sidebarTitle":"Circle Mint","href":"/release-notes/circle-mint-2024"},{"title":"Release notes - Stablecoins - 2024","sidebarTitle":"Stablecoins","href":"/release-notes/stablecoins-2024"}]}]}]}]},"basePath":"","title":"Submit a payout RFI response - Circle Docs","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}