List all Deposit Addresses across the organization. Spans every customer in the caller’s organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.
Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.
Filter by status. Omitting this parameter returns every status exceptclosed, which is terminal and permanent; pass status=closed to list closed Deposit Addresses. A closed Deposit Address is not deleted — it stays retrievable by id.
Lifecycle of a Deposit Address. pending: awaiting on-chain address assignment. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable, re-point destination to recover. closed: permanently disabled. failed: provisioning failed.
Opaque cursor pointing at the first item in this page. Present when data is non-empty, except on a list documented as forward only. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.
What a sender deposits and where. The asset and network are there from creation; the on-chain address is left out until the provider issues it. A provider that issues it during the create call returns it in the create response; otherwise the deposit address turns active once it is issued, and reading it returns the address from then on.
The on-chain address to send the inbound deposit to. Its provenance differs by provider: a provider that PROVISIONS assigns a fresh inlet address it owns and dedicates to this deposit address, while a provider that BINDS returns the address of a custodial wallet the customer already holds. Either way this is the address senders deposit to. Left out until the provider issues it, which the deposit address announces by turning active.
The rail payouts move on from now on. Once the public-name cutover has passed, the same value as the rail of a payout transfer sent after it; a transfer sent before keeps its older name.
ACH SEC code, only on ach and achSameDay. Derived from the destination owner's and the customer's entity type; left out while either is unknown. Never on a return.
Whose name a payout from this Deposit Address goes out under: the holder stored when it was created, or its provider's for an address created before holders were stored. Left out for a walletFiat destination or none.
Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.
The legal name the payment is sent under, resolved from accountHolder — the customer's own legal name for customer, the owning customer's legal name for partner (for now; a partner-level name may replace it later), or the payment provider's name for paymentProvider, which differs between a bank origin ("Coinme Inc FBO its Customers") and a blockchain origin. This is what the recipient sees as the sender. Like accountHolder and unlike id, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever accountHolder is, and when the customer's name cannot be read at that moment.
The return destination types this Deposit Address accepts, derived by OMS from its issuing provider and its depositInstructions.network with the same rules a returnDestination is validated against on create and PATCH. walletExternal is listed when the provider serves this network for the network's External Account family; walletCrypto is listed when the provider can return to an OMS wallet. Read-only. Left out when no return destination can be configured on this Deposit Address and when OMS could not determine it; the create and PATCH validation stays authoritative.
The type of a crypto return destination: an OMS wallet (walletCrypto) or a registered external wallet (walletExternal).
The institution that issues and custodies this Deposit Address — currently "Erebor Bank, N.A." or "Coinme Inc.". Assigned by OMS from your project's configuration. It determines which asset and network pairs you can create a deposit address for: an unsupported pair is rejected at create time with 422 depositAddressAssetNetworkNotSupported, which names the same provider in details.provider. Read it when you need to tell an end user or a support ticket which institution is holding the funds. It is not the name a payout is sent under, which is the payout transfer's originatorName and can name a different company. New providers may be added, so treat the string as free-form rather than a fixed set. Read-only; omitted when the issuing institution is not recognised.
Present, and true, when a sender's wallet must be registered as a walletExternal External Account under this Deposit Address's customer before it deposits. Derived from the issuing provider, never supplied by you: Deposit Addresses issued by Erebor Bank, N.A. accept a deposit only from a registered counterparty wallet, while those issued by Coinme Inc. accept a deposit from any crypto address and leave the field out. When true, a deposit from an unregistered address still arrives, but its transaction parks on a senderAttribution hold until you register a matching External Account (the hold's matchableExternalAccountCriteria says what will match) and fails at the hold's deadline if you never do — so capture the sender's address up front. Read it per Deposit Address rather than caching it per project. Read-only. Also left out when OMS cannot identify the issuing provider.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polygon Developer Docs","colors":{"primary":"#670DE5","light":"#9551F5","dark":"#500AB2"},"logo":{"light":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f","dark":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/dark.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=3b2b67f82ff1720328da11b176a86499"},"favicon":"https://mintcdn.com/polygon-labs/neKXk5towK-oBDip/favicon.png?fit=max\u0026auto=format\u0026n=neKXk5towK-oBDip\u0026q=85\u0026s=64034729f6d0b52274b3093da8c47b2c","api":{"openapi":"api-reference/openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive"},"mdx":{"server":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/resources/build-with-ai","label":"Build with AI"},{"href":"https://polygon.technology/get-access?utm_source=docs\u0026utm_medium=navbar\u0026utm_campaign=oms_access","label":"Request OMS Access"}]},"footer":{"socials":{"x":"https://x.com/0xPolygon","github":"https://github.com/0xPolygon","linkedin":"https://www.linkedin.com/company/polygonlabs","discord":"https://discord.com/invite/polygon-support-635865020172861441"},"links":[{"items":[{"label":"Support","href":"https://support.polygon.technology/support/home"}]}]},"fonts":{"family":"Fustat"},"integrations":{"ga4":{"measurementId":"G-RJ6JC0EEY5"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polygon-labs","hasAudioNarration":false,"actualSubdomain":"polygon-labs","customDomains":["docs.polygon.technology"],"gitSource":{"type":"github","owner":"0xpolygon","repo":"new-polygon-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"contextualFeedback":{"allowEmail":true},"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":"6aec90d88029e5fb8e3ea019","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Polygon Chain","count":385},{"language":"default","tag":"Wallets","count":174},{"language":"default","tag":"Developer Tools","count":94},{"language":"default","tag":"API Reference","count":86},{"language":"default","tag":"Agglayer","count":73},{"language":"default","tag":"Platform","count":71},{"language":"default","tag":"SDK","count":62},{"language":"default","tag":"Non-custodial","count":60},{"language":"default","tag":"Matic.js","count":59},{"language":"default","tag":"Guides","count":48}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@polygon.technology","showHelpButton":true}},"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":"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}],"starterQuestions":[{"_id":"69cbd3d67f226f107dbd9b72","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"Can I move assets between different chains with OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:58.134Z","updatedAt":"2026-03-31T14:01:58.134Z","__v":0},{"_id":"69cbd3b07f226f107dbd9a9b","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"What are my options for integrating a wallet?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:20.206Z","updatedAt":"2026-03-31T14:01:20.206Z","__v":0},{"_id":"69cbd3737f226f107dbd9910","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"How does KYC / KYB work in OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:00:19.974Z","updatedAt":"2026-03-31T14:00:19.974Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":".nav-tabs{gap:0!important;align-items:center!important}div:has(>.nav-tabs){height:58px!important}.nav-tabs a.nav-tabs-item{padding:7px 12px!important;font-size:14px;font-weight:500;color:#64708F!important;transition:color 120ms ease, background 120ms ease}.nav-tabs a.nav-tabs-item:hover{color:#141635!important}html.dark .nav-tabs a.nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .nav-tabs a.nav-tabs-item:hover{color:#fff!important}.fam-grp{display:inline-flex;align-items:center;gap:4px}.fam-gap{width:1px;height:22px;background:#DFE3F0;margin:0 16px;flex-shrink:0}.fam-grp .nav-tabs-item>div{display:none!important}.fam-grp .nav-tabs-item{padding:7px 12px!important;border-radius:8px;font-size:14px;font-weight:500;color:#64708F!important;white-space:nowrap;text-decoration:none;transition:color 120ms ease, background 120ms ease!important}.fam-grp .nav-tabs-item:hover{color:#141635!important}.fam-grp .nav-tabs-item.fam-active-tab{background:#EAE4F5!important;color:#500AB2!important;font-weight:500!important}.fam-grp .nav-tabs-item.fam-active-tab svg{color:#500AB2!important}html.dark .fam-gap{background:rgba(255, 255, 255, 0.14)}html.dark .fam-grp .nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .fam-grp .nav-tabs-item:hover{color:#fff!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab{background:rgba(103, 13, 229, 0.22)!important;color:#A78BFA!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab svg{color:#A78BFA!important}#navbar a[href*=\"build-with-ai\"]{background:#fff!important;color:#141635!important;border:1px solid #C8CFE1!important;font-weight:600!important;transition:border-color 140ms ease, background 140ms ease!important}#navbar a[href*=\"build-with-ai\"]:hover{border-color:#141635!important;background:#F6F6FC!important}html.dark #navbar a[href*=\"build-with-ai\"]{background:transparent!important;color:#fff!important;border-color:rgba(255, 255, 255, 0.25)!important}html.dark #navbar a[href*=\"build-with-ai\"]:hover{border-color:#fff!important;background:rgba(255, 255, 255, 0.06)!important}#navbar a[href*=\"get-access\"]{background:#0B0814!important;color:#fff!important;border:1px solid #0B0814!important;transition:background 140ms ease!important}#navbar a[href*=\"get-access\"]:hover{background:#2A2640!important}html.dark #navbar a[href*=\"get-access\"]{background:#FFFFFF!important;color:#0B0814!important;border-color:#FFFFFF!important}html.dark #navbar a[href*=\"get-access\"]:hover{background:#E5E7EB!important;border-color:#E5E7EB!important}#sidebar-content a.text-primary,#sidebar-content a[class*=\"text-primary-light\"]{background-color:transparent!important}#sidebar-content a:not(.text-primary):not([class*=\"text-primary-light\"]):hover{background-color:rgba(103, 13, 229, 0.06)!important}#content-area:has(.api-section) #page-title{font-size:1.75rem;line-height:2.25rem}#content-area:has(.api-section) #header .prose{font-size:0.9375rem;line-height:1.6}@container page-header (min-width: 520px){#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow{display:flex;align-items:center;min-height:2.25rem;padding-right:11rem}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div:has(#page-context-menu){position:static}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div #page-context-menu{position:absolute;top:0;right:0;margin:0}}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title{font-size:0}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title::after{content:\"Authorization and headers\";font-size:1.125rem}.api-section[data-api-section=\"authorizations\"]+.api-section[data-api-section=\"headers\"] .api-section-heading{display:none}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .primitive-param-field:last-child{border-bottom-width:1px}.api-section .api-section-heading .border-b,.api-section .primitive-param-field{border-color:#D1D5DB}html.dark .api-section .api-section-heading .border-b,html.dark .api-section .primitive-param-field{border-color:#374151}.api-section .primitive-param-field>.py-6{padding-top:0.875rem;padding-bottom:0.875rem}.api-section .primitive-param-field .mt-4{margin-top:0.5rem}@media (min-width: 1600px){#body-content:has(.api-section){max-width:1760px}#body-content:has(.api-section) #content-container{max-width:1440px}}"},{"filePath":"oms-visuals.css","content":"@font-face{font-family:\"Fustat\";src:url(\"/fonts/Fustat-VariableFont_wght.woff2\") format(\"woff2\");font-weight:200 900;font-style:normal;font-display:swap}@font-face{font-family:\"Geist Mono\";src:url(\"/fonts/GeistMono-VariableFont_wght.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}.oms-v{--oms-purple-50: #f6f3fb;--oms-purple-100: #eae4f5;--oms-purple-200: #d5c4f2;--oms-purple-300: #b78eef;--oms-purple-400: #9551f5;--oms-purple-500: #670de5;--oms-purple-600: #500ab2;--oms-purple-700: #400a8e;--oms-slate-50: #f6f6fc;--oms-slate-100: #eef0f9;--oms-slate-200: #dfe3f0;--oms-slate-300: #c8cfe1;--oms-slate-400: #929eba;--oms-slate-500: #64708f;--oms-slate-600: #48526f;--oms-slate-700: #363e5c;--oms-slate-800: #222744;--oms-slate-900: #141635;--oms-slate-950: #090624;--oms-btn-primary: #090624;--oms-btn-primary-hover: #222744;--oms-btn-primary-text: #ffffff;--ss-font: \"Fustat\", \"Inter\", system-ui, sans-serif;--ss-mono: \"Geist Mono\", \"JetBrains Mono\", ui-monospace, monospace;--ss-accent: #670de5;--ss-accent-2: #9551f5;--ss-accent-soft: #eae4f5;--ss-accent-text: #500ab2;--ss-canvas: #f6f6fc;--ss-well: #f6f6fc;--ss-surface: #ffffff;--ss-raised: #ffffff;--ss-chrome: #ffffff;--ss-fill: #eef0f9;--ss-line: #c8cfe1;--ss-line-faint: #dfe3f0;--ss-text-strong: #141635;--ss-text: #48526f;--ss-text-faint: #64708f;--ss-icon: #48526f;--ss-icon-faint: #929eba;--ss-ink-1: rgba(20, 22, 53, 0.04);--ss-ink-2: rgba(20, 22, 53, 0.06);--ss-ink-3: rgba(20, 22, 53, 0.08);--ss-ink-4: rgba(20, 22, 53, 0.10);--ss-ink-5: rgba(20, 22, 53, 0.15);--ss-success: #10b981;--ss-success-soft: #ecfdf5;--ss-success-text: #047857;--ss-warning: #b45309;--ss-warning-soft: #fff7ed;--ss-warning-text: #b45309;--ss-danger: #dc2626;--ss-danger-soft: #fef2f2;--ss-danger-text: #b91c1c;--ss-radius-sm: 6px;--ss-radius-md: 8px;--ss-radius-lg: 12px;--ss-radius-window: 12px;--ss-radius-pill: 999px;--ss-shadow-window: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 4px 16px rgba(0, 0, 0, 0.08);--ss-shadow-float: 0px 4px 6px -4px rgba(0, 0, 0, 0.1), 0px 10px 15px -3px rgba(0, 0, 0, 0.1);--ss-shadow-card: 0 1px 2px rgba(0, 0, 0, 0.04);--ss-shadow-hero: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 30px 60px -12px rgba(50, 50, 93, 0.25), 0 18px 36px -18px rgba(0, 0, 0, 0.3);--ss-shadow-lift: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 12px 28px -6px rgba(50, 50, 93, 0.28), 0 6px 12px -6px rgba(0, 0, 0, 0.16);--ss-shadow-satellite: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 14px 32px -8px rgba(50, 50, 93, 0.24), 0 4px 10px -4px rgba(0, 0, 0, 0.1);--ss-shadow-ground: 0 0 0 1px rgba(50, 50, 93, 0.06), 0 24px 48px -24px rgba(50, 50, 93, 0.18);--ss-ease: cubic-bezier(0.16, 1, 0.3, 1);font-family:var(--ss-font);color:var(--ss-text);-webkit-font-smoothing:antialiased}html.dark .oms-v{--oms-btn-primary: #ffffff;--oms-btn-primary-hover: #e5e7eb;--oms-btn-primary-text: #090624;--ss-accent: #9551f5;--ss-accent-2: #b78eef;--ss-accent-soft: rgba(149, 81, 245, 0.16);--ss-accent-text: #b78eef;--ss-canvas: #0b0a10;--ss-well: #131218;--ss-surface: #1a1922;--ss-raised: #23212d;--ss-chrome: #16151d;--ss-fill: #2a2834;--ss-line: rgba(255, 255, 255, 0.10);--ss-line-faint: rgba(255, 255, 255, 0.06);--ss-text-strong: #eef0f9;--ss-text: #c8cfe1;--ss-text-faint: #929eba;--ss-icon: #c8cfe1;--ss-icon-faint: #64708f;--ss-ink-1: rgba(255, 255, 255, 0.05);--ss-ink-2: rgba(255, 255, 255, 0.07);--ss-ink-3: rgba(255, 255, 255, 0.10);--ss-ink-4: rgba(255, 255, 255, 0.13);--ss-ink-5: rgba(255, 255, 255, 0.20);--ss-success: #34d399;--ss-success-soft: rgba(16, 185, 129, 0.16);--ss-success-text: #34d399;--ss-shadow-window: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 4px 16px rgba(0, 0, 0, 0.4);--ss-shadow-float: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 4px 16px rgba(0, 0, 0, 0.4), 0 12px 32px rgba(0, 0, 0, 0.3);--ss-shadow-card: 0 0 0 1px rgba(255, 255, 255, 0.05);--ss-shadow-hero: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 30px 60px -12px rgba(0, 0, 0, 0.6);--ss-shadow-lift: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 12px 28px -6px rgba(0, 0, 0, 0.6);--ss-shadow-satellite: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 14px 32px -8px rgba(0, 0, 0, 0.7), 0 4px 10px -4px rgba(0, 0, 0, 0.5);--ss-shadow-ground: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 24px 48px -24px rgba(0, 0, 0, 0.6)}.oms-v-fit{position:relative;width:100%}.oms-v-stage{position:absolute;top:0;left:0;transform-origin:0 0;overflow:hidden}.oms-v *,.oms-v *::before,.oms-v *::after{box-sizing:border-box}.oms-v :where(h1,h2,h3,h4,p,ul,ol){margin:0}.oms-v .oms-badge{display:inline-flex;align-items:center;justify-content:center;gap:4px;padding:4px 8px;border-radius:16px;border:0.5px solid transparent;font-family:var(--ss-font);font-weight:500;font-size:12px;line-height:1;white-space:nowrap;text-box:trim-both cap alphabetic}.oms-v .oms-badge--info{background:#f6f3fb;border-color:#d5c4f2;color:#500ab2}.oms-v .oms-badge--neutral{background:#f6f6fc;border-color:#c8cfe1;color:#141635}.oms-v .oms-badge--success{background:#ecfdf5;border-color:#a7f3d0;color:#047857}.oms-v .oms-badge--warning{background:#fff7ed;border-color:#fed7aa;color:#b45309}.oms-v .oms-badge--danger{background:#fef2f2;border-color:#fecaca;color:#b91c1c}html.dark .oms-v .oms-badge--info{background:rgba(149, 81, 245, 0.14);border-color:rgba(183, 142, 239, 0.35);color:#c9b0f5}html.dark .oms-v .oms-badge--neutral{background:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.14);color:#c8cfe1}html.dark .oms-v .oms-badge--success{background:rgba(16, 185, 129, 0.14);border-color:rgba(52, 211, 153, 0.35);color:#6ee7b7}html.dark .oms-v .oms-badge--warning{background:rgba(251, 191, 36, 0.12);border-color:rgba(251, 191, 36, 0.3);color:#fcd34d}html.dark .oms-v .oms-badge--danger{background:rgba(248, 113, 113, 0.12);border-color:rgba(248, 113, 113, 0.3);color:#fca5a5}.oms-v .oms-phone{position:relative;flex-shrink:0;--oms-phone-glass: #0b0b0c;--oms-phone-rim: #2c2c2d;--oms-phone-band-1: #e3e3e6;--oms-phone-band-2: #9a9ba0;--oms-phone-band-3: #cfd0d4;--oms-phone-band-4: #85868b;--oms-phone-band-5: #c9cacd;box-shadow:0 calc(var(--ps) * 40) calc(var(--ps) * 80) calc(var(--ps) * -16) rgba(50, 50, 93, 0.25),\n 0 calc(var(--ps) * 24) calc(var(--ps) * 48) calc(var(--ps) * -24) rgba(0, 0, 0, 0.3)}html.dark .oms-v .oms-phone{--oms-phone-band-1: #5b5c61;--oms-phone-band-2: #2b2c2f;--oms-phone-band-3: #48494d;--oms-phone-band-4: #232427;--oms-phone-band-5: #404145}.oms-v .oms-phone__bands{position:absolute;inset:0;overflow:visible;pointer-events:none}.oms-v .oms-phone__glass{position:relative;height:100%}.oms-v .oms-phone__window{position:relative;overflow:hidden;isolation:isolate}.oms-v .oms-phone__screen{position:absolute;top:0;left:0;width:402px;height:874px;display:flex;flex-direction:column;overflow:hidden;background:#fff;color:#000;font-family:-apple-system, system-ui, sans-serif;font-size:15px;letter-spacing:-0.015em;transform-origin:0 0;-webkit-font-smoothing:antialiased}.oms-v .oms-phone[data-dark] .oms-phone__screen{background:#000;color:#fff}.oms-v .oms-phone__status{position:absolute;top:0;right:0;left:0;z-index:2;height:62px;transition:color 0.3s ease;will-change:transform}.oms-v .oms-phone__time{position:absolute;top:21.5px;left:0;width:138.5px;line-height:22px;text-align:center;font-family:\"SF Pro Text\", -apple-system, system-ui, sans-serif;font-variation-settings:\"opsz\" 17;font-size:17.67px;font-weight:590;letter-spacing:0}.oms-v .oms-phone__glyphs{position:absolute;top:25.33px;left:285.25px;display:flex;align-items:flex-start;gap:8px}.oms-v .oms-phone__glyphs svg{display:block}.oms-v .oms-phone__signal{margin-top:1px}.oms-v .oms-phone__battery{margin-top:0.33px}.oms-v .oms-phone__island{position:absolute;top:14px;left:50%;z-index:3;width:95px;height:37px;border-radius:18.5px;background:#000;transform:translateX(-50%)}.oms-v .oms-phone__content{position:relative;flex:1;min-height:0;padding-top:62px}.oms-v .oms-phone__home{position:absolute;bottom:8px;left:50%;z-index:2;width:144px;height:5px;border-radius:2.5px;background:currentColor;transform:translateX(-50%);transition:color 0.3s ease;will-change:transform}.obz{overflow:hidden;border-radius:14px;background:linear-gradient(110deg, rgba(255, 255, 255, 0.18) 0%, transparent 22%, transparent 32%, rgba(255, 255, 255, 0.1) 44%, transparent 60%),\n linear-gradient(135deg, var(--obz-from) 0%, var(--obz-to) 100%);--obz-ink: var(--ss-text-strong);--obz-faint: var(--oms-slate-500);--obz-app: var(--oms-slate-50);--obz-card: #fff;--obz-rule: var(--oms-slate-200)}.obz--payouts{--obz-from: #7c3aed;--obz-to: #3b0764}.obz--rewards{--obz-from: #10b981;--obz-to: #064e3b}html.dark .obz{--obz-faint: var(--oms-slate-400);--obz-app: #0b0a10;--obz-card: #1a1922;--obz-rule: rgba(255, 255, 255, 0.08)}.obz .obz-phone{position:absolute;top:30px;left:30px}.obz .obz-app{position:absolute;inset:0;padding-top:62px;background:var(--obz-app);color:var(--obz-ink);text-align:left;font-family:var(--ss-font)}.obz .obz-btn .obz-states,.obz .obz-status,.obz .obz-big--count{transition:opacity 0.38s ease}.obz .obz-app[data-fade] :is(.obz-btn .obz-states,.obz-status,.obz-big--count){opacity:0}.obz .obz-title{transition:opacity 0.2s ease}.obz .obz-app[data-notif] .obz-title{opacity:0}.obz .obz-head{display:flex;align-items:baseline;justify-content:space-between;padding:8px 36px 14px}.obz--payouts .obz-head{padding-bottom:10px}.obz--rewards .obz-head{padding-bottom:34px}.obz .obz-title{font-size:32px;font-weight:700;line-height:38px;letter-spacing:-0.02em;color:var(--obz-ink)}.obz .obz-head__meta{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-card{display:block;margin:0 16px 12px;border-radius:22px;background:var(--obz-card);box-shadow:0 0 0 0.5px var(--obz-rule)}.obz .obz-batch,.obz .obz-balance{display:grid;justify-items:start;padding:18px 20px 20px}.obz--payouts .obz-batch{padding-bottom:16px}.obz .obz-label{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-big{margin-top:2px;font-size:50px;font-weight:700;line-height:58px;letter-spacing:-0.03em;color:var(--obz-ink)}.obz .obz-big--count{margin:4px 0 2px;font-size:60px;line-height:68px}.obz .obz-count{display:inline-flex;align-items:baseline;white-space:nowrap;font-variant-numeric:tabular-nums}.obz .obz-count__char{display:inline-block;font-variant-numeric:normal}.obz .obz-count__digit{display:inline-block;height:1em;overflow:hidden;line-height:1;vertical-align:baseline;mask-image:linear-gradient(to bottom, transparent, #000 8%, #000 92%, transparent)}.obz .obz-count__strip{display:flex;flex-direction:column;will-change:transform;transition:transform 900ms cubic-bezier(0.3, 0.75, 0.1, 1)}.obz .obz-count__strip>span{display:block;height:1em;line-height:1}.obz .obz-count__unit{display:inline-block;margin-left:8px;font-size:22px;font-weight:600;letter-spacing:0;color:var(--obz-faint)}.obz .obz-btn{position:relative;isolation:isolate;display:grid;place-items:center;justify-self:stretch;height:58px;margin-top:14px;border-radius:16px;color:var(--oms-btn-primary-text);font-size:20px;font-weight:600}.obz .obz-btn::before{content:\"\";position:absolute;inset:0;z-index:-1;border-radius:inherit;background:var(--oms-btn-primary);transition:transform 0.15s ease, background-color 0.2s ease}.obz .obz-btn[data-pressed]::before{transform:scale(0.97);background:var(--oms-btn-primary-hover)}.obz .obz-btn__group{display:inline-flex;align-items:center;justify-content:center;gap:8px;width:180px;height:26px}.obz .obz-btn__group--icon{justify-content:flex-start;padding-left:44px}.obz .obz-btn__group svg{flex:none}.obz .obz-spin{animation:obz-spin 0.8s linear infinite}@keyframes obz-spin{to{transform:rotate(360deg)}}.obz .obz-touch{position:absolute;left:50%;top:50%;width:44px;height:44px;margin:-22px 0 0 -22px;border-radius:50%;background:rgba(255, 255, 255, 0.35);box-shadow:0 0 0 1.5px rgba(255, 255, 255, 0.55);opacity:0;transform:scale(0.6);transition:opacity 0.3s ease, transform 0.3s ease;pointer-events:none}.obz .obz-touch[data-on]{opacity:1;transform:scale(1);transition:opacity 0.08s ease, transform 0.12s ease}.obz .obz-states{display:inline-grid;align-items:center;justify-items:center}.obz .obz-states__item{display:inline-flex;grid-area:1 / 1;align-items:center;opacity:0;filter:blur(2px);will-change:transform;transform:translate3d(0, 4px, 0);transition:opacity 0.15s ease, filter 0.15s ease, transform 0s 0.15s}.obz .obz-states__item[data-on]{opacity:1;filter:none;transform:translate3d(0, 0, 0);transition:opacity 0.25s ease-out 0.07s, filter 0.25s ease-out 0.07s, transform 0.3s cubic-bezier(0.22, 1, 0.36, 1) 0.07s}.obz .obz-status{display:inline-grid;justify-items:end;margin-right:10px;flex:none}.obz--payouts .obz-status{margin-right:6px}.obz--rewards .obz-status{width:96px}.obz .obz-list{padding:4px 0}.obz .obz-row{display:flex;align-items:center;gap:14px;padding:14px;will-change:transform}.obz .obz-list>.obz-row+.obz-row,.obz .obz-list>.obz-collapse+.obz-row{box-shadow:0 -0.5px 0 var(--obz-rule)}.obz .obz-row__body{display:flex;flex-direction:column;gap:2px;flex:1;min-width:0}.obz .obz-row__title{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:21px;font-weight:600;line-height:28px;color:var(--obz-ink)}.obz .obz-row__sub{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:19px;line-height:28px;color:var(--ss-text)}.obz--payouts .obz-row__sub{font-size:18px}.obz .obz-bar{display:block;border-radius:5px;background:var(--ss-ink-3)}.obz .obz-bar--title{height:11px;margin:8.5px 0;background:var(--ss-ink-4)}.obz .obz-bar--sub{height:9px;margin:9.5px 0}.obz .obz-avatar{display:inline-grid;flex:none;place-items:center;width:48px;height:48px;border-radius:50%;color:#fff;font-size:20px;font-weight:600;line-height:1;will-change:transform}.obz .obz-avatar>span{display:block;text-box:trim-both cap alphabetic}.obz .obz-avatar--plain{background:var(--ss-fill)}.obz .obz-tile{display:grid;flex:none;place-items:center;width:48px;height:48px;border-radius:14px;background:var(--ss-success-soft);color:var(--ss-success-text)}.obz .obz-tile--plain{background:var(--ss-ink-1)}html.dark .obz .obz-tile{background:rgba(16, 185, 129, 0.14);color:#34d399}html.dark .obz .obz-tile--plain{background:rgba(255, 255, 255, 0.06)}.obz .oms-badge.obz-badge{padding:5px 12px;border-radius:16px;font-size:19px;line-height:22px}.obz .obz-collapse{display:grid;grid-template-rows:0fr;opacity:0;transition:grid-template-rows 0.42s cubic-bezier(0.4, 0, 0.2, 1) 0.05s, opacity 0.42s cubic-bezier(0, 0.8, 0.5, 1)}.obz .obz-collapse[data-open]{grid-template-rows:1fr;opacity:1;transition:grid-template-rows 0.5s cubic-bezier(0.45, 0, 0.2, 1), opacity 0.3s ease 0.24s}.obz .obz-collapse__inner{min-height:0;overflow:visible}.obz .obz-collapse__inner>*{transform:translateY(-10px);transition:transform 0.3s ease}.obz .obz-collapse[data-open]>.obz-collapse__inner>*{transform:none;transition:transform 0.6s cubic-bezier(0.22, 1, 0.36, 1) 0.2s}.obz .obz-banner{position:absolute;inset:0;z-index:2;pointer-events:none;will-change:transform;transform:translateY(-52px) scale(0.96);opacity:0;transition:transform 0.45s cubic-bezier(0.4, 0, 0.6, 1), opacity 0.3s ease 0.1s}.obz .obz-banner[data-show]{transform:none;opacity:1;transition:transform 0.55s cubic-bezier(0.2, 0.9, 0.25, 1), opacity 0.2s ease}.obz .obz-notif{position:absolute;top:56px;left:18px;right:18px;display:flex;align-items:center;gap:13px;padding:14px 17px 14px 14px;border-radius:23px;background:rgba(255, 255, 255, 0.92);box-shadow:0 0 0 0.5px rgba(0, 0, 0, 0.08), 0 8px 24px rgba(0, 0, 0, 0.12);color:#000;text-align:left;will-change:transform}.obz .obz-banner[data-dark] .obz-notif{background:rgba(252, 252, 253, 0.76);backdrop-filter:blur(30px) saturate(1.25);box-shadow:0 4px 24px rgba(0, 0, 0, 0.06)}.obz .obz-notif__icon{display:grid;flex:none;place-items:center;width:38px;height:38px;border-radius:9px;overflow:hidden;background:linear-gradient(160deg, #10b981, #047857);color:#fff}.obz .obz-notif__text{display:flex;flex:1;flex-direction:column;min-width:0;font-size:15px;line-height:18px;letter-spacing:-0.016em}.obz .obz-notif__head{display:flex;align-items:baseline;gap:8px}.obz .obz-notif__title{flex:1;min-width:0;overflow:hidden;font-weight:600;white-space:nowrap;text-overflow:ellipsis}.obz .obz-notif__time{flex:none;font-size:12px;letter-spacing:-0.005em;color:rgba(60, 60, 67, 0.6)}.obz .obz-notif__body{display:-webkit-box;overflow:hidden;-webkit-line-clamp:3;-webkit-box-orient:vertical}@media (prefers-reduced-motion: reduce){.obz .obz-spin{animation:none}}"}],"page":{"pagePath":"api-reference/depositaddress/list-all-deposit-addresses","slug":"/api-reference/depositaddress/list-all-deposit-addresses","pageMetadata":{"title":"List all Deposit Addresses","description":"List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. `closed` Deposit Addresses are omitted unless you ask for them explicitly with `status=closed`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses","href":"/api-reference/depositaddress/list-all-deposit-addresses","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"List all Deposit Addresses across the organization. Spans every customer in the caller’s organization; optionally filter by status and/or customer. \", _jsx(_components.code, {\n children: \"closed\"\n }), \" Deposit Addresses are omitted unless you ask for them explicitly with \", _jsx(_components.code, {\n children: \"status=closed\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List all Deposit Addresses","description":"List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. `closed` Deposit Addresses are omitted unless you ask for them explicitly with `status=closed`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses","href":"/api-reference/depositaddress/list-all-deposit-addresses","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/polygon-labs/3aef159c73509324/analytics.js","/_mintlify/custom/polygon-labs/3af50e0aa9bbe82e/custom.js"],"openApiReferenceData":{"operation":{"operationId":"listDepositAddresses","summary":"List all Deposit Addresses","description":"List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. `closed` Deposit Addresses are omitted unless you ask for them explicitly with `status=closed`.","parameters":["f5b50fcd-71a1-48f7-a788-ce27cee4bb44","3e544111-289c-4c0c-86a9-47e1b83a1c25","e5df43ae-a76e-4f4c-b232-35beda1040c3","def4877e-fe9a-4d21-91a9-574e6f3af8e5","bf9c3de5-7781-4b6c-9819-9e106e1c654f"],"responses":{"200":"5d9d65de-b351-49dd-a50f-e0401c4583a3","400":"01360b2d-ee00-42f1-8178-d71614fd896a","500":"9c7a8633-8a3f-4957-8d53-d01d9398b732"},"tags":["DepositAddress"],"method":"get","type":"path","servers":["dc14c13e-4f51-41d3-bf07-1fa9c8a1b005","4cc92329-3167-465b-aed7-0cd9c63f6ad7"],"security":["0057ef24-3c5e-4b52-a4d9-5c894a9b4f5e"],"path":"/deposit-addresses","baseUrlOptions":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"],"title":"List all Deposit Addresses","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f5b50fcd-71a1-48f7-a788-ce27cee4bb44":{"name":"limit","in":"query","required":false,"description":"Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the `x-minimum`/`x-maximum` OpenAPI extensions below — deliberately NOT via `@minValue`/`@maxValue`, which emit JSON-Schema `minimum`/`maximum` and make the generated SDK (Zod) reject values the server accepts and clamps. See `PaginatedList.limit` for the effective value applied.","schema":{"type":"integer","format":"int32","isRequired":false,"description":"Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the `x-minimum`/`x-maximum` OpenAPI extensions below — deliberately NOT via `@minValue`/`@maxValue`, which emit JSON-Schema `minimum`/`maximum` and make the generated SDK (Zod) reject values the server accepts and clamps. See `PaginatedList.limit` for the effective value applied.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"x-maximum":100,"x-minimum":1},"3e544111-289c-4c0c-86a9-47e1b83a1c25":{"name":"startingAfter","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"e5df43ae-a76e-4f4c-b232-35beda1040c3":{"name":"endingBefore","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"def4877e-fe9a-4d21-91a9-574e6f3af8e5":{"name":"status","in":"query","required":false,"description":"Filter by status. Omitting this parameter returns every status **except** `closed`, which is terminal and permanent; pass `status=closed` to list closed Deposit Addresses. A closed Deposit Address is not deleted — it stays retrievable by id.","schema":{"type":"string","enum":["pending","active","frozen","closed","failed","inactiveActionRequired"],"description":"Filter by status. Omitting this parameter returns every status **except** `closed`, which is terminal and permanent; pass `status=closed` to list closed Deposit Addresses. A closed Deposit Address is not deleted — it stays retrievable by id.\nLifecycle of a Deposit Address. pending: awaiting on-chain address assignment. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable, re-point `destination` to recover. closed: permanently disabled. failed: provisioning failed.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"bf9c3de5-7781-4b6c-9819-9e106e1c654f":{"name":"customerId","in":"query","required":false,"description":"Filter to a single customer (`cst_` prefix).","schema":{"type":"string","isRequired":false,"description":"Filter to a single customer (`cst_` prefix).","uniqueKey":"","typeLabel":"string"}}},"responses":{"5d9d65de-b351-49dd-a50f-e0401c4583a3":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","description":"Resource type discriminator.","uniqueKey":"object","typeLabel":"string"},"limit":{"type":"integer","format":"int32","description":"The effective page size applied to this response, after clamping an out-of-range or unset requested `limit` into the supported bound.","uniqueKey":"limit","typeLabel":"integer\u003cint32>"},"hasMore":{"type":"boolean","description":"True when more rows exist beyond this page in the direction of travel (forward by default, backward when `endingBefore` was supplied).","uniqueKey":"hasMore","typeLabel":"boolean"},"nextCursor":{"type":"string","description":"Opaque cursor for the next page. Present when another page can be requested; pass it as `startingAfter`. `hasMore=false` signals no more pages forward.","uniqueKey":"nextCursor","typeLabel":"string"},"previousCursor":{"type":"string","description":"Opaque cursor pointing at the first item in this page. Present when `data` is non-empty, except on a list documented as forward only. Pass as `endingBefore` to page backward; when this yields an empty response the client is at the start of the list.","uniqueKey":"previousCursor","typeLabel":"string"},"data":{"type":"array","items":{"type":"object","required":["customer"],"properties":{"customer":{"type":"object","description":"The customer that owns this record.","required":["id"],"properties":{"id":{"type":"string","description":"The customer id (`cst_` prefix).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].customer","typeLabel":"object"},"id":{"type":"string","description":"Deposit Address ID (`da_` prefix).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"status":{"type":"string","description":"Current lifecycle status of the deposit address.","enum":["pending","active","frozen","closed","failed","inactiveActionRequired"],"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"depositInstructions":{"type":"object","description":"What a sender deposits and where. The asset and network are there from creation; the on-chain `address` is left out until the provider issues it. A provider that issues it during the create call returns it in the create response; otherwise the deposit address turns `active` once it is issued, and reading it returns the address from then on.","required":["asset","network"],"properties":{"asset":{"type":"string","description":"The asset the deposit address accepts, the `expectedSourceAsset` it was created with.","isRequired":true,"uniqueKey":"data.items.[INDEX].depositInstructions.asset","typeLabel":"string"},"network":{"type":"string","description":"The network the deposit address accepts, the `expectedSourceNetwork` it was created with.","enum":["ethereum","polygon","base","solana","tron","bnb"],"isRequired":true,"uniqueKey":"data.items.[INDEX].depositInstructions.network","typeLabel":"enum\u003cstring>"},"address":{"type":"string","description":"The on-chain address to send the inbound deposit to. Its provenance differs by provider: a provider that PROVISIONS assigns a fresh inlet address it owns and dedicates to this deposit address, while a provider that BINDS returns the address of a custodial wallet the customer already holds. Either way this is the address senders deposit to. Left out until the provider issues it, which the deposit address announces by turning `active`.","uniqueKey":"data.items.[INDEX].depositInstructions.address","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].depositInstructions","typeLabel":"object"},"destination":{"oneOf":[{"type":"object","title":"OMS wallet","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"data.items.[INDEX].destination.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"data.items.[INDEX].destination.oneOf.0.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"data.items.[INDEX].destination.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.1","typeLabel":"External wallet · object"},{"type":"object","title":"Fiat wallet","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["walletFiat"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.2.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Fiat currency of the balance. Only `usd` today.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.2.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^(wlt_fiat_|[a-z]+_)([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"The fiat wallet (`wlt_`; an older wallet keeps its original `wlt_\u003cuuid>` id, and a `wlt_fiat_` id is also accepted on input). Left out on a book-transfer destination until its outbound leg exists.","uniqueKey":"data.items.[INDEX].destination.oneOf.2.id","typeLabel":"string"},"network":{"type":"string","enum":["bookTransfer","intraBank"],"description":"On the destination of a virtual account or deposit address book-transfer credit: `intraBank`, or `bookTransfer` on a record created before the umbrella names were introduced.","uniqueKey":"data.items.[INDEX].destination.oneOf.2.network","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `network` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"data.items.[INDEX].destination.oneOf.2.intraBankRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.2.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.2.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.2.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.2.owner","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.2","typeLabel":"Fiat wallet · object"},{"type":"object","title":"US bank account","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankUs"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.3.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.3.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.3.id","typeLabel":"string"},"instantRail":{"type":"string","description":"Only when `network` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"data.items.[INDEX].destination.oneOf.3.instantRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.3.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.3.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.routingNumber","typeLabel":"string"},"accountType":{"type":"string","enum":["checking","savings"],"description":"Bank account sub-type for US accounts.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.accountType","typeLabel":"enum\u003cstring>"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details.memo","typeLabel":"string"}},"description":"US bank account details.","uniqueKey":"data.items.[INDEX].destination.oneOf.3.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.3","typeLabel":"US bank account · object"},{"type":"object","title":"IBAN bank account","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankIban"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.4.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.4.asset","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.4.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.4.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.4.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankName","typeLabel":"string"},"ibanLast4":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.ibanLast4","typeLabel":"string"},"bic":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bic","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the bank.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.countryCode","typeLabel":"string"},"bankAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.bankAddress","typeLabel":"object"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details.memo","typeLabel":"string"}},"description":"IBAN bank account details.","uniqueKey":"data.items.[INDEX].destination.oneOf.4.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.4","typeLabel":"IBAN bank account · object"},{"type":"object","title":"Canadian bank account","description":"The account deposits are paid out to. A bank account carries no rail and no ACH options; they are on `payout`.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankCanada"],"isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.5.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd","cad"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.5.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.5.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.5.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].destination.oneOf.5.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].destination.oneOf.5.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].destination.oneOf.5.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.accountNumberLast4","typeLabel":"string"},"institutionNumber":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.institutionNumber","typeLabel":"string"},"transitNumber":{"type":"string","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.transitNumber","typeLabel":"string"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details.memo","typeLabel":"string"}},"description":"Canadian bank account details.","uniqueKey":"data.items.[INDEX].destination.oneOf.5.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].destination.oneOf.5","typeLabel":"Canadian bank account · object"}],"uniqueKey":"data.items.[INDEX].destination","typeLabel":"OMS wallet · object | External wallet · object | Fiat wallet · object | US bank account · object | IBAN bank account · object | Canadian bank account · object"},"payout":{"type":"object","description":"How a deposit is paid out to a bank or `walletFiat` `destination`: the rail and, on `ach` and `achSameDay`, the ACH options. Left out for a crypto destination.","required":["rail"],"properties":{"rail":{"type":"string","description":"The rail payouts move on from now on. Once the public-name cutover has passed, the same value as the `rail` of a payout transfer sent after it; a transfer sent before keeps its older name.","enum":["ach","achSameDay","wire","internationalWire","rtp","bookTransfer","instant","intraBank","blockchain","card","cash"],"isRequired":true,"uniqueKey":"data.items.[INDEX].payout.rail","typeLabel":"enum\u003cstring>"},"instantRail":{"type":"string","description":"Only when `rail` is `instant`, the same value as the payout transfer's `instantRail`.","enum":["rtp","fednow"],"uniqueKey":"data.items.[INDEX].payout.instantRail","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `rail` is `intraBank`, the same value as the payout transfer's `intraBankRail`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"data.items.[INDEX].payout.intraBankRail","typeLabel":"enum\u003cstring>"},"secCode":{"type":"string","description":"ACH SEC code, only on `ach` and `achSameDay`. Derived from the destination owner's and the customer's entity type; left out while either is unknown. Never on a return.","enum":["ccd","ppd","web"],"uniqueKey":"data.items.[INDEX].payout.secCode","typeLabel":"enum\u003cstring>"},"companyDiscretionaryData":{"type":"string","description":"The ACH company discretionary data sent with each payout, only on `ach` and `achSameDay` and only when you set it. Never on a return.","uniqueKey":"data.items.[INDEX].payout.companyDiscretionaryData","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].payout","typeLabel":"object"},"payoutOrigin":{"type":"object","description":"Whose name a payout from this Deposit Address goes out under: the holder stored when it was created, or its provider's for an address created before holders were stored. Left out for a `walletFiat` destination or none.","required":["type"],"properties":{"type":{"type":"string","enum":["bank","blockchain"],"isRequired":true,"uniqueKey":"data.items.[INDEX].payoutOrigin.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`.","x-go-type":"string","uniqueKey":"data.items.[INDEX].payoutOrigin.id","typeLabel":"string"},"accountHolder":{"type":"string","description":"Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.","enum":["customer","paymentProvider","partner"],"uniqueKey":"data.items.[INDEX].payoutOrigin.accountHolder","typeLabel":"enum\u003cstring>"},"accountHolderName":{"type":"string","description":"The legal name the payment is sent under, resolved from `accountHolder` — the customer's own legal name for `customer`, the owning customer's legal name for `partner` (for now; a partner-level name may replace it later), or the payment provider's name for `paymentProvider`, which differs between a `bank` origin (\"Coinme Inc FBO its Customers\") and a `blockchain` origin. This is what the recipient sees as the sender. Like `accountHolder` and unlike `id`, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever `accountHolder` is, and when the customer's name cannot be read at that moment.","uniqueKey":"data.items.[INDEX].payoutOrigin.accountHolderName","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].payoutOrigin","typeLabel":"object"},"returnDestination":{"oneOf":[{"type":"object","title":"OMS wallet","description":"Where inbound crypto is sent back when its payout cannot be completed. Present only when you set one.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"Where inbound crypto is sent back when its payout cannot be completed. Present only when you set one.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","pattern":"^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","x-go-type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].returnDestination.oneOf.1","typeLabel":"External wallet · object"}],"uniqueKey":"data.items.[INDEX].returnDestination","typeLabel":"OMS wallet · object | External wallet · object"},"returnDestinationTypes":{"type":"array","items":{"type":"string","enum":["walletCrypto","walletExternal"],"description":"The type of a crypto return destination: an OMS wallet (`walletCrypto`) or a registered external wallet (`walletExternal`).","uniqueKey":"data.items.[INDEX].returnDestinationTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The return destination types this Deposit Address accepts, derived by OMS from its issuing `provider` and its `depositInstructions.network` with the same rules a `returnDestination` is validated against on create and PATCH. `walletExternal` is listed when the provider serves this network for the network's External Account family; `walletCrypto` is listed when the provider can return to an OMS wallet. Read-only. Left out when no return destination can be configured on this Deposit Address and when OMS could not determine it; the create and PATCH validation stays authoritative.","uniqueKey":"data.items.[INDEX].returnDestinationTypes","typeLabel":"enum\u003cstring>[]"},"failure":{"type":"object","description":"Why the deposit address failed. Present only when `status` is `failed`.","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"What went wrong.","enum":["providerError","providerRejected","providerTimeout","expired","systemError","provisioningTimeout","insufficientFunds","providerAmountBelowMinimum","limitExceeded","outsideSellBounds","outsideSellVelocityBounds","unusableAmount","unsupportedCorridor","outgoingRailNotEnabled","ssnNotVerified","riskRejected","cardDeclined","bankSellDeclined","payoutFailed","priceMoved","returningToSender","returnedToSender","returnFailed","depositFailed","attributionTimeout","assetMismatch","chainMismatch","misattributedArrival","depositAddressNotActive","virtualAccountNotActive","counterpartyArchived","destinationUnavailable","walletClaimed","walletBoundToCustodialFlow","projectSuspended","memoInvalid","cashDepositFailed","noMatchingNetwork","blockchainAddressInUse","bankAccountInUse","bankAccountRejected","deletePendingTimeout","providerAccountMissing","cardInUse","cardLimitReached","countryProhibited","countryNotSupported","cardVerificationDeclined","bankVerificationDeclined","accountClosed","accountFrozenByBank","routingOrAccountNumberInvalid","accountHolderDeceased","accountDoesNotSupportTransfers","payeeNameMismatch","walletUnreachableOnNetwork","billingAddressMismatch","cardExpired","cardClosedOrLostStolen","pushToCardUnsupported","cardDeclinedByIssuer"],"isRequired":true,"uniqueKey":"data.items.[INDEX].failure.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A fixed, vendor-neutral sentence for `code`.","isRequired":true,"uniqueKey":"data.items.[INDEX].failure.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether trying the same thing again can succeed.","isRequired":true,"uniqueKey":"data.items.[INDEX].failure.retryable","typeLabel":"boolean"},"bankCode":{"type":"string","description":"The bank's own return code, only on an external account a bank return made invalid.","uniqueKey":"data.items.[INDEX].failure.bankCode","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].failure","typeLabel":"object"},"hold":{"type":"object","description":"What you must do for a deposit address in `inactiveActionRequired`: set a new `destination`. Present only in that status.","required":["code","message"],"properties":{"code":{"type":"string","description":"Why the resource is held.","enum":["senderAttribution","payoutDestinationMissing"],"isRequired":true,"uniqueKey":"data.items.[INDEX].hold.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A fixed, vendor-neutral sentence for `code`.","isRequired":true,"uniqueKey":"data.items.[INDEX].hold.message","typeLabel":"string"},"deadline":{"type":"string","format":"date-time","description":"When the hold times out and the transaction fails. Only on `senderAttribution`.","uniqueKey":"data.items.[INDEX].hold.deadline","typeLabel":"string\u003cdate-time>"},"match":{"type":"object","description":"The sender's address and network to register to release the hold. Only on `senderAttribution`.","required":["address","network"],"properties":{"address":{"type":"string","description":"The sender's on-chain address.","isRequired":true,"uniqueKey":"data.items.[INDEX].hold.match.address","typeLabel":"string"},"network":{"type":"string","description":"The network family of the sender's address.","enum":["evm","solana","tron"],"isRequired":true,"uniqueKey":"data.items.[INDEX].hold.match.network","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].hold.match","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].hold","typeLabel":"object"},"sponsorGas":{"type":"boolean","description":"Whether OMS absorbs the on-chain gas cost for the destination delivery. Present only when true, the only value a create or update request accepts.","uniqueKey":"data.items.[INDEX].sponsorGas","typeLabel":"boolean"},"provider":{"type":"string","description":"The institution that issues and custodies this Deposit Address — currently \"Erebor Bank, N.A.\" or \"Coinme Inc.\". Assigned by OMS from your project's configuration. It determines which asset and network pairs you can create a deposit address for: an unsupported pair is rejected at create time with 422 `depositAddressAssetNetworkNotSupported`, which names the same provider in `details.provider`. Read it when you need to tell an end user or a support ticket which institution is holding the funds. It is *not* the name a payout is sent under, which is the payout transfer's `originatorName` and can name a different company. New providers may be added, so treat the string as free-form rather than a fixed set. Read-only; omitted when the issuing institution is not recognised.","uniqueKey":"data.items.[INDEX].provider","typeLabel":"string"},"requiresCounterpartyWalletRegistration":{"type":"boolean","description":"Present, and `true`, when a sender's wallet must be registered as a `walletExternal` External Account under this Deposit Address's customer before it deposits. Derived from the issuing `provider`, never supplied by you: Deposit Addresses issued by Erebor Bank, N.A. accept a deposit only from a registered counterparty wallet, while those issued by Coinme Inc. accept a deposit from any crypto address and leave the field out. When `true`, a deposit from an unregistered address still arrives, but its transaction parks on a `senderAttribution` hold until you register a matching External Account (the hold's `matchableExternalAccountCriteria` says what will match) and fails at the hold's `deadline` if you never do — so capture the sender's address up front. Read it per Deposit Address rather than caching it per project. Read-only. Also left out when OMS cannot identify the issuing provider.","uniqueKey":"data.items.[INDEX].requiresCounterpartyWalletRegistration","typeLabel":"boolean"},"label":{"type":"string","description":"Partner display label.","uniqueKey":"data.items.[INDEX].label","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"description":"Free-form key-value pairs supplied at creation or update.","uniqueKey":"data.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the deposit address was created.","uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the deposit address was last updated.","uniqueKey":"data.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"description":"A reusable crypto deposit configuration. Senders deposit the expected asset/network to the assigned on-chain address; OMS converts and delivers the funds to the configured bank destination automatically, creating a transaction per inbound deposit.\n\nA Deposit Address is permanent: there is no delete operation for a Deposit Address. The on-chain address is published to senders and can receive a deposit at any time, so removing the record would strand any funds that arrive afterwards with nothing to route them to. The terminal `closed` status is not a partner call either: it is reached through the provider's own lifecycle or an operator action, and a `closed` Deposit Address is still not deleted — it stays retrievable by id. To stop using one, stop handing its address to senders. PATCH `destination` changes where deposits that arrive afterwards are delivered; a deposit that has already arrived keeps the destination that was in effect when it arrived. Contrast a Virtual Account, which does support `DELETE` because its close is a real provider-side account closure.","uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"The page of results.","uniqueKey":"data","typeLabel":"object[]"}},"description":"Paginated list of DepositAddress resources.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"\u003cstring>","limit":123,"hasMore":true,"nextCursor":"\u003cstring>","previousCursor":"\u003cstring>","data":[{"customer":{"id":"\u003cstring>"},"id":"\u003cstring>","status":"pending","depositInstructions":{"asset":"\u003cstring>","network":"ethereum","address":"\u003cstring>"},"destination":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"payout":{"rail":"ach","instantRail":"rtp","intraBankRail":"bookTransfer","secCode":"ccd","companyDiscretionaryData":"\u003cstring>"},"payoutOrigin":{"type":"bank","id":"\u003cstring>","accountHolder":"customer","accountHolderName":"\u003cstring>"},"returnDestination":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"returnDestinationTypes":["walletCrypto"],"failure":{"code":"providerError","message":"\u003cstring>","retryable":true,"bankCode":"\u003cstring>"},"hold":{"code":"senderAttribution","message":"\u003cstring>","deadline":"2023-11-07T05:31:56Z","match":{"address":"\u003cstring>","network":"evm"}},"sponsorGas":true,"provider":"\u003cstring>","requiresCounterpartyWalletRegistration":true,"label":"\u003cstring>","metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"01360b2d-ee00-42f1-8178-d71614fd896a":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["InvalidCursor"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10088],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["invalid"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"InvalidCursor","code":10088,"msg":"invalid","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c7a8633-8a3f-4957-8d53-d01d9398b732":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["Internal"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10124],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["internal error"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Internal","code":10124,"msg":"internal error","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0057ef24-3c5e-4b52-a4d9-5c894a9b4f5e":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"dc14c13e-4f51-41d3-bf07-1fa9c8a1b005":{"url":"https://sandbox-api.polygon.technology/v0.13","description":"Sandbox"},"4cc92329-3167-465b-aed7-0cd9c63f6ad7":{"url":"https://api.polygon.technology/v0.13","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token from POST /auth/token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"polygon-labs","siteName":"Polygon Developer Docs","title":"List all Deposit Addresses - Polygon Developer Docs","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T14:12:08.379Z","originalFileLocation":"api-reference/depositaddress/list-all-deposit-addresses.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=\"light\"}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=\"List all Deposit Addresses across the organization. Spans every customer in the caller\u0026#x27;s organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polygon Developer 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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_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/polygon-labs/62XjF4p_S3sLlTMv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List all Deposit Addresses - Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"List all Deposit Addresses across the organization. Spans every customer in the caller\u0026#x27;s organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Deposit+Addresses\u0026amp;title=List+all+Deposit+Addresses\u0026amp;description=List+all+Deposit+Addresses+across+the+organization.+Spans+every+customer+in+the+caller%27s+organization%3B+optionally+filter+by+status+and%2For+customer.+%60closed%60+Dep\u0026amp;theme=430e64796fff481709b26ceb\u0026amp;signature=a905def3280e73a1e7bda7ee722f453188bcf09827fcda624cab1e84da829cfa\">\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=\"List all Deposit Addresses - Polygon Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List all Deposit Addresses across the organization. Spans every customer in the caller\u0026#x27;s organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Deposit+Addresses\u0026amp;title=List+all+Deposit+Addresses\u0026amp;description=List+all+Deposit+Addresses+across+the+organization.+Spans+every+customer+in+the+caller%27s+organization%3B+optionally+filter+by+status+and%2For+customer.+%60closed%60+Dep\u0026amp;theme=430e64796fff481709b26ceb\u0026amp;signature=a905def3280e73a1e7bda7ee722f453188bcf09827fcda624cab1e84da829cfa\">\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/polygon-labs/62XjF4p_S3sLlTMv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#670DE5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/depositaddress/list-all-deposit-addresses.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.polygon.technology/#organization\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polygon.technology#website\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses#webpage\",\"url\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses\",\"name\":\"List all Deposit Addresses\",\"description\":\"List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.\",\"dateModified\":\"2026-11-05T14:12:08.379Z\",\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Routes\",\"item\":\"https://docs.polygon.technology/api-reference/depositaddress/create-a-deposit-address\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Deposit Addresses\",\"item\":\"https://docs.polygon.technology/api-reference/depositaddress/create-a-deposit-address\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List all Deposit Addresses\",\"item\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses#apireference\",\"headline\":\"List all Deposit Addresses\",\"name\":\"List all Deposit Addresses\",\"description\":\"List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. closed Deposit Addresses are omitted unless you ask for them explicitly with status=closed.\",\"url\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polygon.technology/api-reference/depositaddress/list-all-deposit-addresses#webpage\"},\"dateModified\":\"2026-11-05T14:12:08.379Z\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"}}]}\u003c/script>","siteName":"Polygon Developer Docs","nav":{"global":null,"tabs":[{"tab":"Platform","icon":"layer-group","pages":[{"title":"Platform","href":""}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/payments/overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Cross-chain","pages":[{"title":"Cross-chain","href":"/cross-chain"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Open Money Stack API","href":"/api-reference/overview"}]},{"group":"Move money","pages":[{"group":"Quotes","pages":[{"title":"Create a payment quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /quotes","href":"/api-reference/quote/create-a-payment-quote"},{"title":"Get quote by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /quotes/{quoteId}","href":"/api-reference/quote/get-quote-by-id"}]},{"group":"Transactions","pages":[{"title":"Execute a transaction (send)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /transactions","href":"/api-reference/transaction/execute-a-transaction-send"},{"title":"List transactions with filters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions","href":"/api-reference/transaction/list-transactions-with-filters"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions/{transactionId}","href":"/api-reference/transaction/get-transaction-by-id"}]},{"group":"Transfers","pages":[{"title":"Get transfer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transfers/{transferId}","href":"/api-reference/transfer/get-transfer-by-id"}]},{"group":"Cash-In","pages":[{"title":"Create a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins","href":"/api-reference/cashins/create-a-cash-in-deposit-code"},{"title":"List cash-ins","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins","href":"/api-reference/cashins/list-cash-ins"},{"title":"Get a cash-in by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins/{cashInId}","href":"/api-reference/cashins/get-a-cash-in-by-id"},{"title":"Refresh a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/refresh","href":"/api-reference/cashins/refresh-a-cash-in-deposit-code"},{"title":"Cancel a cash-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/cancel","href":"/api-reference/cashins/cancel-a-cash-in"}]}]},{"group":"Routes","pages":[{"group":"Deposit Addresses","pages":[{"title":"Create a Deposit Address","description":"Create a Deposit Address. Requires deposit addresses to be enabled for your project and the customer to be provisioned with the banking provider. The address starts `pending` and becomes `active` once the inbound on-chain address is assigned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /deposit-addresses","href":"/api-reference/depositaddress/create-a-deposit-address"},{"title":"List all Deposit Addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses","href":"/api-reference/depositaddress/list-all-deposit-addresses"},{"title":"Get a Deposit Address","description":"Fetch a Deposit Address by ID.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/get-a-deposit-address"},{"title":"Update a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/update-a-deposit-address"}]},{"group":"Virtual Accounts","pages":[{"title":"Create a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts","href":"/api-reference/virtualaccount/create-a-virtual-account"},{"title":"List all Virtual Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts","href":"/api-reference/virtualaccount/list-all-virtual-accounts"},{"title":"Get a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/get-a-virtual-account"},{"title":"Update a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/update-a-virtual-account"},{"title":"Delete a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/delete-a-virtual-account"}]}]},{"group":"External Payment Methods","pages":[{"group":"Counterparties","pages":[{"title":"Create a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /counterparties","href":"/api-reference/counterparty/create-a-counterparty"},{"title":"List Counterparties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties","href":"/api-reference/counterparty/list-counterparties"},{"title":"Get a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties/{counterpartyId}","href":"/api-reference/counterparty/get-a-counterparty"},{"title":"Update a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /counterparties/{counterpartyId}","href":"/api-reference/counterparty/update-a-counterparty"},{"title":"Delete a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /counterparties/{counterpartyId}","href":"/api-reference/counterparty/delete-a-counterparty"}]},{"group":"External Accounts","pages":[{"title":"Create an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts","href":"/api-reference/externalaccount/create-an-external-account"},{"title":"Register a card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts/cards","href":"/api-reference/externalaccount/register-a-card"},{"title":"List External Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts","href":"/api-reference/externalaccount/list-external-accounts"},{"title":"Get an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/get-an-external-account"},{"title":"Update an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/update-an-external-account"},{"title":"Delete an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/delete-an-external-account"}]}]},{"group":"Platform","pages":[{"group":"Auth","pages":[{"title":"Get bearer token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /auth/token","href":"/api-reference/auth/get-bearer-token"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /customers/{customerId}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}","href":"/api-reference/customers/delete-a-customer"},{"title":"Get customer balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{id}/balance","href":"/api-reference/customer/get-customer-balance"},{"title":"Create a browser token for a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/token","href":"/api-reference/customertokens/create-a-browser-token-for-a-customer"},{"title":"Get browser risk configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /risk/config","href":"/api-reference/get-browser-risk-configuration"}]},{"group":"Business onboarding","pages":[{"title":"Post customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/beneficiaries","href":"/api-reference/business-onboarding/post-customers-beneficiaries"},{"title":"Get customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/get-customers-beneficiaries"},{"title":"Get customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/get-customers-beneficiaries"},{"title":"Put customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/put-customers-beneficiaries"},{"title":"Delete customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/delete-customers-beneficiaries"},{"title":"Post customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/onboardings","href":"/api-reference/business-onboarding/post-customers-onboardings"},{"title":"Get customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings/{onboardingId}","href":"/api-reference/business-onboarding/get-customers-onboardings"},{"title":"Get customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings/{onboardingId}","href":"/api-reference/business-onboarding/get-customers-onboardings"}]},{"group":"Wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets","href":"/api-reference/wallet/list-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /wallets","href":"/api-reference/wallet/create-a-wallet"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/{id}","href":"/api-reference/wallet/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /wallets/{id}","href":"/api-reference/wallet/update-a-wallet"},{"title":"Get a wallet-provisioning operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/operations/{operationId}","href":"/api-reference/wallet/get-a-wallet-provisioning-operation"},{"title":"Associate an embedded wallet with a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/wallets/associate","href":"/api-reference/wallets/associate-an-embedded-wallet-with-a-customer"}]},{"group":"Cash Locations","pages":[{"title":"List cash locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-locations","href":"/api-reference/cashlocation/list-cash-locations"}]},{"group":"Webhooks","pages":[{"title":"Webhook events","href":"/api-reference/webhook-events"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook-by-id"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /webhooks/{webhookId}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Enable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/enable","href":"/api-reference/webhooks/enable-a-webhook"},{"title":"Disable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/disable","href":"/api-reference/webhooks/disable-a-webhook"},{"title":"Rotate the signing key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/rotate-key","href":"/api-reference/webhooks/rotate-the-signing-key"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/test","href":"/api-reference/webhooks/send-a-test-delivery"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries","href":"/api-reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Get a delivery with its attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-delivery-with-its-attempts"},{"title":"Retry deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/deliveries/retry","href":"/api-reference/webhooks/retry-deliveries"}]},{"group":"Route transactions","pages":[{"title":"List Deposit Address transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses/{depositAddressId}/transactions","href":"/api-reference/depositaddress/list-deposit-address-transactions"},{"title":"List Virtual Account transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}/transactions","href":"/api-reference/virtualaccount/list-virtual-account-transactions"}]},{"group":"Reference","pages":[{"title":"List supported networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /networks","href":"/api-reference/reference/list-supported-networks"},{"title":"Get account-type requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /reference/account-type-requirements","href":"/api-reference/reference/get-account-type-requirements"}]},{"group":"Sandbox Simulations","pages":[{"title":"Simulate inbound transfer on a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer","href":"/api-reference/sandbox/simulate-inbound-transfer-on-a-virtual-account"},{"title":"Simulate cash-in present code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/present-code","href":"/api-reference/sandbox/simulate-cash-in-present-code"},{"title":"Simulate cash-in deposit cash","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/deposit-cash","href":"/api-reference/sandbox/simulate-cash-in-deposit-cash"},{"title":"Simulate cash-in cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/cancel","href":"/api-reference/sandbox/simulate-cash-in-cancel"}]}]},{"group":"Read onchain data","pages":[{"group":"Token Balances","pages":[{"title":"Get token balance summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesSummary","href":"/api-reference/indexer/get-token-balance-summary"},{"title":"Get token balance details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-token-balance-details"},{"title":"Get token balances by contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesByContract","href":"/api-reference/indexer/get-token-balances-by-contract"},{"title":"Get native token balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetNativeTokenBalance","href":"/api-reference/indexer/get-native-token-balance"},{"title":"Get balance updates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetBalanceUpdates","href":"/api-reference/indexer/get-balance-updates"},{"title":"Get Solana token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/SolanaIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-solana-token-balances"},{"title":"Get Tron token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/TronIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-tron-token-balances"}]},{"group":"Token Prices","pages":[{"title":"Get token price","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrice","href":"/api-reference/indexer/get-token-price"},{"title":"Get token prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrices","href":"/api-reference/indexer/get-token-prices"}]},{"group":"Transaction History","pages":[{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTransactionHistory","href":"/api-reference/indexer/get-transaction-history"}]},{"group":"Chains","pages":[{"title":"List chains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetChains","href":"/api-reference/indexer/list-chains"}]}]}]},{"tab":"Infrastructure","icon":"server","pages":[{"title":"Infrastructure","href":"/infrastructure"}]},{"tab":"Polygon Chain","pages":[{"title":"Polygon Chain","href":"/pos/overview"}]},{"tab":"Polygon CDK","pages":[{"title":"Polygon CDK","href":"/chain-development/cdk"}]},{"tab":"Agglayer","pages":[{"title":"Agglayer","href":"/interoperability/overview"}]},{"tab":"Agentic","pages":[{"title":"Agentic","href":"/payment-services/agentic-payments/agent-integration/intro"}]}]},"basePath":"","title":"List all Deposit Addresses - Polygon Developer Docs","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}