{
"type": "INVALID_OID_FORMAT",
"title": "Invalid Object ID Format",
"status": 400,
"detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
"resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
"docs": "https://v2.docs.conduit.financial/errors#invalid-oid-format",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "API_KEY_MISSING",
"title": "API Key Missing",
"status": 401,
"detail": "The request did not include an API key. All API requests must be authenticated.",
"resolution": "Include your API key in the 'x-api-key' header with every request.",
"docs": "https://v2.docs.conduit.financial/errors#api-key-missing",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "ORGANIZATION_ACCESS_SUSPENDED",
"title": "Organization Access Suspended",
"status": 403,
"detail": "Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.",
"resolution": "Contact Conduit support.",
"docs": "https://v2.docs.conduit.financial/errors#organization-access-suspended",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "CUSTOMER_NOT_FOUND",
"title": "Customer Not Found",
"status": 404,
"detail": "No customer exists with the specified ID, or the customer belongs to a different organization.",
"resolution": "Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.",
"docs": "https://v2.docs.conduit.financial/errors#customer-not-found",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "RATE_LIMITED",
"title": "Rate Limited",
"status": 429,
"detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.",
"resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
"docs": "https://v2.docs.conduit.financial/errors#rate-limited",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z",
"retryAfterSeconds": 3
}
{
"type": "INTERNAL_ERROR",
"title": "Internal Error",
"status": 500,
"detail": "An unexpected error occurred while processing your request.",
"resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
"docs": "https://v2.docs.conduit.financial/errors#internal-error",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
pending_activation: the account was requested and is still being set up, so nobody can pay into it yet. active: the customer can be paid into it. disabled: the account takes no new deposits.
Coordinates to give a payer, grouped by collection method — branch on each block's type, and read the currency off the block's currency rather than off type. Empty until status is active.
Domestic US clearing coordinates: an account number plus one routing number per network (ACH, Fedwire, RTP).
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Show child attributes
Example:
{
"type": "us_domestic",
"currency": "USD",
"accountNumber": "123456789",
"beneficiaryName": "Example Customer",
"beneficiaryAddress": "1 Main St, New York, NY",
"bank": {
"legalName": "Example Bank",
"address": "2 Bank St, New York, NY",
"postalAddress": {
"addressLine1": "2 Bank St",
"city": "New York",
"state": "NY",
"postalCode": "10005",
"country": "US"
}
},
"rails": [
{
"rail": "ach",
"routingNumber": "021000021",
"sameDayEligible": false
},
{
"rail": "fedwire",
"routingNumber": "021000021"
},
{
"rail": "rtp",
"routingNumber": "021000021",
"networks": ["tch"]
}
]
}
⌘I
Get a virtual account
curl --request GET \
--url https://api.sandbox.conduit.financial/v2/customers/{customerId}/virtual-accounts/{virtualAccountId} \
--header 'x-api-key: <api-key>'
{
"type": "INVALID_OID_FORMAT",
"title": "Invalid Object ID Format",
"status": 400,
"detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
"resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
"docs": "https://v2.docs.conduit.financial/errors#invalid-oid-format",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "API_KEY_MISSING",
"title": "API Key Missing",
"status": 401,
"detail": "The request did not include an API key. All API requests must be authenticated.",
"resolution": "Include your API key in the 'x-api-key' header with every request.",
"docs": "https://v2.docs.conduit.financial/errors#api-key-missing",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "ORGANIZATION_ACCESS_SUSPENDED",
"title": "Organization Access Suspended",
"status": 403,
"detail": "Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.",
"resolution": "Contact Conduit support.",
"docs": "https://v2.docs.conduit.financial/errors#organization-access-suspended",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "CUSTOMER_NOT_FOUND",
"title": "Customer Not Found",
"status": 404,
"detail": "No customer exists with the specified ID, or the customer belongs to a different organization.",
"resolution": "Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.",
"docs": "https://v2.docs.conduit.financial/errors#customer-not-found",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{
"type": "RATE_LIMITED",
"title": "Rate Limited",
"status": 429,
"detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.",
"resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
"docs": "https://v2.docs.conduit.financial/errors#rate-limited",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z",
"retryAfterSeconds": 3
}
{
"type": "INTERNAL_ERROR",
"title": "Internal Error",
"status": 500,
"detail": "An unexpected error occurred while processing your request.",
"resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
"docs": "https://v2.docs.conduit.financial/errors#internal-error",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Conduit API","colors":{"primary":"#0445F5"},"favicon":"https://mintcdn.com/conduit-v2/TDfL4m3KARlDDGif/favicon.svg?fit=max\u0026auto=format\u0026n=TDfL4m3KARlDDGif\u0026q=85\u0026s=26f960e7de4cc7324c4942bb0970c778","api":{"playground":{}},"navbar":{"primary":{"type":"button","label":"Talk to Sales","href":"https://meetings.hubspot.com/gianmarco-carmelino/talk-to-sales"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"variables":{"production-host":"https://api.conduit.financial","sandbox-host":"https://api.sandbox.conduit.financial"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Trust Center","href":"https://trust.conduitpay.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"conduit-v2","hasAudioNarration":false,"actualSubdomain":"conduit-v2","customDomains":["docs.conduit.financial"],"gitSource":{"type":"github","owner":"conduit-financial","repo":"conduit-api","deployBranch":"main","contentDirectory":"api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af240c680c4ca53605dbb7e","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"KYB Reference","count":204},{"language":"default","tag":"API Reference","count":138},{"language":"default","tag":"Africa","count":47},{"language":"default","tag":"Europe","count":45},{"language":"default","tag":"Latin America","count":41},{"language":"default","tag":"Sandbox","count":36},{"language":"default","tag":"Asia-Pacific","count":35},{"language":"default","tag":"Guides","count":33},{"language":"default","tag":"Asia (West, South \u0026 Central)","count":28},{"language":"default","tag":"Errors","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/virtual-accounts/get-a-virtual-account","slug":"/api-reference/virtual-accounts/get-a-virtual-account","pageMetadata":{"title":"Get a virtual account","description":"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId}","href":"/api-reference/virtual-accounts/get-a-virtual-account","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\"\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":"Get a virtual account","description":"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId}","href":"/api-reference/virtual-accounts/get-a-virtual-account","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/conduit-v2/fc10fecbb08a67cd/changelog-feed.js"],"openApiReferenceData":{"operation":{"description":"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.","operationId":"VirtualAccountsController_get_v2","parameters":["6d9f0e49-41fb-47e2-bf80-276e354e9cc6","ccc927a1-e8f8-480c-80b4-d4ec8f7876c0"],"responses":{"200":"2334a42a-36c9-4c87-8168-c7f5ddc930cd","400":"1e9a8d9a-0cc4-4a35-bc86-6603e53a8a34","401":"afa001df-4d19-4b3e-8417-02f61c8fbe90","403":"cf570930-bb5f-4aa8-ba6d-83fb6e0bcf48","404":"c53feb14-27d1-4baa-a7a9-d2d98edf5e74","429":"ad3bc013-5c69-4007-8187-94a36435282a","500":"3c4484bb-508b-453e-8b61-d124be7ef173"},"summary":"Get a virtual account","tags":["Virtual Accounts"],"method":"get","type":"path","servers":["5707e0ee-a73c-4f7a-b3dd-5e91e6ddef88","107fb7ae-4503-4921-bfe7-67fa54c45455"],"security":["e216d117-afec-4a29-92f2-646b533f2725"],"path":"/customers/{customerId}/virtual-accounts/{virtualAccountId}","baseUrlOptions":["https://api.sandbox.conduit.financial/v2","https://api.conduit.financial/v2"],"title":"Get a virtual account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6d9f0e49-41fb-47e2-bf80-276e354e9cc6":{"name":"customerId","required":true,"in":"path","schema":{"type":"string","example":"cus_1A2b3C4d5E6f7G8h9I0jKl","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"ccc927a1-e8f8-480c-80b4-d4ec8f7876c0":{"name":"virtualAccountId","required":true,"in":"path","schema":{"type":"string","example":"vac_1A2b3C4d5E6f7G8h9I0jKl","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"2334a42a-36c9-4c87-8168-c7f5ddc930cd":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^vac_[0-9A-Za-z]{22}$","description":"Id of the virtual account. Each id has the form `vac_` followed by 22 alphanumeric characters.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"description":"`pending_activation`: the account was requested and is still being set up, so nobody can pay into it yet. `active`: the customer can be paid into it. `disabled`: the account takes no new deposits.","type":"string","enum":["pending_activation","active","disabled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"asset":{"type":"object","properties":{"code":{"type":"string","enum":["USD","EUR","GBP","CHF","JPY","CAD","AUD","NZD","SGD","HKD","CNY","KRW","INR","BRL","MXN","ARS","CLP","COP","PEN","ZAR","NGN","KES","GHS","EGP","AED","SAR","ILS","TRY","PLN","CZK","HUF","SEK","NOK","DKK","THB","IDR","MYR","PHP","VND","TWD","USDC","USDT","DAI","EURC","PYUSD","OUSD","BTC","ETH","SOL","TRX","XLM","POL"],"description":"Asset code identifier","example":"USD","isRequired":true,"uniqueKey":"asset.code","typeLabel":"enum\u003cstring>"},"chain":{"oneOf":[{"type":"string","enum":["ethereum","base","solana","polygon","tron","stellar","tempo","arbitrum","optimism","arc",null],"description":"Blockchain network. `null`/omitted for fiat assets.","uniqueKey":"asset.chain.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ethereum","base","solana","polygon","tron","stellar","tempo","arbitrum","optimism","arc",null],"description":"Blockchain network. `null`/omitted for fiat assets.","uniqueKey":"asset.chain.oneOf.1","typeLabel":"null"}],"uniqueKey":"asset.chain","typeLabel":"enum\u003cstring> | null"}},"required":["code"],"isRequired":true,"uniqueKey":"asset","typeLabel":"object"},"balances":{"type":"array","items":{"type":"object","properties":{"available":{"type":"object","properties":{"code":{"type":"string","enum":["USD","EUR","GBP","CHF","JPY","CAD","AUD","NZD","SGD","HKD","CNY","KRW","INR","BRL","MXN","ARS","CLP","COP","PEN","ZAR","NGN","KES","GHS","EGP","AED","SAR","ILS","TRY","PLN","CZK","HUF","SEK","NOK","DKK","THB","IDR","MYR","PHP","VND","TWD","USDC","USDT","DAI","EURC","PYUSD","OUSD","BTC","ETH","SOL","TRX","XLM","POL"],"description":"Asset code (USDC, USD, etc.)","isRequired":true,"uniqueKey":"balances.items.[INDEX].available.code","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Decimal string, asset-precision rounded","isRequired":true,"uniqueKey":"balances.items.[INDEX].available.amount","typeLabel":"string"},"chain":{"description":"Chain when the asset is on-chain; omitted for fiat.","type":"string","enum":["ethereum","base","solana","polygon","tron","stellar","tempo","arbitrum","optimism","arc"],"uniqueKey":"balances.items.[INDEX].available.chain","typeLabel":"enum\u003cstring>"}},"required":["code","amount"],"additionalProperties":false,"isRequired":true,"uniqueKey":"balances.items.[INDEX].available","typeLabel":"object"},"pending":{"type":"object","properties":{"code":{"type":"string","enum":["USD","EUR","GBP","CHF","JPY","CAD","AUD","NZD","SGD","HKD","CNY","KRW","INR","BRL","MXN","ARS","CLP","COP","PEN","ZAR","NGN","KES","GHS","EGP","AED","SAR","ILS","TRY","PLN","CZK","HUF","SEK","NOK","DKK","THB","IDR","MYR","PHP","VND","TWD","USDC","USDT","DAI","EURC","PYUSD","OUSD","BTC","ETH","SOL","TRX","XLM","POL"],"description":"Asset code (USDC, USD, etc.)","isRequired":true,"uniqueKey":"balances.items.[INDEX].pending.code","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Decimal string, asset-precision rounded","isRequired":true,"uniqueKey":"balances.items.[INDEX].pending.amount","typeLabel":"string"},"chain":{"description":"Chain when the asset is on-chain; omitted for fiat.","type":"string","enum":["ethereum","base","solana","polygon","tron","stellar","tempo","arbitrum","optimism","arc"],"uniqueKey":"balances.items.[INDEX].pending.chain","typeLabel":"enum\u003cstring>"}},"required":["code","amount"],"additionalProperties":false,"isRequired":true,"uniqueKey":"balances.items.[INDEX].pending","typeLabel":"object"},"frozen":{"type":"object","properties":{"code":{"type":"string","enum":["USD","EUR","GBP","CHF","JPY","CAD","AUD","NZD","SGD","HKD","CNY","KRW","INR","BRL","MXN","ARS","CLP","COP","PEN","ZAR","NGN","KES","GHS","EGP","AED","SAR","ILS","TRY","PLN","CZK","HUF","SEK","NOK","DKK","THB","IDR","MYR","PHP","VND","TWD","USDC","USDT","DAI","EURC","PYUSD","OUSD","BTC","ETH","SOL","TRX","XLM","POL"],"description":"Asset code (USDC, USD, etc.)","isRequired":true,"uniqueKey":"balances.items.[INDEX].frozen.code","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Decimal string, asset-precision rounded","isRequired":true,"uniqueKey":"balances.items.[INDEX].frozen.amount","typeLabel":"string"},"chain":{"description":"Chain when the asset is on-chain; omitted for fiat.","type":"string","enum":["ethereum","base","solana","polygon","tron","stellar","tempo","arbitrum","optimism","arc"],"uniqueKey":"balances.items.[INDEX].frozen.chain","typeLabel":"enum\u003cstring>"}},"required":["code","amount"],"additionalProperties":false,"isRequired":true,"uniqueKey":"balances.items.[INDEX].frozen","typeLabel":"object"}},"required":["available","pending","frozen"],"description":"Balance for one asset on an account: available, pending, and frozen buckets all in the same asset. Frozen is money under a compliance hold or on a bank account the bank has blocked.","uniqueKey":"balances.items.[INDEX]","typeLabel":"object"},"description":"What the account holds, in the account's own asset.","isRequired":true,"uniqueKey":"balances","typeLabel":"object[]"},"activatedAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 timestamp","example":"2026-01-15T09:30:00.000Z","isRequired":true,"uniqueKey":"activatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 timestamp","example":"2026-01-15T09:30:00.000Z","isRequired":true,"uniqueKey":"activatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"activatedAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp","example":"2026-01-15T09:30:00.000Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp","example":"2026-01-15T09:30:00.000Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"depositInstructions":{"type":"array","items":{"oneOf":[{"type":"object","description":"Domestic US clearing coordinates: an account number plus one routing number per network (ACH, Fedwire, RTP).","required":["type","currency","accountNumber","beneficiaryName","rails"],"example":{"type":"us_domestic","currency":"USD","accountNumber":"123456789","beneficiaryName":"Example Customer","beneficiaryAddress":"1 Main St, New York, NY","bank":{"legalName":"Example Bank","address":"2 Bank St, New York, NY","postalAddress":{"addressLine1":"2 Bank St","city":"New York","state":"NY","postalCode":"10005","country":"US"}},"rails":[{"rail":"ach","routingNumber":"021000021","sameDayEligible":false},{"rail":"fedwire","routingNumber":"021000021"},{"rail":"rtp","routingNumber":"021000021","networks":["tch"]}]},"properties":{"type":{"type":"string","enum":["us_domestic"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["USD"],"description":"Currency this block collects. Always USD: ACH, Fedwire and RTP are US clearing networks and settle dollars only.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.currency","typeLabel":"enum\u003cstring>"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.accountNumber","typeLabel":"string"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryName","typeLabel":"string"},"rails":{"minItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"oneOf":[{"type":"string","enum":["ach"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["fedwire"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].rail.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["rtp"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].rail.oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"},"routingNumber":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].routingNumber","typeLabel":"string"},"sameDayEligible":{"type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].sameDayEligible","typeLabel":"boolean"},"networks":{"type":"array","items":{"type":"string","enum":["tch","fednow"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].networks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].networks","typeLabel":"enum\u003cstring>[]"},"fednowCap":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX].fednowCap","typeLabel":"string"}},"required":["rail","routingNumber"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails.items.[INDEX]","typeLabel":"object"},"description":"US domestic networks this account collects on. Every entry carries its own routing number; the payer picks one network.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.rails","typeLabel":"object[]"},"beneficiaryAddress":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryAddress","typeLabel":"string"},"beneficiaryPostalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.beneficiaryPostalAddress","typeLabel":"object"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.bank","typeLabel":"object"},"paymentReference":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"description":"True when the payer must put paymentReference in the transfer memo. The collecting account is shared, so the reference is what names the destination; a missing or incorrect one delays credit.","type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.0.paymentReferenceRequired","typeLabel":"boolean"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"International SWIFT coordinates: an account number or an IBAN, the collecting bank's BIC, and the correspondent to route through where one applies.","required":["type","currency","beneficiaryName","rails"],"example":{"type":"swift","currency":"USD","accountNumber":"123456789","beneficiaryName":"Example Customer","bank":{"legalName":"Example Bank","address":"2 Bank St, New York, NY","postalAddress":{"addressLine1":"2 Bank St","city":"New York","state":"NY","postalCode":"10005","country":"US"},"bic":"EXMPUS33XXX"},"correspondent":{"name":"Correspondent Bank","address":"3 Wall St, New York, NY","postalAddress":{"addressLine1":"3 Wall St","city":"New York","state":"NY","postalCode":"10005","country":"US"},"bic":"CORRUS33XXX"},"rails":[{"rail":"swift"}]},"properties":{"type":{"type":"string","enum":["swift"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["AED","ARS","AUD","BRL","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","GHS","HKD","HUF","IDR","ILS","INR","JPY","KES","KRW","MXN","MYR","NGN","NOK","NZD","PEN","PHP","PLN","SAR","SEK","SGD","THB","TRY","TWD","USD","VND","ZAR"],"description":"Currency this block collects. The rail family and the currency are independent here: correspondent banking settles many currencies, so read this field rather than inferring one from the family.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.currency","typeLabel":"enum\u003cstring>"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryName","typeLabel":"string"},"rails":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"type":"string","enum":["swift"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"}},"required":["rail"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.rails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.rails","typeLabel":"object[]"},"accountNumber":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.accountNumber","typeLabel":"string"},"iban":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.iban","typeLabel":"string"},"beneficiaryAddress":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryAddress","typeLabel":"string"},"beneficiaryPostalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.beneficiaryPostalAddress","typeLabel":"object"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.bank","typeLabel":"object"},"correspondent":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.name","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.address","typeLabel":"string"},"bic":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.bic","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.postalAddress","typeLabel":"object"},"accountNumber":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent.accountNumber","typeLabel":"string"}},"required":["name","address","bic"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.correspondent","typeLabel":"object"},"paymentReference":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"description":"True when the payer must put paymentReference in the transfer memo. The collecting account is shared, so the reference is what names the destination; a missing or incorrect one delays credit.","type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.1.paymentReferenceRequired","typeLabel":"boolean"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Euro-area credit-transfer coordinates: an IBAN plus a BIC. Settles at the collecting bank with no US correspondent hop.","required":["type","currency","iban","bic","beneficiaryName","rails"],"example":{"type":"sepa","currency":"EUR","iban":"DE89370400440532013000","bic":"EXMPDEFFXXX","beneficiaryName":"Example Customer","beneficiaryAddress":"1 Hauptstrasse, Berlin","bank":{"legalName":"Example Bank Europe","address":"2 Bankstrasse, Frankfurt","postalAddress":{"addressLine1":"2 Bankstrasse","city":"Frankfurt","postalCode":"60311","country":"DE"},"bic":"EXMPDEFFXXX"},"rails":[{"rail":"sepa"}]},"properties":{"type":{"type":"string","enum":["sepa"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["EUR"],"description":"Currency this block collects. Always EUR: a SEPA credit transfer is euro-denominated by scheme.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.currency","typeLabel":"enum\u003cstring>"},"iban":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.iban","typeLabel":"string"},"bic":{"type":"string","description":"Collecting bank's BIC. Always present: a SEPA credit transfer has no correspondent hop to fall back on, so this is a coordinate rather than bank disclosure.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bic","typeLabel":"string"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryName","typeLabel":"string"},"rails":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"type":"string","enum":["sepa"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"}},"required":["rail"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.rails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.rails","typeLabel":"object[]"},"beneficiaryAddress":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryAddress","typeLabel":"string"},"beneficiaryPostalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.beneficiaryPostalAddress","typeLabel":"object"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.bank","typeLabel":"object"},"paymentReference":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"description":"True when the payer must put paymentReference in the transfer memo. The collecting account is shared, so the reference is what names the destination; a missing or incorrect one delays credit.","type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.2.paymentReferenceRequired","typeLabel":"boolean"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"UK domestic credit-transfer coordinates: an account number plus a sort code, shared by Faster Payments and CHAPS. Settles at the collecting bank with no correspondent hop.","required":["type","currency","accountNumber","sortCode","beneficiaryName","rails"],"example":{"type":"uk_domestic","currency":"GBP","accountNumber":"12345678","sortCode":"040004","beneficiaryName":"Example Customer","beneficiaryAddress":"1 High Street, London","bank":{"legalName":"Example Bank UK","address":"2 Bank Street, London","postalAddress":{"addressLine1":"2 Bank Street","city":"London","postalCode":"EC1V 9NR","country":"GB"},"bic":"EXMPGB2LXXX"},"rails":[{"rail":"faster_payments"},{"rail":"chaps"}]},"properties":{"type":{"type":"string","enum":["uk_domestic"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["GBP"],"description":"Currency this block collects. Always GBP: Faster Payments and CHAPS are UK clearing schemes and settle no other currency.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.currency","typeLabel":"enum\u003cstring>"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.accountNumber","typeLabel":"string"},"sortCode":{"type":"string","description":"Collecting bank's six-digit UK sort code. Always present: the UK domestic schemes address an account by sort code plus account number, so this is a coordinate rather than bank disclosure.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.sortCode","typeLabel":"string"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryName","typeLabel":"string"},"rails":{"minItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"oneOf":[{"type":"string","enum":["faster_payments"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.rails.items.[INDEX].rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["chaps"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.rails.items.[INDEX].rail.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"}},"required":["rail"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.rails.items.[INDEX]","typeLabel":"object"},"description":"UK domestic schemes this account collects on. Both address the same sort code and account number; the payer picks one.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.rails","typeLabel":"object[]"},"beneficiaryAddress":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryAddress","typeLabel":"string"},"beneficiaryPostalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.beneficiaryPostalAddress","typeLabel":"object"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.bank","typeLabel":"object"},"paymentReference":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"description":"True when the payer must put paymentReference in the transfer memo. The collecting account is shared, so the reference is what names the destination; a missing or incorrect one delays credit.","type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.3.paymentReferenceRequired","typeLabel":"boolean"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Brazilian credit-transfer coordinates: a PIX key, and a bank code, branch and account number for TED. The collecting account is shared, so every payment must carry the payment reference.","required":["type","currency","beneficiaryName","beneficiaryTaxId","bankCode","branch","accountNumber","pixKey","paymentReference","paymentReferenceRequired","rails"],"example":{"type":"brazil","currency":"BRL","beneficiaryName":"Example Collections Ltda","beneficiaryTaxId":"11222333000181","bankCode":"001","branch":"0001","accountNumber":"123456","pixKey":{"type":"cnpj","value":"11222333000181"},"paymentReference":"REF12345","paymentReferenceRequired":true,"rails":[{"rail":"pix"},{"rail":"ted"}]},"properties":{"type":{"type":"string","enum":["brazil"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["BRL"],"description":"Currency this block collects. Always BRL: PIX and TED are Brazilian clearing schemes and settle no other currency.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.currency","typeLabel":"enum\u003cstring>"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.beneficiaryName","typeLabel":"string"},"beneficiaryTaxId":{"type":"string","description":"CNPJ of the account holder the payer pays.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.beneficiaryTaxId","typeLabel":"string"},"bankCode":{"type":"string","description":"Three-digit code of the collecting bank, for a TED.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bankCode","typeLabel":"string"},"branch":{"type":"string","description":"Four-digit branch of the collecting account.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.branch","typeLabel":"string"},"accountNumber":{"type":"string","description":"Collecting account number with its check digit.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.accountNumber","typeLabel":"string"},"pixKey":{"type":"object","properties":{"type":{"type":"string","enum":["cpf","cnpj","email","phone","random"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.pixKey.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.pixKey.value","typeLabel":"string"}},"required":["type","value"],"description":"PIX key of the collecting account, for a PIX payment.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.pixKey","typeLabel":"object"},"paymentReference":{"type":"string","description":"Include the full payment reference in the transfer description. A missing or wrong reference delays credit.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.paymentReferenceRequired","typeLabel":"enum\u003cboolean>"},"rails":{"minItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"oneOf":[{"type":"string","enum":["pix"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.rails.items.[INDEX].rail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["ted"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.rails.items.[INDEX].rail.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"}},"required":["rail"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.rails.items.[INDEX]","typeLabel":"object"},"description":"Brazilian schemes this account collects on. PIX pays the key; TED pays the bank code, branch and account number.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.rails","typeLabel":"object[]"},"bankName":{"description":"Name of the bank that `bankCode` names, for a TED. Absent when Conduit has no name for the code.","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bankName","typeLabel":"string"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4.bank","typeLabel":"object"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"Mexican credit-transfer coordinates: a CLABE that SPEI pays. Settles at the collecting bank with no correspondent hop.","required":["type","currency","clabe","beneficiaryName","rails"],"example":{"type":"mexico","currency":"MXN","clabe":"000000123456789014","beneficiaryName":"Example Customer","bank":{"legalName":"Example Bank Mexico","address":"Ciudad de Mexico"},"rails":[{"rail":"spei"}]},"properties":{"type":{"type":"string","enum":["mexico"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["MXN"],"description":"Currency this block collects. Always MXN: SPEI is the Mexican clearing scheme and settles no other currency.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.currency","typeLabel":"enum\u003cstring>"},"clabe":{"type":"string","description":"18-digit CLABE of the collecting account. The CLABE names the bank, so the payer needs no bank code.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.clabe","typeLabel":"string"},"beneficiaryName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryName","typeLabel":"string"},"rails":{"minItems":1,"type":"array","items":{"type":"object","properties":{"rail":{"type":"string","enum":["spei"],"isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.rails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"}},"required":["rail"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.rails.items.[INDEX]","typeLabel":"object"},"description":"Mexican schemes this account collects on.","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.rails","typeLabel":"object[]"},"beneficiaryAddress":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryAddress","typeLabel":"string"},"beneficiaryPostalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.beneficiaryPostalAddress","typeLabel":"object"},"bank":{"type":"object","properties":{"legalName":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.legalName","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.address","typeLabel":"string"},"postalAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary street address","example":"100 Market St","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.city","typeLabel":"string"},"country":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country (ISO 3166-1 alpha-2)","example":"US","isRequired":true,"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.country","typeLabel":"enum\u003cstring>"},"addressLine2":{"description":"Secondary address line (suite, floor, etc.)","example":"Suite 400","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.addressLine2","typeLabel":"string"},"state":{"description":"State or province","example":"CA","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.state","typeLabel":"string"},"postalCode":{"description":"Postal code","example":"94105","type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress.postalCode","typeLabel":"string"}},"required":["addressLine1","city","country"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.postalAddress","typeLabel":"object"},"bic":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank.bic","typeLabel":"string"}},"required":["legalName","address"],"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.bank","typeLabel":"object"},"paymentReference":{"type":"string","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.paymentReference","typeLabel":"string"},"paymentReferenceRequired":{"description":"True when the payer must put paymentReference in the transfer memo. The collecting account is shared, so the reference is what names the destination; a missing or incorrect one delays credit.","type":"boolean","uniqueKey":"depositInstructions.items.[INDEX].oneOf.5.paymentReferenceRequired","typeLabel":"boolean"}},"uniqueKey":"depositInstructions.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"depositInstructions.items.[INDEX]","typeLabel":"object"},"description":"Coordinates to give a payer, grouped by collection method — branch on each block's `type`, and read the currency off the block's `currency` rather than off `type`. Empty until `status` is `active`.","isRequired":true,"uniqueKey":"depositInstructions","typeLabel":"object[]"}},"required":["id","status","asset","balances","activatedAt","createdAt","updatedAt","depositInstructions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"pending_activation","asset":{"code":"USD","chain":"ethereum"},"balances":[{"available":{"code":"USD","amount":"\u003cstring>","chain":"ethereum"},"pending":{"code":"USD","amount":"\u003cstring>","chain":"ethereum"},"frozen":{"code":"USD","amount":"\u003cstring>","chain":"ethereum"}}],"activatedAt":"2026-01-15T09:30:00.000Z","createdAt":"2026-01-15T09:30:00.000Z","updatedAt":"2026-01-15T09:30:00.000Z","depositInstructions":[{"type":"us_domestic","currency":"USD","accountNumber":"123456789","beneficiaryName":"Example Customer","beneficiaryAddress":"1 Main St, New York, NY","bank":{"legalName":"Example Bank","address":"2 Bank St, New York, NY","postalAddress":{"addressLine1":"2 Bank St","city":"New York","state":"NY","postalCode":"10005","country":"US"}},"rails":[{"rail":"ach","routingNumber":"021000021","sameDayEligible":false},{"rail":"fedwire","routingNumber":"021000021"},{"rail":"rtp","routingNumber":"021000021","networks":["tch"]}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1e9a8d9a-0cc4-4a35-bc86-6603e53a8a34":{"description":"**INVALID_OID_FORMAT**: A path or query parameter expected a valid object identifier but received a value that does not match the expected format.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"JSON pointer to the invalid field","example":"/email","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"detail":{"type":"string","description":"What is wrong with this field","example":"Invalid email format","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"allowedValues":{"description":"The values this field accepts, when it is a closed set","example":["ach","fedwire","rtp"],"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX].allowedValues.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.items.[INDEX].allowedValues","typeLabel":"string[]"},"category":{"description":"Class of blocker (requirements-validator output only). 'field' = form-field gap, 'document' = missing or insufficient document (including per-UBO document slots), 'individual' = required person missing.","example":"field","type":"string","enum":["field","document","individual"],"uniqueKey":"errors.items.[INDEX].category","typeLabel":"enum\u003cstring>"}},"required":["pointer","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"INVALID_OID_FORMAT","title":"Invalid Object ID Format","status":400,"detail":"A path or query parameter expected a valid object identifier but received a value that does not match the expected format.","resolution":"Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.","docs":"https://v2.docs.conduit.financial/errors#invalid-oid-format","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"type":"INVALID_OID_FORMAT","title":"Invalid Object ID Format","status":400,"detail":"A path or query parameter expected a valid object identifier but received a value that does not match the expected format.","resolution":"Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.","docs":"https://v2.docs.conduit.financial/errors#invalid-oid-format","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"afa001df-4d19-4b3e-8417-02f61c8fbe90":{"description":"**API_KEY_MISSING**: The request did not include an API key. All API requests must be authenticated.\n\n**API_KEY_INVALID**: The provided API key is not recognized or has been revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"API_KEY_MISSING","title":"API Key Missing","status":401,"detail":"The request did not include an API key. All API requests must be authenticated.","resolution":"Include your API key in the 'x-api-key' header with every request.","docs":"https://v2.docs.conduit.financial/errors#api-key-missing","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"type":"API_KEY_MISSING","title":"API Key Missing","status":401,"detail":"The request did not include an API key. All API requests must be authenticated.","resolution":"Include your API key in the 'x-api-key' header with every request.","docs":"https://v2.docs.conduit.financial/errors#api-key-missing","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"cf570930-bb5f-4aa8-ba6d-83fb6e0bcf48":{"description":"**ORGANIZATION_ACCESS_SUSPENDED**: Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.\n\n**FEATURE_NOT_ENABLED**: Your account does not have access to this feature. Features are enabled on a per-account basis.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"ORGANIZATION_ACCESS_SUSPENDED","title":"Organization Access Suspended","status":403,"detail":"Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.","resolution":"Contact Conduit support.","docs":"https://v2.docs.conduit.financial/errors#organization-access-suspended","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"type":"ORGANIZATION_ACCESS_SUSPENDED","title":"Organization Access Suspended","status":403,"detail":"Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.","resolution":"Contact Conduit support.","docs":"https://v2.docs.conduit.financial/errors#organization-access-suspended","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"c53feb14-27d1-4baa-a7a9-d2d98edf5e74":{"description":"**CUSTOMER_NOT_FOUND**: No customer exists with the specified ID, or the customer belongs to a different organization.\n\n**VIRTUAL_ACCOUNT_NOT_FOUND**: No virtual account exists for the requested customer and asset, or the virtual account belongs to a different organization.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"CUSTOMER_NOT_FOUND","title":"Customer Not Found","status":404,"detail":"No customer exists with the specified ID, or the customer belongs to a different organization.","resolution":"Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.","docs":"https://v2.docs.conduit.financial/errors#customer-not-found","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"type":"CUSTOMER_NOT_FOUND","title":"Customer Not Found","status":404,"detail":"No customer exists with the specified ID, or the customer belongs to a different organization.","resolution":"Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.","docs":"https://v2.docs.conduit.financial/errors#customer-not-found","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"ad3bc013-5c69-4007-8187-94a36435282a":{"description":"**RATE_LIMITED**: Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"retryAfterSeconds":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991,"description":"Seconds to wait before retrying","example":3,"isRequired":true,"uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp","retryAfterSeconds"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"RATE_LIMITED","title":"Rate Limited","status":429,"detail":"Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.","resolution":"Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.","docs":"https://v2.docs.conduit.financial/errors#rate-limited","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z","retryAfterSeconds":3},"examples":{"Example":{"title":"Example","value":{"type":"RATE_LIMITED","title":"Rate Limited","status":429,"detail":"Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.","resolution":"Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.","docs":"https://v2.docs.conduit.financial/errors#rate-limited","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z","retryAfterSeconds":3}}},"exampleType":"examples"}},"exampleType":"examples"},"3c4484bb-508b-453e-8b61-d124be7ef173":{"description":"**INTERNAL_ERROR**: An unexpected error occurred while processing your request.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Machine-readable error code","example":"CUSTOMER_NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","description":"Human-readable error type label","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"detail":{"type":"string","description":"Human-readable explanation of this occurrence","example":"Customer with id cus_034A0gCCVsxdV2PjHLx9k1 not found","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"resolution":{"type":"string","description":"What the developer should do to resolve this error","example":"Verify the customer ID. Check you are using the correct API key for this organization.","isRequired":true,"uniqueKey":"resolution","typeLabel":"string"},"docs":{"type":"string","description":"URL to error documentation","example":"https://v2.docs.conduit.financial/errors#customer-not-found","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"instance":{"type":"string","description":"Request path that produced the error","example":"/v2/customers/cus_034A0gCCVsxdV2PjHLx9k1","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp","example":"2026-04-27T20:00:00.000Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"correlationId":{"description":"Request correlation ID","example":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","type":"string","uniqueKey":"correlationId","typeLabel":"string"},"details":{"description":"Additional structured data for domain-specific errors (e.g. missing field lists, pair info)","uniqueKey":"details","typeLabel":"any"}},"required":["type","title","status","detail","resolution","docs","instance","timestamp"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"INTERNAL_ERROR","title":"Internal Error","status":500,"detail":"An unexpected error occurred while processing your request.","resolution":"Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.","docs":"https://v2.docs.conduit.financial/errors#internal-error","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"type":"INTERNAL_ERROR","title":"Internal Error","status":500,"detail":"An unexpected error occurred while processing your request.","resolution":"Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.","docs":"https://v2.docs.conduit.financial/errors#internal-error","instance":"/v2/...","correlationId":"00469ea4-52c1-4ffa-bd05-9f28b236a5fe","timestamp":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e216d117-afec-4a29-92f2-646b533f2725":{"api-key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"api-key"}}},"servers":{"5707e0ee-a73c-4f7a-b3dd-5e91e6ddef88":{"url":"https://api.sandbox.conduit.financial/v2","description":"Sandbox"},"107fb7ae-4503-4921-bfe7-67fa54c45455":{"url":"https://api.conduit.financial/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"x-api-key"}],"title":"api-key"}]},"originalFileLocation":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json"},"subdomain":"conduit-v2","siteName":"Conduit API","title":"Get a virtual account - Conduit API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T22:59:23.869Z","originalFileLocation":"api-reference/virtual-accounts/get-a-virtual-account.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Conduit API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_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/conduit-v2/aehrL9Bd40t-JxrL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a virtual account - Conduit API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Conduit API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://conduit-v2.mintlify.site/_mintlify/api/og/v2?division=Virtual+Accounts\u0026amp;title=Get+a+virtual+account\u0026amp;description=Retrieves+one+customer+virtual+account+with+client-safe+deposit+instructions.+Requires+the+virtual+account+feature+to+be+active.\u0026amp;theme=3d508c90c97bd7e1f652ff9d\u0026amp;signature=dae8cfd6525d6af4988da0c8614ebecf3cbd66550386dd40da2098429595e0a5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a virtual account - Conduit API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://conduit-v2.mintlify.site/_mintlify/api/og/v2?division=Virtual+Accounts\u0026amp;title=Get+a+virtual+account\u0026amp;description=Retrieves+one+customer+virtual+account+with+client-safe+deposit+instructions.+Requires+the+virtual+account+feature+to+be+active.\u0026amp;theme=3d508c90c97bd7e1f652ff9d\u0026amp;signature=dae8cfd6525d6af4988da0c8614ebecf3cbd66550386dd40da2098429595e0a5\">\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/conduit-v2/aehrL9Bd40t-JxrL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Conduit API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0445F5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/virtual-accounts/get-a-virtual-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.conduit.financial/#organization\",\"name\":\"Conduit API\",\"url\":\"https://docs.conduit.financial\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.conduit.financial#website\",\"name\":\"Conduit API\",\"url\":\"https://docs.conduit.financial\",\"publisher\":{\"@id\":\"https://docs.conduit.financial/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account#webpage\",\"url\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account\",\"name\":\"Get a virtual account\",\"description\":\"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\",\"dateModified\":\"2026-11-06T22:59:23.869Z\",\"isPartOf\":{\"@id\":\"https://docs.conduit.financial#website\"},\"breadcrumb\":{\"@id\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Virtual Accounts\",\"item\":\"https://docs.conduit.financial/api-reference/virtual-accounts/list-customer-virtual-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a virtual account\",\"item\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account#apireference\",\"headline\":\"Get a virtual account\",\"name\":\"Get a virtual account\",\"description\":\"Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active.\",\"url\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.conduit.financial/api-reference/virtual-accounts/get-a-virtual-account#webpage\"},\"dateModified\":\"2026-11-06T22:59:23.869Z\",\"publisher\":{\"@id\":\"https://docs.conduit.financial/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.conduit.financial#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Conduit API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Conduit API","nav":{"global":{"anchors":[{"anchor":"Trust Center","href":"https://trust.conduitpay.com/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Sandbox","pages":[{"title":"Sandbox","href":"/sandbox/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Conventions","href":"/api-reference/overview"},{"title":"OpenAPI Specification","href":"/sdks/openapi"},{"title":"Changelog","href":"/changelog"}]},{"group":"Errors","pages":[{"title":"Error Codes","href":"/errors"},{"group":"Recovery playbooks","pages":[{"title":"TRAVEL_RULE_REJECTED error","href":"/errors/travel-rule-rejected"},{"title":"SENDER_INFO_TIMEOUT error","href":"/errors/sender-info-timeout"},{"title":"USER_SIGNATURE_DECLINED error","href":"/errors/user-signature-declined"},{"title":"USER_SIGNATURE_TIMEOUT error","href":"/errors/user-signature-timeout"},{"title":"USER_SIGNATURE_REJECTED_BY_PROVIDER error","href":"/errors/user-signature-rejected-by-provider"},{"title":"COMPLIANCE_HOLD error","href":"/errors/compliance-hold"},{"title":"COMPLIANCE_REVIEW_REJECTED error","href":"/errors/compliance-review-rejected"},{"title":"CRYPTO_WALLET_MISCONFIGURED error","href":"/errors/crypto-wallet-misconfigured"},{"title":"RETURNED_BY_SENDER error","href":"/errors/returned-by-sender"},{"title":"PROVIDER_REJECTED error","href":"/errors/provider-rejected"},{"title":"RAIL_POLICY_REJECTED error","href":"/errors/rail-policy-rejected"},{"title":"INSUFFICIENT_FUNDS_AT_SETTLE error","href":"/errors/insufficient-funds-at-settle"},{"title":"RAIL_UNAVAILABLE error","href":"/errors/rail-unavailable"},{"title":"SANDBOX_TRANSACTION_NOT_FORCE_TERMINAL_READY error","href":"/errors/sandbox-transaction-not-force-terminal-ready"},{"title":"INVALID_ADDRESS_FORMAT error","href":"/errors/invalid-address-format"},{"title":"CUSTOMER_NOT_ONBOARDED","href":"/errors/customer-not-onboarded"},{"title":"RATE_UNAVAILABLE","href":"/errors/rate-unavailable"},{"title":"RATE_UNAVAILABLE_AFTER_HOURS","href":"/errors/rate-unavailable-after-hours"},{"title":"DOCUMENTATION_REQUIRED","href":"/errors/documentation-required"},{"title":"RECIPIENT_NOT_WHITELISTED","href":"/errors/recipient-not-whitelisted"},{"title":"PAYOUT_RAIL_CURRENCY_MISMATCH","href":"/errors/payout-rail-currency-mismatch"}]}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get a customer by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{id}","href":"/api-reference/customers/get-a-customer-by-id"},{"title":"Submit a customer update application","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/updates","href":"/api-reference/customers/submit-a-customer-update-application"}]},{"group":"Registered Addresses","pages":[{"title":"List registered addresses for a customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/registered-addresses","href":"/api-reference/registered-addresses/list-registered-addresses-for-a-customer"},{"title":"Register a wallet address for a customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallets/registered-addresses","href":"/api-reference/registered-addresses/register-a-wallet-address-for-a-customer"},{"title":"Get a registered address by id","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /wallets/registered-addresses/{id}","href":"/api-reference/registered-addresses/get-a-registered-address-by-id"},{"title":"Revoke (soft-delete) a registered address","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json delete /wallets/registered-addresses/{id}","href":"/api-reference/registered-addresses/revoke-soft-delete-a-registered-address"}]},{"group":"Wallets","pages":[{"title":"Claim non-custodial control for a customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallets/claim-non-custodial","href":"/api-reference/wallets/claim-non-custodial-control-for-a-customer"},{"title":"List customer wallets","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets","href":"/api-reference/wallets/list-customer-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallets","href":"/api-reference/wallets/create-a-wallet"},{"title":"List non-custodial claims","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/claims","href":"/api-reference/wallets/list-non-custodial-claims"},{"title":"Get a non-custodial claim by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/claims/{claimId}","href":"/api-reference/wallets/get-a-non-custodial-claim-by-id"},{"title":"Get a wallet by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/{walletId}","href":"/api-reference/wallets/get-a-wallet-by-id"},{"title":"Get wallet balances","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/{walletId}/balances","href":"/api-reference/wallets/get-wallet-balances"},{"title":"Get a wallet statement","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallets/{walletId}/statement","href":"/api-reference/wallets/get-a-wallet-statement"},{"title":"Rotate a wallet","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallets/{walletId}/rotate","href":"/api-reference/wallets/rotate-a-wallet"}]},{"group":"Wallet Signers","pages":[{"title":"List signers for a customer's wallets","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/wallet-signers","href":"/api-reference/wallet-signers/list-signers-for-a-customers-wallets"},{"title":"Add a signer to a customer's wallets","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers","href":"/api-reference/wallet-signers/add-a-signer-to-a-customers-wallets"},{"title":"Reissue a wallet signer's enrollment invite","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/reissue-invite","href":"/api-reference/wallet-signers/reissue-a-wallet-signers-enrollment-invite"},{"title":"Recover a signer's pending admin-approval link","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/reissue-admin-approval","href":"/api-reference/wallet-signers/recover-a-signers-pending-admin-approval-link"},{"title":"Start a passkey recovery for a signer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/recovery","href":"/api-reference/wallet-signers/start-a-passkey-recovery-for-a-signer"},{"title":"Cancel a signer's passkey recovery","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/recovery/cancel","href":"/api-reference/wallet-signers/cancel-a-signers-passkey-recovery"},{"title":"Remove a signer from a customer's wallets","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json delete /customers/{customerId}/wallet-signers/{signerId}","href":"/api-reference/wallet-signers/remove-a-signer-from-a-customers-wallets"},{"title":"Promote a signer to admin in place of an admin","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/promote","href":"/api-reference/wallet-signers/promote-a-signer-to-admin-in-place-of-an-admin"},{"title":"Demote an admin","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/wallet-signers/{signerId}/demote","href":"/api-reference/wallet-signers/demote-an-admin"}]},{"group":"Signing Quorum","pages":[{"title":"Get a customer's signing quorum configuration","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/signing-quorum","href":"/api-reference/signing-quorum/get-a-customers-signing-quorum-configuration"},{"title":"Set a customer's signing quorum threshold","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json put /customers/{customerId}/signing-quorum","href":"/api-reference/signing-quorum/set-a-customers-signing-quorum-threshold"},{"title":"Override a wallet's signing quorum threshold","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json put /wallets/{walletId}/signing-quorum","href":"/api-reference/signing-quorum/override-a-wallets-signing-quorum-threshold"},{"title":"Clear a wallet's signing quorum override","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json delete /wallets/{walletId}/signing-quorum","href":"/api-reference/signing-quorum/clear-a-wallets-signing-quorum-override"}]},{"group":"Virtual Accounts","pages":[{"title":"List customer virtual accounts","description":"Returns a paginated list of virtual accounts for the customer with client-safe deposit instructions. Requires the virtual account feature to be active.","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts","href":"/api-reference/virtual-accounts/list-customer-virtual-accounts"},{"title":"Get a virtual account","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId}","href":"/api-reference/virtual-accounts/get-a-virtual-account"},{"title":"Get virtual account balances","description":"Returns what the virtual account holds, in the account's own asset. Give `date` to read what it held at the end of that UTC day. Omit `date` to read what it holds now, which is the same figure the virtual account resource carries.","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId}/balances","href":"/api-reference/virtual-accounts/get-virtual-account-balances"},{"title":"Get a virtual account statement","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId}/statement","href":"/api-reference/virtual-accounts/get-a-virtual-account-statement"}]},{"group":"Applications","pages":[{"title":"List all applications","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /applications","href":"/api-reference/applications/list-all-applications"},{"title":"Get an application by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /applications/{id}","href":"/api-reference/applications/get-an-application-by-id"},{"title":"Cancel an application","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /applications/{id}/cancel","href":"/api-reference/applications/cancel-an-application"},{"title":"Get an identity-verification link for a person","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /applications/{applicationId}/persons/{referenceId}/idv-link","href":"/api-reference/applications/get-an-identity-verification-link-for-a-person"}]},{"group":"Verifications","pages":[{"title":"Initiate a customer verification","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/verifications","href":"/api-reference/verifications/initiate-a-customer-verification"}]},{"group":"Signing Requests","pages":[{"title":"List signing requests awaiting a machine signature","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /signing-requests","href":"/api-reference/signing-requests/list-signing-requests-awaiting-a-machine-signature"},{"title":"Get a signing request","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /signing-requests/{id}","href":"/api-reference/signing-requests/get-a-signing-request"},{"title":"Approve a signing request with a machine stamp","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /signing-requests/{id}/approve","href":"/api-reference/signing-requests/approve-a-signing-request-with-a-machine-stamp"},{"title":"Reject a signing request with a machine stamp","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /signing-requests/{id}/reject","href":"/api-reference/signing-requests/reject-a-signing-request-with-a-machine-stamp"}]},{"group":"Transactions","pages":[{"title":"Submit sender (originator) information for a deposit parked on UNREGISTERED_ADDRESS","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /transactions/{id}/sender-information","href":"/api-reference/transactions/submit-sender-originator-information-for-a-deposit-parked-on-unregistered_address"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get a transaction by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /transactions/{id}","href":"/api-reference/transactions/get-a-transaction-by-id"}]},{"group":"Payouts","pages":[{"title":"Discover payout requirements","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /payouts/requirements","href":"/api-reference/payouts/discover-payout-requirements"},{"title":"Preview payout requirements","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /payouts/requirements","href":"/api-reference/payouts/preview-payout-requirements"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /payouts","href":"/api-reference/payouts/create-a-payout"},{"title":"Retrieve a payout","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /payouts/{id}","href":"/api-reference/payouts/retrieve-a-payout"},{"title":"Cancel a pending payout","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /payouts/{id}/cancel","href":"/api-reference/payouts/cancel-a-pending-payout"}]},{"group":"RFIs","pages":[{"title":"List RFIs","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /rfis","href":"/api-reference/rfis/list-rfis"},{"title":"Get an RFI by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /rfis/{id}","href":"/api-reference/rfis/get-an-rfi-by-id"},{"title":"Acknowledge an RFI","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /rfis/{id}/acknowledge","href":"/api-reference/rfis/acknowledge-an-rfi"},{"title":"Respond to an RFI","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /rfis/{id}/responses","href":"/api-reference/rfis/respond-to-an-rfi"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /documents","href":"/api-reference/documents/list-documents"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /documents","href":"/api-reference/documents/upload-a-document"},{"title":"Get a document by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /documents/{id}","href":"/api-reference/documents/get-a-document-by-id"},{"title":"Get a download URL for a document","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /documents/{id}/download","href":"/api-reference/documents/get-a-download-url-for-a-document"}]},{"group":"Payee checks","pages":[{"title":"Check a payee name","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /payee-checks","href":"/api-reference/payee-checks/check-a-payee-name"}]},{"group":"Whitelist Recipients","pages":[{"title":"List whitelist recipients for a customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/whitelist-recipients","href":"/api-reference/whitelist-recipients/list-whitelist-recipients-for-a-customer"},{"title":"Register an intercompany recipient for whitelisting","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/whitelist-recipients","href":"/api-reference/whitelist-recipients/register-an-intercompany-recipient-for-whitelisting"},{"title":"Get a whitelist recipient by id","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/whitelist-recipients/{id}","href":"/api-reference/whitelist-recipients/get-a-whitelist-recipient-by-id"},{"title":"Revoke a whitelist recipient","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json delete /customers/{customerId}/whitelist-recipients/{id}","href":"/api-reference/whitelist-recipients/revoke-a-whitelist-recipient"}]},{"group":"Orders","pages":[{"title":"List orders for the authenticated organization","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /orders","href":"/api-reference/orders/list-orders-for-the-authenticated-organization"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /orders","href":"/api-reference/orders/create-an-order"},{"title":"List required recipient fields","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /orders/requirements","href":"/api-reference/orders/list-required-recipient-fields"},{"title":"Retrieve an order by id","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /orders/{id}","href":"/api-reference/orders/retrieve-an-order-by-id"},{"title":"Cancel a pending order","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /orders/{id}/cancel","href":"/api-reference/orders/cancel-a-pending-order"},{"title":"Execute a pending order","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /orders/{id}/execute","href":"/api-reference/orders/execute-a-pending-order"}]},{"group":"Asset Chain Pairs","pages":[{"title":"List offerable asset/chain pairs","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /asset-chain-pairs","href":"/api-reference/asset-chain-pairs/list-offerable-assetchain-pairs"}]},{"group":"Quotes","pages":[{"title":"Price a conversion, payout, or withdrawal","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /quotes","href":"/api-reference/quotes/price-a-conversion-payout-or-withdrawal"}]},{"group":"Webhook Endpoints","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /webhooks/endpoints","href":"/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /webhooks/endpoints","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /webhooks/endpoints/{id}","href":"/api-reference/webhook-endpoints/get-a-webhook-endpoint-by-id"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json delete /webhooks/endpoints/{id}","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json patch /webhooks/endpoints/{id}","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"Rotate a webhook endpoint's signing secret","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /webhooks/endpoints/{id}/rotate","href":"/api-reference/webhook-endpoints/rotate-a-webhook-endpoints-signing-secret"}]},{"group":"Webhook Deliveries","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /webhooks/deliveries","href":"/api-reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get a delivery by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /webhooks/deliveries/{id}","href":"/api-reference/webhook-deliveries/get-a-delivery-by-id"},{"title":"Retry a failed delivery","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /webhooks/deliveries/{id}/retry","href":"/api-reference/webhook-deliveries/retry-a-failed-delivery"}]},{"group":"Webhook Event Types","pages":[{"title":"List available webhook event types","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /webhooks/event-types","href":"/api-reference/webhook-event-types/list-available-webhook-event-types"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /events","href":"/api-reference/events/list-events"},{"title":"Get an event by ID","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /events/{id}","href":"/api-reference/events/get-an-event-by-id"}]},{"group":"Features","pages":[{"title":"Submit a feature request","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /customers/{customerId}/features","href":"/api-reference/features/submit-a-feature-request"},{"title":"Discover feature requirements for a customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/features/requirements","href":"/api-reference/features/discover-feature-requirements-for-a-customer"}]},{"group":"Customer Onboarding","pages":[{"title":"Submit a customer onboarding application","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /onboarding","href":"/api-reference/customer-onboarding/submit-a-customer-onboarding-application"},{"title":"Discover onboarding requirements for a country","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /onboarding/requirements","href":"/api-reference/customer-onboarding/discover-onboarding-requirements-for-a-country"},{"title":"Discover selectable policy-subject catalog options for an axis","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /onboarding/policy-subjects","href":"/api-reference/customer-onboarding/discover-selectable-policy-subject-catalog-options-for-an-axis"}]},{"group":"Markup","pages":[{"title":"Accrued markup balances","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /markup/balances","href":"/api-reference/markup/accrued-markup-balances"},{"title":"Monthly markup statements","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /markup/statements","href":"/api-reference/markup/monthly-markup-statements"},{"title":"Markup statement lines","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /markup/statement-lines","href":"/api-reference/markup/markup-statement-lines"}]},{"group":"Sandbox","pages":[{"title":"Mark a sandbox customer as a house account","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json patch /sandbox/customers/{customerId}/house-account","href":"/api-reference/sandbox/mark-a-sandbox-customer-as-a-house-account"},{"title":"Reset a sandbox customer's wallet claim","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/customers/{customerId}/simulate-reset-claim","href":"/api-reference/sandbox/reset-a-sandbox-customers-wallet-claim"},{"title":"Resolve a registered address parked in screening review (sandbox only)","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/wallets/registered-addresses/{id}/simulate/compliance-decision","href":"/api-reference/sandbox/resolve-a-registered-address-parked-in-screening-review-sandbox-only"},{"title":"Simulate the compliance verdict on a sandbox application","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/applications/{id}/simulate/decision","href":"/api-reference/sandbox/simulate-the-compliance-verdict-on-a-sandbox-application"},{"title":"Simulate fiat-rail settlement for a sandbox payout","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/payouts/{id}/simulate/settled","href":"/api-reference/sandbox/simulate-fiat-rail-settlement-for-a-sandbox-payout"},{"title":"Simulate a Travel Rule counterparty webhook for a sandbox payout","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/payouts/{id}/simulate/counterparty-webhook","href":"/api-reference/sandbox/simulate-a-travel-rule-counterparty-webhook-for-a-sandbox-payout"},{"title":"Release a sandbox payout held for review","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/payouts/{id}/simulate-review-approve","href":"/api-reference/sandbox/release-a-sandbox-payout-held-for-review"},{"title":"Reject a sandbox payout held for review","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/payouts/{id}/simulate-review-reject","href":"/api-reference/sandbox/reject-a-sandbox-payout-held-for-review"},{"title":"Resolve a funding transfer held for compliance review (sandbox only)","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/orders/{orderId}/deposits/simulate/compliance-decision","href":"/api-reference/sandbox/resolve-a-funding-transfer-held-for-compliance-review-sandbox-only"},{"title":"Simulate an overall conversion failure for a sandbox order","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/orders/{id}/simulate/conversion-failed","href":"/api-reference/sandbox/simulate-an-overall-conversion-failure-for-a-sandbox-order"},{"title":"Simulate a transaction terminal outcome (sandbox only)","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/transactions/{id}/simulate/terminal","href":"/api-reference/sandbox/simulate-a-transaction-terminal-outcome-sandbox-only"},{"title":"Return a completed transaction from the bank (sandbox only)","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/transactions/{id}/simulate/return","href":"/api-reference/sandbox/return-a-completed-transaction-from-the-bank-sandbox-only"},{"title":"Resolve a transaction parked for compliance review (sandbox only)","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/transactions/{id}/simulate/compliance-decision","href":"/api-reference/sandbox/resolve-a-transaction-parked-for-compliance-review-sandbox-only"},{"title":"Simulate a fiat deposit to a sandbox virtual account","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/customers/{customerId}/virtual-accounts/{virtualAccountId}/deposits/simulate","href":"/api-reference/sandbox/simulate-a-fiat-deposit-to-a-sandbox-virtual-account"},{"title":"Simulate a Conduit compliance RFI on a sandbox customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/rfis/simulate","href":"/api-reference/sandbox/simulate-a-conduit-compliance-rfi-on-a-sandbox-customer"},{"title":"Simulate the resolution of a sandbox RFI","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/rfis/{id}/simulate/resolve","href":"/api-reference/sandbox/simulate-the-resolution-of-a-sandbox-rfi"},{"title":"Simulate a request for more information on a sandbox RFI","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/rfis/{id}/simulate/more-info","href":"/api-reference/sandbox/simulate-a-request-for-more-information-on-a-sandbox-rfi"},{"title":"Simulate compliance approval of a pending whitelist registration","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/whitelist-recipients/{id}/simulate-approve","href":"/api-reference/sandbox/simulate-compliance-approval-of-a-pending-whitelist-registration"},{"title":"Simulate compliance rejection of a pending whitelist registration","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/whitelist-recipients/{id}/simulate-reject","href":"/api-reference/sandbox/simulate-compliance-rejection-of-a-pending-whitelist-registration"},{"title":"Force a sandbox order's rate lock to expire immediately","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/orders/{id}/simulate/rate-lock-expired","href":"/api-reference/sandbox/force-a-sandbox-orders-rate-lock-to-expire-immediately"},{"title":"Simulate a Conduit restriction on a sandbox customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/customers/{customerId}/simulate/restrict","href":"/api-reference/sandbox/simulate-a-conduit-restriction-on-a-sandbox-customer"},{"title":"Simulate a lifted restriction on a sandbox customer","deprecated":null,"version":null,"openapi":"https://api.sandbox.conduit.financial/v2/api-docs/openapi.json post /sandbox/customers/{customerId}/simulate/lift-restriction","href":"/api-reference/sandbox/simulate-a-lifted-restriction-on-a-sandbox-customer"}]}]},{"tab":"KYB Reference","pages":[{"title":"KYB Reference","href":"/kyb/overview"}]}]},"basePath":"","title":"Get a virtual account - Conduit API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C945cI-W.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}