Recipient resource. Optional identity and ownership appear immediately after status when present.
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":""},"chroma":{"liveDeploymentHistoryId":"6ae215718e4709662984d6d0","collectionId":"07cf3ab0-7b28-4515-ba6f-e7283f842d0e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae215718e4709662984d6d0"},"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":"6ae215718e4709662984d6d0","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":587},{"language":"default","tag":"Wallets","count":159},{"language":"default","tag":"Circle Payments Network","count":156},{"language":"default","tag":"Mint and Custody","count":124},{"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":100},{"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"snippets/SDKCard.css","content":".cb-card{border:1px solid #e5e7eb;border-radius:12px;background:#fff;box-shadow:0 1px 3px 0 rgba(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:.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-icon-neutral,.text-neutral-subtle{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 .2s;border:1px solid #e5e7eb;background:#fff;color:#374151}.cb-button:hover{background:#f9fafb;border-color:#d1d5db}"},{"filePath":"style.css","content":":root{--background-dark:17 24 39!important}html.dark .accordion,html.dark .card{background-color:#111827!important}#navbar .navbar-link a,#navbar [data-component-name=theme-toggle],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"]{background-color:rgba(17,24,39,.03)!important}#navbar .navbar-link a:hover,#navbar [data-component-name=theme-toggle]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover{background-color:rgba(17,24,39,.07)!important}@media (prefers-color-scheme:dark){#navbar .navbar-link a,#navbar [data-component-name=theme-toggle],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"]{background-color:rgba(255,255,255,.05)!important}#navbar .navbar-link a:hover,#navbar [data-component-name=theme-toggle]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover{background-color:rgba(255,255,255,.1)!important}}html.dark #navbar .navbar-link a,html.dark #navbar [data-component-name=theme-toggle],html.dark #navbar a[href*=\"console.circle.com\"],html.dark #navbar a[href*=\"faucet.circle.com\"]{background-color:rgba(255,255,255,.05)!important}html.dark #navbar .navbar-link a:hover,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{background-color:rgba(255,255,255,.1)!important}html.dark #feedback-form-submit,html.dark #topbar-cta-button,html.dark #topbar-cta-button a,html.dark a[class*=\"bg-[#0073C3]\"],html.dark a[class*=\"bg-[#0073C3]\"] svg,html.dark a[class*=\"bg-[#1AA3FF]\"],html.dark a[class*=\"bg-[#1AA3FF]\"] svg,html.dark a[class*=\"bg-[#5FBFFF]\"],html.dark a[class*=\"bg-[#5FBFFF]\"] svg,html.dark a[class*=\"bg-[#90D2FF]\"],html.dark a[class*=\"bg-[#90D2FF]\"] svg,html.dark chat-assistant-send-button,html.dark code-snippet-feedback-form-submit-button,html.dark contextual-feedback-form-submit-button,html.dark tryit-button{color:#000!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:.75rem;font-weight:500;text-transform:uppercase;letter-spacing:.05em;color:#64748b}.dark .mcp-cta-cli:hover .mcp-cli-icon-wrap svg,.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:.875rem;padding:0 16px;text-decoration:none!important;display:inline-flex;align-items:center;gap:8px;border:1px solid rgba(15,23,42,.15);background-color:#f8fafc;color:#0b0f19;transition:background-color .15s ease,border-color .15s ease;cursor:pointer}.mcp-cta:hover{background-color:#f1f5f9;border-color:rgba(15,23,42,.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,.2);background-color:rgba(255,255,255,.08);color:#f8fafc}.dark .mcp-cta:hover{background-color:rgba(255,255,255,.12);border-color:rgba(255,255,255,.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,.06);border-color:rgba(255,255,255,.15)}.dark .mcp-cta-cli:hover{background-color:rgba(255,255,255,.1);border-color:rgba(255,255,255,.25)}.mcp-cli-label{font-weight:600;color:#0f172a}.dark .mcp-cli-label{color:#f1f5f9}.mcp-cli-cmd{font-size:.75rem;font-family:ui-monospace,SFMono-Regular,\"SF Mono\",Menlo,Consolas,monospace;color:#64748b;background:0 0!important;padding:0;white-space:nowrap;border:0}.dark .mcp-cli-cmd{color:#94a3b8;background:0 0!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 .15s ease}.dark .mcp-cli-icon-wrap svg,.mcp-cta-cli:hover .mcp-cli-icon-wrap svg{color:#64748b}.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 td,table thead th{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: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}.accordion:has([data-component-part=accordion-icon] svg[style*=\"circle-info.svg\"]) summary,.dark .accordion:has([data-component-part=accordion-icon] svg[style*=\"circle-info.svg\"]) summary{transition:background-color .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:#fff!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 code,.TryItOutComponent pre{background-color:transparent!important}.TryItOutComponent .code-container{background-color:#fff!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}#footer svg[style*=mask-image],.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(89deg,var(--background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(241, 235, 255, 0.5)\n ) 0%,var(--background-gradient-bg-accent-purple-gradient-top-right,\n rgba(225, 242, 255, 0.5)\n ) 94.58%)}.dark .home_tryitout{background:linear-gradient(89deg,var(--background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(44, 44, 44, 0.5)\n ) 0%,var(--background-gradient-bg-accent-purple-gradient-top-right,\n rgba(75, 82, 86, 0.5)\n ) 94.58%)}.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:0 0;padding:1rem 1.25rem 1.5rem;text-decoration:none;color:inherit;display:flex;flex-direction:column;justify-content:space-between;gap:.45rem;transition:border-color .2s ease,box-shadow .2s ease,transform .2s ease;height:100%}.asset-card:hover{border-color:#cfd3dc;box-shadow:0 12px 24px rgba(15,23,42,.08);transform:translateY(-2px)}.dark .asset-card{border-color:rgba(148,163,184,.14);background:0 0;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:.6rem;flex-shrink:0}.asset-card-image-wrapper{overflow:hidden;display:flex;align-items:center;justify-content:center;background:rgba(15,23,42,.05)}.dark .asset-card-image-wrapper{background:rgba(248,250,252,.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(135deg,rgba(0,96,255,.18),rgba(0,164,255,.05));color:#0d5be1}.dark .asset-card-inline-icon{background:rgba(255,255,255,.08);color:#82b7ff}.asset-card-inline-icon svg{width:26px;height:26px}.asset-card.secondary{justify-content:flex-start}.quickstart-cards-aligned [data-component-part=card],.quickstart-cards-aligned [data-component-part=card]>div,.quickstart-cards-aligned a.card,.quickstart-cards-aligned a.card>div{display:flex!important;flex-direction:column!important;height:100%!important}.quickstart-cards-aligned [data-component-part=card]>div>.prose,.quickstart-cards-aligned a.card>div>.prose{flex-grow:1!important;display:flex!important;flex-direction:column!important}.quickstart-cards-aligned [data-component-part=card]>div>div:last-child,.quickstart-cards-aligned a.card>div>div:last-child{margin-top:auto!important}@media (max-width:1024px){.quickstart-cards-aligned,div.quickstart-cards-aligned{display:flex!important;flex-direction:column!important;gap:4px!important}.quickstart-cards-aligned [data-component-part=card-group],.quickstart-cards-aligned>div,div.quickstart-cards-aligned [data-component-part=card-group],div.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}.quickstart-cards-aligned [data-component-part=card],.quickstart-cards-aligned a.card,div.quickstart-cards-aligned a.card{margin-bottom:4px!important;width:100%!important}.quickstart-cards-aligned [data-component-part=card]:last-child,.quickstart-cards-aligned a.card:last-child,div.quickstart-cards-aligned a.card:last-child{margin-bottom:0!important}}footer,footer [data-component-part=footer-section],footer [data-component-part=footer],footer>div{overflow-x:hidden!important;max-width:100%!important;padding-top:1.75rem!important}#your-privacy-choices-button,footer .footer-link,footer [data-component-part=footer-link],footer a{overflow-wrap:normal!important;word-wrap:normal!important;word-break:keep-all!important;hyphens:none!important;font-size:.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,#footer a[href*=mintlify]:hover,#footer a[href*=mintlify]:hover span,#footer a[href*=mintlify]:hover svg,#your-privacy-choices-button:hover{color:#4e4763!important}html.dark #footer a:hover,html.dark #footer a[href*=mintlify]:hover,html.dark #footer a[href*=mintlify]:hover span,html.dark #footer a[href*=mintlify]:hover svg,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 .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:.25rem!important}#footer [data-powered-by-relocated] a[href*=mintlify]{font-size:.75rem!important}#footer [data-powered-by-relocated] a[href*=mintlify] svg{height:.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}}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/cpn/managed-payments/address-book/get-address-book-recipient","slug":"/api-reference/cpn/managed-payments/address-book/get-address-book-recipient","pageMetadata":{"openapi":"openapi/payouts.yaml get /v1/addressBook/recipients/{id}","title":"Get a recipient","description":null,"href":"/api-reference/cpn/managed-payments/address-book/get-address-book-recipient"},"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 get /v1/addressBook/recipients/{id}","title":"Get a recipient","description":null,"href":"/api-reference/cpn/managed-payments/address-book/get-address-book-recipient"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/circle-167b8d39/d67aae5e94f8afee/content/gtm.js","/_mintlify/custom/circle-167b8d39/df50992471c6ad37/content/footer-powered-by.js"],"openApiReferenceData":{"operation":{"parameters":["8fd9d04d-2acd-417c-81a1-9eb39f6acf88"],"security":["648fcf83-3043-4bb6-a281-a929929e18f1"],"summary":"Get a recipient","operationId":"getAddressBookRecipient","tags":["Crypto Address Book"],"responses":{"200":"0a6c691f-32fb-4acc-88d3-0890bc1e35b6","401":"937197e0-aa46-4786-93cf-8dd95eac3d5e","404":"4fc9f06f-52e0-43a7-8e81-ea635707ffd1"},"method":"get","type":"path","servers":["e56f2e54-c1c5-4855-b205-e7ad557cb36a","b454d6d8-9e4f-4767-895e-24f64c0d9f84"],"path":"/v1/addressBook/recipients/{id}","baseUrlOptions":["https://api-sandbox.circle.com","https://api.circle.com"],"title":"Get a recipient","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8fd9d04d-2acd-417c-81a1-9eb39f6acf88":{"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":{"0a6c691f-32fb-4acc-88d3-0890bc1e35b6":{"description":"Successfully retrieved an address book recipient.","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":"GetAddressBookRecipientResponse","properties":{"data":{"type":"object","description":"Recipient resource. Optional `identity` and `ownership` appear immediately after `status` when present.\n","properties":{"id":{"type":"string","description":"Unique system generated identifier for the entity.","format":"uuid","example":"b8627ae8-732b-4d25-b947-1df8f4007a29","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"chain":{"type":"string","description":"A blockchain that a given currency is available on.","enum":["ALGO","APTOS","ARB","ARC","AVAX","BASE","BTC","CELO","CODEX","CRONOS","EDGE","ETH","HBAR","HYPEREVM","INJECTIVE","INK","LINEA","MONAD","MORPH","NEAR","NOBLE","OP","PHAROS","PLUME","PAH","PLASMA","POLY","SEI","SOL","SONIC","STRK","SUI","UNI","WORLDCHAIN","XLAYER","XDC","XLM","XRP","ZKS"],"uniqueKey":"data.chain","typeLabel":"enum\u003cstring>"},"address":{"type":"string","description":"An alphanumeric string representing a blockchain address. Formatting varies by blockchain.\nBe sure to preserve the exact formatting and capitalization of the address. \n**Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). \nThe `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`).\n","example":"0x8381470ED67C3802402dbbFa0058E8871F017A6F","uniqueKey":"data.address","typeLabel":"string"},"addressTag":{"oneOf":[{"type":"string","description":"The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.","example":"123456789","uniqueKey":"data.addressTag.oneOf.0","typeLabel":"string"},{"type":"null","description":"The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.","example":"123456789","uniqueKey":"data.addressTag.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.addressTag","typeLabel":"string | null"},"metadata":{"type":"object","description":"Recipient metadata. For Singapore (CIRCLE_SG) customers creating a self-hosted (`ownership.custody.type` = `self_hosted`) entry, `email` is required (validation error `2038`).\n","properties":{"nickname":{"type":"string","description":"Nickname related to the address.","example":"sample nickname","uniqueKey":"data.metadata.nickname","typeLabel":"string"},"email":{"type":"string","description":"Email address of the recipient. Required for Singapore (CIRCLE_SG) self-hosted entries.","maxLength":1024,"example":"satoshi@circle.com","uniqueKey":"data.metadata.email","typeLabel":"string"},"bns":{"type":"string","description":"Blockchain Name Service (e.g. ENS) domain for the address.","example":"sample.circle","uniqueKey":"data.metadata.bns","typeLabel":"string"}},"uniqueKey":"data.metadata","typeLabel":"object"},"status":{"type":"string","description":"Status of the address book recipient.","enum":["pending","pending_verification","inactive","active","denied"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"identity":{"type":"object","description":"Beneficiary identity for the address book entry.\n\nWhen `type` is `individual`, include `firstName` and `lastName`. When `type` is `business`, include `businessName`.\n\nWhen Beneficiary Personally Identifiable Information (PII) was submitted, the matching nested `individual` or `business` object is returned. A subset of submitted fields is never returned: for `individual`, `governmentIssuedId`; for `business`, `businessRegistrationNumber`, `dateOfIncorporation`, and `businessIdentificationNumber`.\n\nRelated validation error codes include `2024` (identity missing), `2031`–`2034`, and `2036` (identity cannot be updated via PATCH).\n","properties":{"type":{"type":"string","description":"Whether the beneficiary is an individual or a business.","enum":["individual","business"],"uniqueKey":"data.identity.type","typeLabel":"enum\u003cstring>"},"firstName":{"type":"string","description":"Required when `type` is `individual`.","example":"Ada","uniqueKey":"data.identity.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Required when `type` is `individual`.","example":"Lovelace","uniqueKey":"data.identity.lastName","typeLabel":"string"},"businessName":{"type":"string","description":"Legal business name. Required when `type` is `business`.","example":"Example Corp","uniqueKey":"data.identity.businessName","typeLabel":"string"},"individual":{"type":"object","description":"Beneficiary Personally Identifiable Information (PII) for an individual, as returned in responses. `governmentIssuedId` is never returned.\n","properties":{"dateOfBirth":{"type":"string","description":"Beneficiary's date of birth.","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"1990-01-15","uniqueKey":"data.identity.individual.dateOfBirth","typeLabel":"string"},"nationality":{"type":"string","description":"Beneficiary's nationality. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.","example":"SG","uniqueKey":"data.identity.individual.nationality","typeLabel":"string"},"addressLine1":{"type":"string","description":"Residential address, line 1.","maxLength":1024,"example":"1 Marina Boulevard","uniqueKey":"data.identity.individual.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Residential address, line 2 (optional).","maxLength":1024,"example":"#10-01","uniqueKey":"data.identity.individual.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City.","maxLength":1024,"example":"Singapore","uniqueKey":"data.identity.individual.city","typeLabel":"string"},"district":{"type":"string","description":"State / province / district.","maxLength":1024,"example":"Central","uniqueKey":"data.identity.individual.district","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal / ZIP code.","maxLength":16,"example":18989,"uniqueKey":"data.identity.individual.postalCode","typeLabel":"string"},"country":{"type":"string","description":"Country of residence. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.","maxLength":2,"example":"SG","uniqueKey":"data.identity.individual.country","typeLabel":"string"}},"uniqueKey":"data.identity.individual","typeLabel":"object"},"business":{"type":"object","description":"Beneficiary Personally Identifiable Information (PII) for a business, as returned in responses. `businessRegistrationNumber`, `dateOfIncorporation`, and `businessIdentificationNumber` are never returned.\n","properties":{"addressLine1":{"type":"string","description":"Registered business address, line 1.","maxLength":1024,"example":"8 Shenton Way","uniqueKey":"data.identity.business.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Registered business address, line 2 (optional).","maxLength":1024,"example":"Level 45","uniqueKey":"data.identity.business.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City.","maxLength":1024,"example":"Singapore","uniqueKey":"data.identity.business.city","typeLabel":"string"},"district":{"type":"string","description":"State / province / district.","maxLength":1024,"example":"Downtown Core","uniqueKey":"data.identity.business.district","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal / ZIP code.","maxLength":16,"example":68811,"uniqueKey":"data.identity.business.postalCode","typeLabel":"string"},"country":{"type":"string","description":"Country. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.","maxLength":2,"example":"SG","uniqueKey":"data.identity.business.country","typeLabel":"string"},"countryOfIncorporation":{"type":"string","description":"Country of incorporation. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.","maxLength":2,"example":"SG","uniqueKey":"data.identity.business.countryOfIncorporation","typeLabel":"string"}},"uniqueKey":"data.identity.business","typeLabel":"object"},"lei":{"type":"string","description":"Optional. Legal entity identifier (LEI). Unique global identifier for legal entities. Primarily relevant for French (CIRCLE_FR) entities.\n","example":"529900T8BM49AURSDO55","uniqueKey":"data.identity.lei","typeLabel":"string"}},"uniqueKey":"data.identity","typeLabel":"object"},"ownership":{"type":"object","description":"Ownership and custody of the wallet for Travel Rule and compliance.\n\nValidation errors can include codes such as `2025` (ownership missing), `2026` (VASP ID missing when required), `2027`–`2030`, `2035` (VASP ID not allowed when custody is `self_hosted`), and `2037` (ownership cannot be updated via PATCH).\n","properties":{"type":{"type":"string","description":"Whether the wallet is first-party or third-party.","enum":["first_party","third_party"],"uniqueKey":"data.ownership.type","typeLabel":"enum\u003cstring>"},"custody":{"type":"object","description":"Wallet custody details. When `type` is `hosted`, `vaspId` is required and must match an identifier returned by `GET /v1/addressBook/vasps`. When `type` is `self_hosted`, do not send `vaspId`.\n","properties":{"type":{"type":"string","description":"Whether the wallet is hosted by a Virtual Asset Service Provider (VASP) or self-hosted.","enum":["hosted","self_hosted"],"uniqueKey":"data.ownership.custody.type","typeLabel":"enum\u003cstring>"},"vaspId":{"type":"string","format":"uuid","description":"Identifier of the VASP that hosts the wallet. Required when `type` is `hosted`. Must not be set when `type` is `self_hosted`.","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"data.ownership.custody.vaspId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"data.ownership.custody","typeLabel":"object"}},"uniqueKey":"data.ownership","typeLabel":"object"},"createDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.createDate","typeLabel":"string"},"updateDate":{"type":"string","description":"ISO-8601 UTC date/time format.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.updateDate","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"GetAddressBookRecipientResponse · object"},"examples":{"response":{"title":"response","value":{"data":{"id":"b8627ae8-732b-4d25-b947-1df8f4007a29","chain":"ALGO","address":"0x8381470ED67C3802402dbbFa0058E8871F017A6F","addressTag":"123456789","metadata":{"nickname":"sample nickname","email":"satoshi@circle.com","bns":"sample.circle"},"status":"pending","identity":{"type":"individual","firstName":"Ada","lastName":"Lovelace"},"ownership":{"type":"first_party","custody":{"type":"hosted","vaspId":"550e8400-e29b-41d4-a716-446655440000"}},"createDate":"2020-04-10T02:13:30.000Z","updateDate":"2020-04-10T02:13:30.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"937197e0-aa46-4786-93cf-8dd95eac3d5e":{"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"},"4fc9f06f-52e0-43a7-8e81-ea635707ffd1":{"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":{"648fcf83-3043-4bb6-a281-a929929e18f1":{"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":"Get a recipient - Circle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T18:11:04.455Z","originalFileLocation":"api-reference/cpn/managed-payments/address-book/get-address-book-recipient.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=\"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 recipient - Circle Docs\">\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/cpn/managed-payments/address-book/get-address-book-recipient\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://circle-167b8d39.mintlify.app/_mintlify/api/og/v2?division=Address+book\u0026amp;title=Get+a+recipient\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=13e4f034808db2cec10523ca51daff8a3dfa53c3fa2c4afb193fccf652122d92\">\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 recipient - Circle Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://circle-167b8d39.mintlify.app/_mintlify/api/og/v2?division=Address+book\u0026amp;title=Get+a+recipient\u0026amp;theme=5260492f3b2b0d8ab3e7e4f3\u0026amp;signature=13e4f034808db2cec10523ca51daff8a3dfa53c3fa2c4afb193fccf652122d92\">\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/cpn/managed-payments/address-book/get-address-book-recipient\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cpn/managed-payments/address-book/get-address-book-recipient.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/cpn/managed-payments/address-book/get-address-book-recipient#webpage\",\"url\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient\",\"name\":\"Get a recipient\",\"dateModified\":\"2026-10-27T18:11:04.455Z\",\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Managed Payments\",\"item\":\"https://developers.circle.com/api-reference/cpn/managed-payments/accounts/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Stablecoin payouts\",\"item\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/list-address-book-recipients\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Address book\",\"item\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/list-address-book-recipients\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get a recipient\",\"item\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient#apireference\",\"headline\":\"Get a recipient\",\"name\":\"Get a recipient\",\"url\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient\",\"mainEntityOfPage\":{\"@id\":\"https://developers.circle.com/api-reference/cpn/managed-payments/address-book/get-address-book-recipient#webpage\"},\"dateModified\":\"2026-10-27T18:11:04.455Z\",\"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","href":"/api-reference/digital-asset-accounts"}]},{"anchor":"End User Onboarding","icon":"user-plus","pages":[{"title":"End User Onboarding","href":"/api-reference/end-user-onboarding"}]},{"anchor":"Mint and Custody","icon":"building-columns","pages":[{"title":"Mint and Custody","href":"/api-reference/circle-mint"}]},{"anchor":"Circle Payments Network","icon":"chart-network","pages":[{"title":"Circle Payments Network 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","description":"Creates an address book recipient. Required fields depend on your Circle entity; use the request body options that match your integration.\n\nFor Singapore (CIRCLE_SG) customers creating a self-hosted (`ownership.custody.type` = `self_hosted`) entry, `metadata.email` is required and the beneficiary PII object matching `identity.type` (`identity.individual` or `identity.business`) is required. The two PII objects are mutually exclusive. For non-regulated jurisdictions the PII objects are accepted if provided but not required.\n\nValidation failures can return error codes in the `2024`–`2038` range (for example `2024` when `identity` is required but missing, `2025` when `ownership` is required but missing, `2038` when `metadata.email` is missing for a self-hosted entry), as well as the PII-missing errors `ADDRESS_BOOK_INDIVIDUAL_PII_MISSING` and `ADDRESS_BOOK_BUSINESS_PII_MISSING`.\n","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","description":"Updates address book recipient metadata.","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 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","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"}]}]},"title":"Get a recipient - Circle Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}