{"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/digital-asset-accounts/all/get-payment-intent","slug":"/api-reference/digital-asset-accounts/all/get-payment-intent","pageMetadata":{"openapi":"openapi/accounts.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","description":"Retrieves a specific payment intent.","href":"/api-reference/digital-asset-accounts/all/get-payment-intent"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves a specific payment intent.\"\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/accounts.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","description":"Retrieves a specific payment intent.","href":"/api-reference/digital-asset-accounts/all/get-payment-intent"}}},"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":{"security":["ae056d74-4838-43c0-b438-672d28eddf40"],"summary":"Get a payment intent","description":"Retrieves a specific payment intent.","operationId":"getPaymentIntent","tags":["Crypto Payment Intents"],"parameters":["bfdc0c8f-1ac7-44e5-8078-2d2460ad1c27"],"responses":{"200":"6a4498e4-eda6-47dd-b6d9-bb1c70d7f633","401":"96227137-f168-4d85-8df2-3cf3f6a72a9a","404":"7cfe5f58-11cb-44ed-9ffe-8ef93a8f158f","500":"79811d51-3928-4aab-afc2-d0d8bd74ba9a"},"method":"get","type":"path","servers":["0e0490e8-1be4-41e2-b82a-4b05b96f3e2d","6c718f88-d22a-4343-aba3-31cca6695f55"],"path":"/v1/paymentIntents/{id}","baseUrlOptions":["https://api-sandbox.circle.com","https://api.circle.com"],"title":"Get a payment intent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bfdc0c8f-1ac7-44e5-8078-2d2460ad1c27":{"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>"}}},"responses":{"6a4498e4-eda6-47dd-b6d9-bb1c70d7f633":{"description":"Successfully retrieved a payment intent.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"title":"GetPaymentIntentResponse","properties":{"data":{"oneOf":[{"type":"object","description":"A transient payment intent.","required":["amount","settlementCurrency","paymentMethods"],"properties":{"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.0.amount.amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.0.amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.oneOf.0.amount","typeLabel":"object"},"settlementCurrency":{"description":"Desired currency for the payments to settle in.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.0.settlementCurrency","typeLabel":"enum\u003cstring>"},"paymentMethods":{"type":"array","items":{"type":"object","required":["type","chain"],"properties":{"type":{"type":"string","enum":["blockchain"],"isRequired":true,"uniqueKey":"data.oneOf.0.paymentMethods.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"chain":{"type":"string","description":"A blockchain that a given currency is available on.","example":"ETH","enum":["ALGO","APTOS","ARB","ARC","AVAX","BASE","BTC","CELO","CODEX","ETH","HBAR","HYPEREVM","INK","LINEA","NEAR","NOBLE","OP","PLUME","PAH","POLY","SEI","SOL","SONIC","SUI","UNI","WORLDCHAIN","XDC","XLM","XRP","ZKS"],"isRequired":true,"uniqueKey":"data.oneOf.0.paymentMethods.items.[INDEX].chain","typeLabel":"enum\u003cstring>"},"address":{"type":"string","example":"0x8381470ED67C3802402dbbFa0058E8871F017A6F","uniqueKey":"data.oneOf.0.paymentMethods.items.[INDEX].address","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.paymentMethods.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.oneOf.0.paymentMethods","typeLabel":"object[]"},"id":{"type":"string","description":"Unique system-generated identifier for the entity.","format":"uuid","example":"b8627ae8-732b-4d25-b947-1df8f4007a29","uniqueKey":"data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"amountPaid":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.0.amountPaid.amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.0.amountPaid.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.0.amountPaid","typeLabel":"object"},"amountRefunded":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.0.amountRefunded.amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.0.amountRefunded.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.0.amountRefunded","typeLabel":"object"},"fees":{"type":"array","items":{"type":"object","required":["type","amount","currency"],"properties":{"type":{"type":"string","enum":["blockchainLeaseFee","totalPaymentFees"],"isRequired":true,"uniqueKey":"data.oneOf.0.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.0.fees.items.[INDEX].amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD"],"isRequired":true,"uniqueKey":"data.oneOf.0.fees.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.0.fees.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.fees","typeLabel":"object[]"},"paymentIds":{"description":"List of associated payments.","type":"array","items":{"type":"string","format":"uuid","example":"69808f36-3e5e-4f37-bf82-ca79e4d70fc1","uniqueKey":"data.oneOf.0.paymentIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"data.oneOf.0.paymentIds","typeLabel":"string\u003cuuid>[]"},"refundIds":{"description":"List of associated refunds.","type":"array","items":{"type":"string","format":"uuid","example":"425dca6d-ac79-43b6-b0f9-43fdc51de91b","uniqueKey":"data.oneOf.0.refundIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"data.oneOf.0.refundIds","typeLabel":"string\u003cuuid>[]"},"timeline":{"description":"State management timeline.","type":"array","items":{"type":"object","required":["status","time"],"properties":{"status":{"type":"string","enum":["created","pending","active","complete","expired","failed","refunded"],"isRequired":true,"uniqueKey":"data.oneOf.0.timeline.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"time":{"description":"ISO-8601 UTC date/time format.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.0.timeline.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"context":{"type":"string","enum":["underpaid","paid","overpaid"],"uniqueKey":"data.oneOf.0.timeline.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["requested_by_merchant","fee_collection_failed"],"uniqueKey":"data.oneOf.0.timeline.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.0.timeline.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.timeline","typeLabel":"object[]"},"expiresOn":{"type":"string","description":"The time at which the transient payment intent expires. Once expired, the payment intent no longer accepts payments.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.oneOf.0.expiresOn","typeLabel":"string"},"updateDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.oneOf.0.updateDate","typeLabel":"string"},"createDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.oneOf.0.createDate","typeLabel":"string"},"merchantWalletId":{"type":"string","description":"Identifier of the wallet that receives the payment. For Digital Asset Accounts, this is the `accountId` of the custody account.","maxLength":36,"example":"1000662322","uniqueKey":"data.oneOf.0.merchantWalletId","typeLabel":"string"},"purposeOfTransfer":{"type":"string","description":"Payment reason code describing the purpose of the transfer for the payment intent.\n\nRequired for Circle Inc (`CIRCLE_INC`) entities with Managed Payments enabled. Optional otherwise.\n\n`PMT006` (Transfer to own account) is not allowed for payment intents. A missing value (when required) or a disallowed or invalid value returns error code `INVALID_PURPOSE_OF_TRANSFER`.\n","enum":["PMT000","PMT001","PMT002","PMT003","PMT004","PMT005","PMT007","PMT008","PMT009","PMT010","PMT011","PMT012","PMT013","PMT014","PMT015","PMT016","PMT017","PMT018","PMT019","PMT020","PMT021","PMT022","PMT023","PMT024","PMT025","PMT026","PMT027","PMT028","PMT029","PMT030"],"example":"PMT001","uniqueKey":"data.oneOf.0.purposeOfTransfer","typeLabel":"enum\u003cstring>"},"customerExternalRef":{"type":"string","format":"uuid","description":"A customer-supplied reference for reconciliation purposes, used on payment intents, payments, and refunds. Must be a UUID. Payouts use a separate 36-character limit schema.","example":"310c458a-18eb-4cbd-8a9a-586d9448ae69","uniqueKey":"data.oneOf.0.customerExternalRef","typeLabel":"string\u003cuuid>"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","description":"A continuous payment intent.","required":["currency","settlementCurrency","paymentMethods","type"],"properties":{"currency":{"description":"Desired currency of the payment.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.1.currency","typeLabel":"enum\u003cstring>"},"settlementCurrency":{"description":"Desired currency for the payments to settle in.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.1.settlementCurrency","typeLabel":"enum\u003cstring>"},"paymentMethods":{"type":"array","items":{"type":"object","required":["type","chain"],"properties":{"type":{"type":"string","enum":["blockchain"],"isRequired":true,"uniqueKey":"data.oneOf.1.paymentMethods.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"chain":{"type":"string","description":"A blockchain that a given currency is available on.","example":"ETH","enum":["ALGO","APTOS","ARB","ARC","AVAX","BASE","BTC","CELO","CODEX","ETH","HBAR","HYPEREVM","INK","LINEA","NEAR","NOBLE","OP","PLUME","PAH","POLY","SEI","SOL","SONIC","SUI","UNI","WORLDCHAIN","XDC","XLM","XRP","ZKS"],"isRequired":true,"uniqueKey":"data.oneOf.1.paymentMethods.items.[INDEX].chain","typeLabel":"enum\u003cstring>"},"address":{"type":"string","example":"0x8381470ED67C3802402dbbFa0058E8871F017A6F","uniqueKey":"data.oneOf.1.paymentMethods.items.[INDEX].address","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.paymentMethods.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.oneOf.1.paymentMethods","typeLabel":"object[]"},"type":{"type":"string","enum":["continuous"],"isRequired":true,"uniqueKey":"data.oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique system-generated identifier for the entity.","format":"uuid","example":"b8627ae8-732b-4d25-b947-1df8f4007a29","uniqueKey":"data.oneOf.1.id","typeLabel":"string\u003cuuid>"},"amountPaid":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.1.amountPaid.amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.1.amountPaid.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.1.amountPaid","typeLabel":"object"},"amountRefunded":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.1.amountRefunded.amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD","EUR"],"isRequired":true,"uniqueKey":"data.oneOf.1.amountRefunded.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.1.amountRefunded","typeLabel":"object"},"fees":{"type":"array","items":{"type":"object","required":["type","amount","currency"],"properties":{"type":{"type":"string","enum":["blockchainLeaseFee","totalPaymentFees"],"isRequired":true,"uniqueKey":"data.oneOf.1.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.oneOf.1.fees.items.[INDEX].amount","typeLabel":"string"},"currency":{"description":"Currency code.","type":"string","enum":["USD"],"isRequired":true,"uniqueKey":"data.oneOf.1.fees.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.1.fees.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.fees","typeLabel":"object[]"},"timeline":{"description":"State management timeline.","type":"array","items":{"type":"object","required":["status","time"],"properties":{"status":{"type":"string","enum":["created","pending","active","complete","expired","failed","refunded"],"isRequired":true,"uniqueKey":"data.oneOf.1.timeline.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"time":{"description":"ISO-8601 UTC date/time format.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.oneOf.1.timeline.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"context":{"type":"string","enum":["underpaid","paid","overpaid"],"uniqueKey":"data.oneOf.1.timeline.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["requested_by_merchant","fee_collection_failed"],"uniqueKey":"data.oneOf.1.timeline.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.oneOf.1.timeline.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.timeline","typeLabel":"object[]"},"updateDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.oneOf.1.updateDate","typeLabel":"string"},"createDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.oneOf.1.createDate","typeLabel":"string"},"merchantWalletId":{"type":"string","description":"Identifier of the wallet that receives the payment. For Digital Asset Accounts, this is the `accountId` of the custody account.","maxLength":36,"example":"1000662322","uniqueKey":"data.oneOf.1.merchantWalletId","typeLabel":"string"},"purposeOfTransfer":{"type":"string","description":"Payment reason code describing the purpose of the transfer for the payment intent.\n\nRequired for Circle Inc (`CIRCLE_INC`) entities with Managed Payments enabled. Optional otherwise.\n\n`PMT006` (Transfer to own account) is not allowed for payment intents. A missing value (when required) or a disallowed or invalid value returns error code `INVALID_PURPOSE_OF_TRANSFER`.\n","enum":["PMT000","PMT001","PMT002","PMT003","PMT004","PMT005","PMT007","PMT008","PMT009","PMT010","PMT011","PMT012","PMT013","PMT014","PMT015","PMT016","PMT017","PMT018","PMT019","PMT020","PMT021","PMT022","PMT023","PMT024","PMT025","PMT026","PMT027","PMT028","PMT029","PMT030"],"example":"PMT001","uniqueKey":"data.oneOf.1.purposeOfTransfer","typeLabel":"enum\u003cstring>"},"customerExternalRef":{"type":"string","format":"uuid","description":"A customer-supplied reference for reconciliation purposes, used on payment intents, payments, and refunds. Must be a UUID. Payouts use a separate 36-character limit schema.","example":"310c458a-18eb-4cbd-8a9a-586d9448ae69","uniqueKey":"data.oneOf.1.customerExternalRef","typeLabel":"string\u003cuuid>"}},"uniqueKey":"data.oneOf.1","typeLabel":"object"}],"uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"GetPaymentIntentResponse ยท object"},"examples":{"Example":{"title":"Example","value":{"data":{"amount":{"amount":"3.14","currency":"USD"},"settlementCurrency":"USD","paymentMethods":[{"type":"blockchain","chain":"ETH","address":"0x8381470ED67C3802402dbbFa0058E8871F017A6F"}],"id":"b8627ae8-732b-4d25-b947-1df8f4007a29","amountPaid":{"amount":"3.14","currency":"USD"},"amountRefunded":{"amount":"3.14","currency":"USD"},"fees":[{"type":"blockchainLeaseFee","amount":"3.14","currency":"USD"}],"paymentIds":["69808f36-3e5e-4f37-bf82-ca79e4d70fc1"],"refundIds":["425dca6d-ac79-43b6-b0f9-43fdc51de91b"],"timeline":[{"status":"created","time":"2023-11-07T05:31:56Z","context":"underpaid","reason":"requested_by_merchant"}],"expiresOn":"2020-04-10T02:13:30.000Z","updateDate":"2020-04-10T02:13:30.000Z","createDate":"2020-04-10T02:13:30.000Z","merchantWalletId":"1000662322","purposeOfTransfer":"PMT001","customerExternalRef":"310c458a-18eb-4cbd-8a9a-586d9448ae69"}}}},"exampleType":"generated"}},"exampleType":"generated"},"96227137-f168-4d85-8df2-3cf3f6a72a9a":{"description":"The request has not been applied because it lacks valid authentication credentials.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** โ `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":4,"message":"Unauthorized."},"examples":{"Example":{"title":"Example","value":{"code":4,"message":"Unauthorized."}}},"exampleType":"examples"}},"exampleType":"examples"},"7cfe5f58-11cb-44ed-9ffe-8ef93a8f158f":{"description":"The specified resource was not found.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** โ `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":404,"message":"Not found."},"examples":{"Example":{"title":"Example","value":{"code":404,"message":"Not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"79811d51-3928-4aab-afc2-d0d8bd74ba9a":{"description":"The server encountered an unexpected condition that prevented it from fulfilling the request.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** โ `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":-1,"message":"Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"},"examples":{"Example":{"title":"Example","value":{"code":-1,"message":"Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ae056d74-4838-43c0-b438-672d28eddf40":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0e0490e8-1be4-41e2-b82a-4b05b96f3e2d":{"url":"https://api-sandbox.circle.com"},"6c718f88-d22a-4343-aba3-31cca6695f55":{"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/accounts.yaml"},"subdomain":"circle-167b8d39","siteName":"Circle Docs","title":"Get a payment intent - Circle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T20:40:02.362Z","originalFileLocation":"api-reference/digital-asset-accounts/all/get-payment-intent.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=\"Retrieves a specific payment intent.\">\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=\"Get a payment intent - Circle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a specific payment intent.\">\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/digital-asset-accounts/all/get-payment-intent\">\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=Crypto+Payment+Intents\u0026amp;title=Get+a+payment+intent\u0026amp;description=Retrieves+a+specific+payment+intent.\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=013f2d38d4dbabe3e80553c2175ef8cfdeae26b26abbf060042bcbc603eb5956\">\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=\"Get a payment intent - Circle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a specific payment intent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=Crypto+Payment+Intents\u0026amp;title=Get+a+payment+intent\u0026amp;description=Retrieves+a+specific+payment+intent.\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=013f2d38d4dbabe3e80553c2175ef8cfdeae26b26abbf060042bcbc603eb5956\">\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/digital-asset-accounts/all/get-payment-intent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/digital-asset-accounts/all/get-payment-intent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.circle.com/#organization\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/light.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=decfb42837e0eb7c32dd425866902e78\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.circle.com#website\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent#webpage\",\"url\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent\",\"name\":\"Get a payment intent\",\"description\":\"Retrieves a specific payment intent.\",\"dateModified\":\"2026-10-05T20:40:02.362Z\",\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Third-party crypto operations\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/list-payment-intents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Crypto Payment Intents\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/list-payment-intents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a payment intent\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent#apireference\",\"headline\":\"Get a payment intent\",\"name\":\"Get a payment intent\",\"description\":\"Retrieves a specific payment intent.\",\"url\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent\",\"mainEntityOfPage\":{\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/get-payment-intent#webpage\"},\"dateModified\":\"2026-10-05T20:40:02.362Z\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"}}]}\u003c/script>","siteName":"Circle Docs","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Assets","pages":[{"title":"Assets","href":"/assets"}]},{"tab":"Build onchain","pages":[{"title":"Build onchain","href":"/build-onchain"}]},{"tab":"Crosschain transfers","pages":[{"title":"Crosschain transfers","href":"/crosschain-transfers"}]},{"tab":"Agent stack","pages":[{"title":"Agent stack","href":"/agent-stack"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/cpn"}]},{"tab":"Liquidity services","pages":[{"title":"Liquidity services","href":"/liquidity-services"}]},{"tab":"API reference","anchors":[{"anchor":"Home","icon":"home","pages":[{"title":"Home","href":"/api-reference"}]},{"anchor":"Wallets","icon":"wallet","pages":[{"title":"Wallets","href":"/api-reference/wallets"}]},{"anchor":"Contracts","icon":"file-contract","pages":[{"title":"Contracts","href":"/api-reference/contracts"}]},{"anchor":"CCTP","icon":"bridge","pages":[{"title":"CCTP","href":"/api-reference/cctp"}]},{"anchor":"Gateway","icon":"dungeon","pages":[{"title":"Gateway","href":"/api-reference/gateway"}]},{"anchor":"x402 facilitators","icon":"handshake","pages":[{"title":"x402 facilitators","href":"/api-reference/x402-facilitators"}]},{"anchor":"Digital Asset Accounts","icon":"money-bill-1-wave","pages":[{"title":"Digital Asset Accounts 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","description":"Create a continuous or transient payment intent. Always set `type`: when it is omitted, the default type depends on account configuration.\n\n**Digital Asset Accounts:** crypto payments are available only for custody accounts (`purpose: custody`) and are for third-party payments only. They are not supported when the distributor or the end user is under the Circle FR (`CIRCLE_FR`) or Circle SG (`CIRCLE_SG`) legal entity. Set `merchantWalletId` to the `accountId` of the end user's custody account. Requests that target the master wallet, either by omitting `merchantWalletId` or by passing the distributor's own master wallet ID, are rejected with `403`.\n\n`purposeOfTransfer` is required for Circle Inc (`CIRCLE_INC`) entities with Managed Payments enabled and optional otherwise. `PMT006` is not allowed.\n","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","description":"Expires a payment intent so it no longer accepts payments.","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","href":"/api-reference/end-user-onboarding"}]},{"anchor":"Mint and Custody","icon":"building-columns","pages":[{"title":"Mint and Custody","href":"/api-reference/circle-mint"}]},{"anchor":"Circle Payments Network","icon":"chart-network","pages":[{"title":"Circle Payments Network","href":"/api-reference/cpn"}]},{"anchor":"StableFX","icon":"swap","pages":[{"title":"StableFX","href":"/api-reference/stablefx"}]},{"anchor":"xReserve","icon":"vault","pages":[{"title":"xReserve","href":"/api-reference/xreserve"}]},{"anchor":"Match","pages":[{"title":"Match","href":"/api-reference/circle-match/all/get-account"}]}]},{"tab":"Developer tools","menu":[{"item":"Sample projects","pages":[{"title":"Sample projects","href":"/sample-projects"}]},{"item":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"item":"Release notes","pages":[{"title":"Release notes","href":"/release-notes"}]}],"pages":[{"title":"Developer tools","href":"/sample-projects"}]}]},"basePath":"","title":"Get a payment intent - 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"]}