Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.
Your own key for this write, ^[A-Za-z0-9._:-]{1,128}$. A retry with the same key replays the first answer; the same key with a different request is refused.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HEVN","description":"HEVN documentation: the whitelabel REST API for linking and operating your customers' own accounts, remote transfers for paying from your own account with a capped key, and how the non-custodial platform underneath works.","colors":{"primary":"#256FAD","light":"#3C8DCE","dark":"#1B527F"},"logo":{"light":"https://mintcdn.com/hevninc/to0nUVRkO9X57VRK/logo/light.svg?fit=max\u0026auto=format\u0026n=to0nUVRkO9X57VRK\u0026q=85\u0026s=0d24037b3480e3fd22fdbc2ea7c2a1bf","dark":"https://mintcdn.com/hevninc/to0nUVRkO9X57VRK/logo/dark.svg?fit=max\u0026auto=format\u0026n=to0nUVRkO9X57VRK\u0026q=85\u0026s=ae6bd68499f79b907f010902b41a52e8"},"favicon":"https://mintcdn.com/hevninc/BoTZRcp0gyv2H79f/favicon.png?fit=max\u0026auto=format\u0026n=BoTZRcp0gyv2H79f\u0026q=85\u0026s=0d529d33047e81a45ef91637a41645b1","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://calendly.com/hevn/hevn","label":"Book a call"}],"primary":{"type":"button","label":"Open app","href":"https://app.gethevn.com"}},"icons":{"library":"lucide"},"markdown":{"instructions":["HEVN accounts are non-custodial in both products. Self-serve (the General tab): the person who owns the email holds the only key and signs for themselves. Whitelabel (the Whitelabel and REST API tabs): the integrator's customer creates and owns their account through Sign in with HEVN, a HEVN-hosted popup on the integrator's site; the integrator's backend holds a developer key, operates linked accounts and books their payouts, and the account holder approves every payout in that popup. The developer key signs only for the integrator's own wallet; it never signs a client's money.","Use HEVN's terms exactly. A rail is a bank route a client can request. A virtual account (bnk_) is an opened rail. Account details are what a payer needs in order to wire money, and arrive in a field named requisites. A client is a customer's own account linked to the integrator through Sign in with HEVN (POST /dapi/v1/connect/sessions, then POST /dapi/v1/clients/link); there is no API call that creates one. The business behind it is the integrator's customer. A contact is a saved destination; a beneficiary is the party at the far end of a fiat payout. Every departure of money is a payout, to a bank account or to a wallet alike.","Never name a banking partner. Say 'a licensed banking partner'.","There are no published fee rates, spreads or minimums. Prices come from a quote on a specific payment; direct pricing questions to HEVN rather than inventing numbers.","The whitelabel API is at /dapi/v1 and takes a developer-key session plus an X-Hevn-Account header. Developer keys have an IP allowlist and no scopes. Remote transfers are at /api/v1/remote_spend_limit and take a remote transfer key (rsl_) in X-Api-Key, bounded by an onchain spend permission the account holder grants. They are different credentials and neither works on the other surface. The HEVN CLI is discontinued."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hevninc","hasAudioNarration":false,"actualSubdomain":"hevninc","customDomains":[],"gitSource":{"type":"github","owner":"hevn-inc","repo":"docs","deployBranch":"main","isPrivate":false,"contentDirectory":"","mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"agentFeedback":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6af5f1ed510572438570ff24","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"REST API","count":51},{"language":"default","tag":"Whitelabel","count":29},{"language":"default","tag":"General","count":10},{"language":"default","tag":"Escrow","count":8},{"language":"default","tag":"Reference","count":7},{"language":"default","tag":"Clients","count":6},{"language":"default","tag":"Contacts","count":6},{"language":"default","tag":"Core concepts","count":5},{"language":"default","tag":"Verification","count":5},{"language":"default","tag":"Overview","count":4}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/virtual-accounts/request-a-receiving-account-for-a-product","slug":"/api-reference/virtual-accounts/request-a-receiving-account-for-a-product","pageMetadata":{"title":"Request a receiving account for a product","description":"Answers 201 with the account record the first time, 200 with `Idempotency-Replayed: true` when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.","deprecated":null,"version":null,"openapi":"/openapi.json post /banks","href":"/api-reference/virtual-accounts/request-a-receiving-account-for-a-product","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Answers 201 with the account record the first time, 200 with \", _jsx(_components.code, {\n children: \"Idempotency-Replayed: true\"\n }), \" when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\"]\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":"Request a receiving account for a product","description":"Answers 201 with the account record the first time, 200 with `Idempotency-Replayed: true` when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.","deprecated":null,"version":null,"openapi":"/openapi.json post /banks","href":"/api-reference/virtual-accounts/request-a-receiving-account-for-a-product","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["virtual accounts"],"summary":"Request a receiving account for a product","description":"Answers 201 with the account record the first time, 200 with `Idempotency-Replayed: true` when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.","operationId":"open_rail_banks_post","security":["11fb237f-ff08-4a99-8142-165879c2c8f5"],"parameters":["e7656899-9c46-415a-94f4-89066116eeeb","28925454-b091-4aeb-8ec8-fa0ad905ab6b"],"requestBody":"20693c44-177a-4279-8553-1cab921c8837","responses":{"201":"bcd3c70a-9e86-418c-aa5e-e067114d2fed","422":"5c514874-71c8-4f15-847f-211faaef6849"},"method":"post","type":"path","servers":[],"path":"/banks","baseUrlOptions":[],"title":"Request a receiving account for a product","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e7656899-9c46-415a-94f4-89066116eeeb":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"Idempotency-Key","description":"Your own key for this write, `^[A-Za-z0-9._:-]{1,128}$`. A retry with the same key replays the first answer; the same key with a different request is refused.","example":"po-inv-2026-114","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Idempotency-Key","description":"Your own key for this write, `^[A-Za-z0-9._:-]{1,128}$`. A retry with the same key replays the first answer; the same key with a different request is refused.","example":"po-inv-2026-114","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Your own key for this write, `^[A-Za-z0-9._:-]{1,128}$`. A retry with the same key replays the first answer; the same key with a different request is refused."},"28925454-b091-4aeb-8ec8-fa0ad905ab6b":{"name":"X-Hevn-Account","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Hevn-Account","description":"The client account to act for, as a `cl_…` id. Omit it to act as yourself.","example":"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Hevn-Account","description":"The client account to act for, as a `cl_…` id. Omit it to act as yourself.","example":"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The client account to act for, as a `cl_…` id. Omit it to act as yourself."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product":{"type":"string","enum":["us","swift","eu","uae","uk","br","mx","co","ar","au","ng","ca","dk","no","pl","tr","il","sa","bo","cl","cr","do","gt","hn","jm","eg","sl","tz","ug","waemu","zm","bd","cn","hk","in","id","jp","my","pk","ph","kr","th","vn","card"],"title":"RailProduct","description":"Region product to request.","isRequired":true,"uniqueKey":"product","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"type":"object","required":["product"],"title":"RailOpenRequest","uniqueKey":"","typeLabel":"RailOpenRequest · object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bcd3c70a-9e86-418c-aa5e-e067114d2fed":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"product":{"type":"string","enum":["us","swift","eu","uae","uk","br","mx","co","ar","au","ng","ca","dk","no","pl","tr","il","sa","bo","cl","cr","do","gt","hn","jm","eg","sl","tz","ug","waemu","zm","bd","cn","hk","in","id","jp","my","pk","ph","kr","th","vn","card"],"title":"RailProduct","description":"Region product this receiving account serves.","isRequired":true,"uniqueKey":"product","typeLabel":"enum\u003cstring>"},"rail":{"type":"string","title":"Rail","description":"Rail serving this product. Informational; address the account by product.","isRequired":true,"uniqueKey":"rail","typeLabel":"string"},"currency":{"type":"string","title":"Currency","description":"ISO 4217 fiat currency code received through this payment method.","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"railCurrency":{"type":"string","enum":["USD","EUR","USDC","EURC","RD","USDC_ARB"],"title":"BankDepositCurrency","description":"Asset credited after funds arrive through this rail.","isRequired":true,"uniqueKey":"railCurrency","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["sepa","swift","ach","uaefts","fedwire","rtp","fednow","pix","spei","pse","breb","transfers_3_0","ukfps","npp","nip","bdt_local","bdt_ewallet","bob_local","brl_local","cad_eft","clp_local","cny_alipay","cny_wechatpay","cop_local","crc_local","dkk_local","dop_local","dop_ewallet","egp_local","gtq_local","gtq_ewallet","hkd_fps","hnl_local","idr_local","idr_ewallet","ils_local","inr_local","inr_upi","jmd_local","jpy_local","krw_local","myr_local","nok_local","php_local","php_ewallet","pkr_raast","pkr_ewallet","pln_local","sar_local","sle_local","thb_local","try_fast","tzs_local","ugx_local","vnd_local","xof_local","zmw_local"],"title":"FiatPaymentType","description":"Payment network or method represented by this rail.","isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"opened":{"type":"boolean","title":"Opened","description":"Whether receiving details have been provisioned for this payment method.","isRequired":true,"uniqueKey":"opened","typeLabel":"boolean"},"feeBps":{"type":"integer","title":"Feebps","description":"Variable fee in basis points; 100 basis points equals 1 percent.","isRequired":true,"uniqueKey":"feeBps","typeLabel":"integer"},"supportedAccounts":{"items":{"type":"string","enum":["USDC","EURC","RD","USDC_ARB","FDIC_USD","FDIC_EUR","KYC_CARDS"],"title":"AccountKey","uniqueKey":"supportedAccounts.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","title":"Supportedaccounts","description":"Accounts this payment method can settle to.","isRequired":true,"uniqueKey":"supportedAccounts","typeLabel":"enum\u003cstring>[]"},"status":{"oneOf":[{"type":"string","title":"RailStatus","description":"Current virtual-account lifecycle status.","enum":["preparing","active","suspended","closed"],"uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Current virtual-account lifecycle status.","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"enum\u003cstring> | null"},"destinationAccount":{"oneOf":[{"type":"string","title":"AccountKey","description":"Account credited on settlement.","enum":["USDC","EURC","RD","USDC_ARB","FDIC_USD","FDIC_EUR","KYC_CARDS"],"uniqueKey":"destinationAccount.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Account credited on settlement.","uniqueKey":"destinationAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"destinationAccount","typeLabel":"enum\u003cstring> | null"},"minimumDeposit":{"oneOf":[{"type":"string","title":"Minimumdeposit","description":"Minimum amount accepted through this method.","example":"500.00","uniqueKey":"minimumDeposit.oneOf.0","typeLabel":"string"},{"type":"null","title":"Minimumdeposit","description":"Minimum amount accepted through this method.","uniqueKey":"minimumDeposit.oneOf.1","typeLabel":"null"}],"uniqueKey":"minimumDeposit","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","title":"Id","description":"Opened virtual-account identifier.","pattern":"^(?:bnk_)?[A-Za-z0-9._:\\-]{1,216}$","example":"bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","description":"Opened virtual-account identifier.","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"requisites":{"oneOf":[{"type":"object","title":"RailRequisitesView","description":"Receiving details, present after the virtual account becomes active.","required":["fields","holder","state"],"properties":{"fields":{"properties":{"iban":{"oneOf":[{"type":"string","title":"Iban","description":"International account identifier without display separators.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.iban.oneOf.0","typeLabel":"string"},{"type":"null","title":"Iban","description":"International account identifier without display separators.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.iban.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.iban","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","title":"Bic","description":"BIC or SWIFT identifier of the destination institution.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.bic.oneOf.0","typeLabel":"string"},{"type":"null","title":"Bic","description":"BIC or SWIFT identifier of the destination institution.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.bic.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.bic","typeLabel":"string | null"},"accountNumber":{"oneOf":[{"type":"string","title":"Accountnumber","description":"Domestic account number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Accountnumber","description":"Domestic account number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountNumber","typeLabel":"string | null"},"routingNumber":{"oneOf":[{"type":"string","title":"Routingnumber","description":"Domestic routing or clearing number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.routingNumber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Routingnumber","description":"Domestic routing or clearing number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.routingNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.routingNumber","typeLabel":"string | null"},"pixKey":{"oneOf":[{"type":"string","title":"Pixkey","description":"Brazil PIX destination key.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKey.oneOf.0","typeLabel":"string"},{"type":"null","title":"Pixkey","description":"Brazil PIX destination key.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKey.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKey","typeLabel":"string | null"},"pixKeyType":{"oneOf":[{"type":"string","title":"RequisitePixKeyType","description":"Type of Brazil PIX key.","enum":["phone","email","tax_id","random"],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKeyType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of Brazil PIX key.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKeyType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.pixKeyType","typeLabel":"enum\u003cstring> | null"},"paymentKey":{"oneOf":[{"type":"string","title":"Paymentkey","description":"Local payment key required by the selected method.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.paymentKey.oneOf.0","typeLabel":"string"},{"type":"null","title":"Paymentkey","description":"Local payment key required by the selected method.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.paymentKey.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.paymentKey","typeLabel":"string | null"},"financialInstitutionId":{"oneOf":[{"type":"string","title":"Financialinstitutionid","description":"Institution identifier from the method directory.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.financialInstitutionId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Financialinstitutionid","description":"Institution identifier from the method directory.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.financialInstitutionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.financialInstitutionId","typeLabel":"string | null"},"branchNumber":{"oneOf":[{"type":"string","title":"Branchnumber","description":"Destination institution branch identifier.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.branchNumber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Branchnumber","description":"Destination institution branch identifier.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.branchNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.branchNumber","typeLabel":"string | null"},"accountKind":{"oneOf":[{"type":"string","title":"RequisiteAccountKind","description":"Checking, savings or equivalent classification.","enum":["checking","savings","deposit","salary","other"],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountKind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Checking, savings or equivalent classification.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountKind.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.accountKind","typeLabel":"enum\u003cstring> | null"},"phoneNumber":{"oneOf":[{"type":"string","title":"Phonenumber","description":"Phone number required by the selected local method.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phonenumber","description":"Phone number required by the selected local method.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.fields.phoneNumber","typeLabel":"string | null"}},"type":"object","required":["iban","bic","accountNumber","routingNumber","pixKey","pixKeyType","paymentKey","financialInstitutionId","branchNumber","accountKind","phoneNumber"],"title":"RequisiteFields","description":"Structured receiving details for this payment method.","isRequired":true,"uniqueKey":"requisites.oneOf.0.fields","typeLabel":"RequisiteFields · object"},"holder":{"properties":{"type":{"type":"string","enum":["individual","business"],"title":"RequisiteHolderType","description":"Whether the account holder is an individual or a business.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.type","typeLabel":"enum\u003cstring>"},"firstName":{"oneOf":[{"type":"string","title":"Firstname","description":"Legal given name of an individual holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.firstName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Firstname","description":"Legal given name of an individual holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","title":"Lastname","description":"Legal family name of an individual holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.lastName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lastname","description":"Legal family name of an individual holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.lastName","typeLabel":"string | null"},"businessName":{"oneOf":[{"type":"string","title":"Businessname","description":"Registered legal name of a business holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.businessName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Businessname","description":"Registered legal name of a business holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.businessName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.businessName","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","title":"UserAddress","description":"Postal address of the account holder.","required":["streetAddress","addressLine2","city","state","country","zip"],"properties":{"streetAddress":{"oneOf":[{"type":"string","title":"Streetaddress","description":"Street name and building number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.streetAddress.oneOf.0","typeLabel":"string"},{"type":"null","title":"Streetaddress","description":"Street name and building number.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.streetAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.streetAddress","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","title":"Addressline2","description":"Optional apartment, suite or unit.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Addressline2","description":"Optional apartment, suite or unit.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.addressLine2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"City or locality.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"City or locality.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"State, province or administrative area.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State, province or administrative area.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"CountryCode","description":"ISO 3166-1 alpha-2 country code.","enum":["AF","AX","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","XK","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"],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"zip":{"oneOf":[{"type":"string","title":"Zip","description":"Postal or ZIP code.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zip","description":"Postal or ZIP code.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0.zip","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.0","typeLabel":"UserAddress · object"},{"type":"null","description":"Postal address of the account holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.address","typeLabel":"UserAddress · object | null"},"idType":{"oneOf":[{"type":"string","title":"RequisiteIdType","description":"Government identifier type for the holder.","enum":["passport","national_id","foreigner_id","temporary_permit","minor_id","driving_license","resident_card","tax_id","other"],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Government identifier type for the holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idType","typeLabel":"enum\u003cstring> | null"},"idNumber":{"oneOf":[{"type":"string","title":"Idnumber","description":"Government identifier number for the holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idNumber.oneOf.0","typeLabel":"string"},{"type":"null","title":"Idnumber","description":"Government identifier number for the holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.idNumber","typeLabel":"string | null"},"taxId":{"oneOf":[{"type":"string","title":"Taxid","description":"Tax identifier of the holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.taxId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Taxid","description":"Tax identifier of the holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.taxId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.taxId","typeLabel":"string | null"},"nationality":{"oneOf":[{"type":"string","title":"Nationality","description":"ISO country code of the holder's nationality.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.nationality.oneOf.0","typeLabel":"string"},{"type":"null","title":"Nationality","description":"ISO country code of the holder's nationality.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.nationality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requisites.oneOf.0.holder.nationality","typeLabel":"string | null"}},"type":"object","required":["type","firstName","lastName","businessName","address","idType","idNumber","taxId","nationality"],"title":"RequisiteHolder","description":"Identity and address of the receiving account holder.","isRequired":true,"uniqueKey":"requisites.oneOf.0.holder","typeLabel":"RequisiteHolder · object"},"state":{"type":"string","enum":["active","pending","closed"],"title":"RequisiteState","description":"Current usability state of the receiving details.","isRequired":true,"uniqueKey":"requisites.oneOf.0.state","typeLabel":"enum\u003cstring>"},"bankName":{"oneOf":[{"type":"string","title":"Bankname","description":"Name of the receiving financial institution.","uniqueKey":"requisites.oneOf.0.bankName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Bankname","description":"Name of the receiving financial institution.","uniqueKey":"requisites.oneOf.0.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"requisites.oneOf.0.bankName","typeLabel":"string | null"},"paymentReference":{"oneOf":[{"type":"string","title":"Paymentreference","description":"Reference or memo that must accompany the account transfer.","uniqueKey":"requisites.oneOf.0.paymentReference.oneOf.0","typeLabel":"string"},{"type":"null","title":"Paymentreference","description":"Reference or memo that must accompany the account transfer.","uniqueKey":"requisites.oneOf.0.paymentReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"requisites.oneOf.0.paymentReference","typeLabel":"string | null"}},"uniqueKey":"requisites.oneOf.0","typeLabel":"RailRequisitesView · object"},{"type":"null","description":"Receiving details, present after the virtual account becomes active.","uniqueKey":"requisites.oneOf.1","typeLabel":"null"}],"uniqueKey":"requisites","typeLabel":"RailRequisitesView · object | null"},"blockers":{"items":{"properties":{"code":{"type":"string","title":"Code","description":"Stable machine-readable code for this blocker.","isRequired":true,"uniqueKey":"blockers.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","title":"Field","description":"Profile or verification field associated with this blocker.","isRequired":true,"uniqueKey":"blockers.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"Human-readable explanation safe to show to an end user.","isRequired":true,"uniqueKey":"blockers.items.[INDEX].message","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Url","description":"Page the client opens to clear this blocker, when there is one.","uniqueKey":"blockers.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","description":"Page the client opens to clear this blocker, when there is one.","uniqueKey":"blockers.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"blockers.items.[INDEX].url","typeLabel":"string | null"}},"type":"object","required":["code","field","message"],"title":"RailBlockerView","uniqueKey":"blockers.items.[INDEX]","typeLabel":"RailBlockerView · object"},"type":"array","title":"Blockers","description":"What still stands between this request and active receiving details.","uniqueKey":"blockers","typeLabel":"RailBlockerView · object[]"}},"type":"object","required":["product","rail","currency","railCurrency","method","opened","feeBps","supportedAccounts"],"title":"RailView","uniqueKey":"","typeLabel":"RailView · object"},"examples":{"Example":{"title":"Example","value":{"product":"us","rail":"\u003cstring>","currency":"\u003cstring>","railCurrency":"USD","method":"sepa","opened":true,"feeBps":123,"supportedAccounts":["USDC"],"status":"preparing","destinationAccount":"USDC","minimumDeposit":"500.00","id":"bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41","requisites":{"fields":{"iban":"\u003cstring>","bic":"\u003cstring>","accountNumber":"\u003cstring>","routingNumber":"\u003cstring>","pixKey":"\u003cstring>","pixKeyType":"phone","paymentKey":"\u003cstring>","financialInstitutionId":"\u003cstring>","branchNumber":"\u003cstring>","accountKind":"checking","phoneNumber":"\u003cstring>"},"holder":{"type":"individual","firstName":"\u003cstring>","lastName":"\u003cstring>","businessName":"\u003cstring>","address":{"streetAddress":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"AF","zip":"\u003cstring>"},"idType":"passport","idNumber":"\u003cstring>","taxId":"\u003cstring>","nationality":"\u003cstring>"},"state":"active","bankName":"\u003cstring>","paymentReference":"\u003cstring>"},"blockers":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>","url":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5c514874-71c8-4f15-847f-211faaef6849":{"description":"Request validation failed","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","enum":["invalid_request","validation_failed","invalid_cursor","invalid_id","idempotency_key_invalid","idempotency_key_reused","unauthenticated","token_expired","forbidden","not_found","method_not_allowed","conflict","gone","payload_too_large","rate_limited","provider_unavailable","database_unavailable","internal_error","invalid_credentials","request_expired","challenge_not_found","challenge_consumed","challenge_expired","signature_invalid","key_not_registered","signer_not_attached","wallet_not_linked","approval_consumed","approval_expired","approval_mismatch","signing_policy_refused","login_unavailable","login_mode_unavailable","developer_key_not_found","developer_key_already_exists","account_header_invalid","account_scope_conflict","account_not_found","account_forbidden","account_read_only","account_not_controlled","contact_not_found","quote_not_submitted","quote_not_fundable","funding_mode_unsupported","funding_token_unsupported","insufficient_funds","smart_wallet_not_deployed","wallet_owner_unverified","already_funded","payment_slot_consumed","funding_in_progress","funding_attempt_expired","contact_changed","user_operation_rejected","user_operation_unavailable","transfer_policy_denied","client_creation_not_enabled","client_not_found","link_code_invalid","link_code_expired","client_already_linked","redirect_uri_not_allowed","payout_not_awaiting_signature","verification_not_applicable","profile_locked","contact_not_payable","contact_chain_unsupported","contact_token_unsupported","contact_payment_details_invalid","amount_below_minimum","amount_above_maximum","amount_precision_unsupported","payout_not_found","payout_not_fundable","quote_expired","bundler_rejected","bundler_unavailable","contact_details_invalid","contact_in_use","kyb_incomplete","kyb_documents_processing","kyb_roster_conflict","kyb_subject_conflict","document_not_found","document_type_unsupported","invalid_enum_value","entity_not_found","escrow_not_found","escrow_action_not_found","escrow_not_operated_by_you","escrow_state_changed","action_in_flight","simulation_failed","stale_nonce","amount_out_of_range","amount_not_allowed","window_closed","token_not_supported","receiver_not_a_client","rail_not_found","rail_not_available","payin_not_available","payin_expired","payin_not_found","transaction_not_found","account_unavailable","account_not_supported","swap_not_found","swap_route_unavailable","swap_not_confirmable","intent_not_signable","sandbox_amount_limit_exceeded","sandbox_faucet_balance_too_high"],"title":"PlatformErrorCode","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"Human-readable explanation safe to show to an end user.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Structured context for this error, when available.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Structured context for this error, when available.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["code","message"],"title":"PlatformErrorBody","description":"Public error body.","isRequired":true,"uniqueKey":"error","typeLabel":"PlatformErrorBody · object"}},"type":"object","required":["error"],"title":"PlatformErrorResponse","uniqueKey":"","typeLabel":"PlatformErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"11fb237f-ff08-4a99-8142-165879c2c8f5":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"hevninc","siteName":"HEVN","title":"Request a receiving account for a product - HEVN","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T16:48:05.391Z","originalFileLocation":"api-reference/virtual-accounts/request-a-receiving-account-for-a-product.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=\"Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HEVN\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_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/hevninc/Mrkw47wG7Tt5G32B/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Request a receiving account for a product - HEVN\">\u003cmeta data-mint-head property=\"og:description\" content=\"Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HEVN\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hevninc.mintlify.site/_mintlify/api/og/v2?division=Virtual+accounts\u0026amp;title=Request+a+receiving+account+for+a+product\u0026amp;description=Answers+201+with+the+account+record+the+first+time%2C+200+with+%60Idempotency-Replayed%3A+true%60+when+the+product+was+already+requested+or+is+already+active.+A+receivi\u0026amp;theme=aed7afc4fc65302f1c71cd72\u0026amp;signature=36c69a7acec3e502478aa21a004515ca6e6ec6716073c3771679dd9c9e5b5b28\">\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=\"Request a receiving account for a product - HEVN\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hevninc.mintlify.site/_mintlify/api/og/v2?division=Virtual+accounts\u0026amp;title=Request+a+receiving+account+for+a+product\u0026amp;description=Answers+201+with+the+account+record+the+first+time%2C+200+with+%60Idempotency-Replayed%3A+true%60+when+the+product+was+already+requested+or+is+already+active.+A+receivi\u0026amp;theme=aed7afc4fc65302f1c71cd72\u0026amp;signature=36c69a7acec3e502478aa21a004515ca6e6ec6716073c3771679dd9c9e5b5b28\">\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/hevninc/Mrkw47wG7Tt5G32B/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HEVN\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#256FAD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product\">\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/request-a-receiving-account-for-a-product.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hevninc.mintlify.app/#organization\",\"name\":\"HEVN\",\"url\":\"https://hevninc.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hevninc/to0nUVRkO9X57VRK/logo/light.svg?fit=max\u0026auto=format\u0026n=to0nUVRkO9X57VRK\u0026q=85\u0026s=0d24037b3480e3fd22fdbc2ea7c2a1bf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://hevninc.mintlify.app#website\",\"name\":\"HEVN\",\"url\":\"https://hevninc.mintlify.app\",\"publisher\":{\"@id\":\"https://hevninc.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product#webpage\",\"url\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product\",\"name\":\"Request a receiving account for a product\",\"description\":\"Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\",\"dateModified\":\"2026-11-12T16:48:05.391Z\",\"isPartOf\":{\"@id\":\"https://hevninc.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Virtual accounts\",\"item\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/list-virtual-accounts-and-available-payment-methods\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Request a receiving account for a product\",\"item\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product#apireference\",\"headline\":\"Request a receiving account for a product\",\"name\":\"Request a receiving account for a product\",\"description\":\"Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.\",\"url\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product\",\"mainEntityOfPage\":{\"@id\":\"https://hevninc.mintlify.app/api-reference/virtual-accounts/request-a-receiving-account-for-a-product#webpage\"},\"dateModified\":\"2026-11-12T16:48:05.391Z\",\"publisher\":{\"@id\":\"https://hevninc.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://hevninc.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HEVN\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HEVN\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/virtual-accounts/request-a-receiving-account-for-a-product.md","siteName":"HEVN","nav":{"global":null,"tabs":[{"tab":"General","pages":[{"title":"General","href":"/general/what-is-hevn"}]},{"tab":"Remote Transfers","pages":[{"title":"Remote Transfers","href":"/remote-transfers/overview"}]},{"tab":"Whitelabel","pages":[{"title":"Whitelabel","href":"/whitelabel/overview"}]},{"tab":"REST API","groups":[{"group":"Overview","pages":[{"title":"REST API overview","href":"/api-reference/overview"},{"title":"API authentication","href":"/api-reference/authentication"}]},{"group":"Authentication","pages":[{"title":"Start a developer-key login and receive the payload to sign","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/challenge","href":"/api-reference/auth/start-a-developer-key-login-and-receive-the-payload-to-sign"},{"title":"Exchange a signed login challenge for a session","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/token","href":"/api-reference/auth/exchange-a-signed-login-challenge-for-a-session"},{"title":"Exchange a refresh token for a session, optionally acting for an account","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/refresh","href":"/api-reference/auth/exchange-a-refresh-token-for-a-session-optionally-acting-for-an-account"}]},{"group":"Clients","pages":[{"title":"Create a sign-in window session","deprecated":null,"version":null,"openapi":"/openapi.json post /connect/sessions","href":"/api-reference/accounts/create-a-sign-in-window-session"},{"title":"Connect an existing account","deprecated":null,"version":null,"openapi":"/openapi.json post /clients/link","href":"/api-reference/accounts/connect-an-existing-account"},{"title":"List clients","deprecated":null,"version":null,"openapi":"/openapi.json get /clients","href":"/api-reference/accounts/list-clients"},{"title":"Retrieve one account","deprecated":null,"version":null,"openapi":"/openapi.json get /client","href":"/api-reference/accounts/retrieve-one-account"},{"title":"Update a client profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /client","href":"/api-reference/accounts/update-a-client-profile"},{"title":"Read a client's balances","deprecated":null,"version":null,"openapi":"/openapi.json get /client/balance","href":"/api-reference/accounts/read-a-clients-balances"}]},{"group":"Verification","pages":[{"title":"Provide applicant information","deprecated":null,"version":null,"openapi":"/openapi.json put /client/kyb","href":"/api-reference/verification/provide-applicant-information"},{"title":"Retrieve the verification submission","deprecated":null,"version":null,"openapi":"/openapi.json get /client/kyb","href":"/api-reference/verification/retrieve-the-verification-submission"},{"title":"Complete the verification submission","deprecated":null,"version":null,"openapi":"/openapi.json post /client/kyb/complete","href":"/api-reference/verification/complete-the-verification-submission"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"/openapi.json post /documents","href":"/api-reference/documents/upload-a-document"},{"title":"Fill the typed fields read off a document","deprecated":null,"version":null,"openapi":"/openapi.json put /documents/{documentId}/content","href":"/api-reference/documents/fill-the-typed-fields-read-off-a-document"}]},{"group":"Virtual accounts","pages":[{"title":"List virtual accounts and available payment methods","description":"List receiving payment methods available to the selected account and identify which virtual accounts have already been opened.","deprecated":null,"version":null,"openapi":"/openapi.json get /banks","href":"/api-reference/virtual-accounts/list-virtual-accounts-and-available-payment-methods"},{"title":"Request a receiving account for a product","deprecated":null,"version":null,"openapi":"/openapi.json post /banks","href":"/api-reference/virtual-accounts/request-a-receiving-account-for-a-product"},{"title":"Retrieve one virtual account","description":"Retrieve the receiving account of one region product and, when opened, its receiving details. The product is the path key.","deprecated":null,"version":null,"openapi":"/openapi.json get /banks/{product}","href":"/api-reference/virtual-accounts/retrieve-one-virtual-account"},{"title":"Retrieve the receiving conversion rate","deprecated":null,"version":null,"openapi":"/openapi.json get /banks/{product}/rate","href":"/api-reference/virtual-accounts/retrieve-the-receiving-conversion-rate"}]},{"group":"Money in","pages":[{"title":"Create an incoming transfer quote","deprecated":null,"version":null,"openapi":"/openapi.json post /payins","href":"/api-reference/transfers/create-an-incoming-transfer-quote"},{"title":"Open the incoming transfer and retrieve funding instructions","deprecated":null,"version":null,"openapi":"/openapi.json post /payins/{payinId}/instructions","href":"/api-reference/transfers/open-the-incoming-transfer-and-retrieve-funding-instructions"},{"title":"Retrieve an incoming transfer","deprecated":null,"version":null,"openapi":"/openapi.json get /payins/{payinId}","href":"/api-reference/transfers/retrieve-an-incoming-transfer"}]},{"group":"Money out","pages":[{"title":"Create an outgoing transfer","deprecated":null,"version":null,"openapi":"/openapi.json post /payouts","href":"/api-reference/transfers/create-an-outgoing-transfer"},{"title":"Create an outgoing transfer quote","deprecated":null,"version":null,"openapi":"/openapi.json post /payouts/preview","href":"/api-reference/transfers/create-an-outgoing-transfer-quote"},{"title":"Authorize an outgoing transfer","deprecated":null,"version":null,"openapi":"/openapi.json post /payouts/{payoutId}/confirm","href":"/api-reference/transfers/authorize-an-outgoing-transfer"},{"title":"Retrieve an outgoing transfer","deprecated":null,"version":null,"openapi":"/openapi.json get /payouts/{payoutId}","href":"/api-reference/transfers/retrieve-an-outgoing-transfer"}]},{"group":"Swaps","pages":[{"title":"Create a transfer between the client's own accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /swaps","href":"/api-reference/transfers/create-a-transfer-between-the-clients-own-accounts"},{"title":"Price a transfer between the client's own accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /swaps/preview","href":"/api-reference/transfers/price-a-transfer-between-the-clients-own-accounts"},{"title":"Authorize a transfer between the client's own accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /swaps/{swapId}/confirm","href":"/api-reference/transfers/authorize-a-transfer-between-the-clients-own-accounts"},{"title":"Retrieve a transfer between the client's own accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /swaps/{swapId}","href":"/api-reference/transfers/retrieve-a-transfer-between-the-clients-own-accounts"}]},{"group":"Contacts","pages":[{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"List saved contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/list-saved-contacts"},{"title":"Retrieve one contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}","href":"/api-reference/contacts/retrieve-one-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /contacts/{contactId}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{contactId}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Retrieve contact channels","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}/capabilities","href":"/api-reference/contacts/retrieve-contact-channels"}]},{"group":"Transactions","pages":[{"title":"List transactions, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions-newest-first"},{"title":"Retrieve one transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions/{transactionId}","href":"/api-reference/transactions/retrieve-one-transaction"},{"title":"Inflow and outflow totals for the same filters","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions/summary","href":"/api-reference/transactions/inflow-and-outflow-totals-for-the-same-filters"},{"title":"Export transactions, a statement, a confirmation or a receipt","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions/export","href":"/api-reference/transactions/export-transactions-a-statement-a-confirmation-or-a-receipt"}]},{"group":"Escrow","pages":[{"title":"Open an escrow and return the payer's approval","deprecated":null,"version":null,"openapi":"/openapi.json post /escrow","href":"/api-reference/escrow/open-an-escrow-and-return-the-payers-approval"},{"title":"List the escrows this account operates","deprecated":null,"version":null,"openapi":"/openapi.json get /escrow","href":"/api-reference/escrow/list-the-escrows-this-account-operates"},{"title":"Read one escrow","deprecated":null,"version":null,"openapi":"/openapi.json get /escrow/{escrowId}","href":"/api-reference/escrow/read-one-escrow"},{"title":"Prepare an escrow action and return the payload to sign","deprecated":null,"version":null,"openapi":"/openapi.json post /escrow/{escrowId}/actions","href":"/api-reference/escrow/prepare-an-escrow-action-and-return-the-payload-to-sign"},{"title":"Submit the signature for a prepared escrow action","deprecated":null,"version":null,"openapi":"/openapi.json post /escrow/{escrowId}/actions/{idempotencyKey}/confirm","href":"/api-reference/escrow/submit-the-signature-for-a-prepared-escrow-action"},{"title":"Reconcile one escrow with the chain","deprecated":null,"version":null,"openapi":"/openapi.json post /escrow/{escrowId}/sync","href":"/api-reference/escrow/reconcile-one-escrow-with-the-chain"}]},{"group":"Sandbox","pages":[{"title":"Read the sandbox treasury that funds emulated credits","deprecated":null,"version":null,"openapi":"/openapi.json get /sandbox/treasury","href":"/api-reference/sandbox/read-the-sandbox-treasury-that-funds-emulated-credits"},{"title":"Emulate an incoming deposit: an account transfer with bankId, a token transfer without","deprecated":null,"version":null,"openapi":"/openapi.json post /sandbox/deposits","href":"/api-reference/sandbox/emulate-an-incoming-deposit:-an-account-transfer-with-bankid-a-token-transfer-without"},{"title":"Emulate the arrival of the funds a pay-in is waiting for","deprecated":null,"version":null,"openapi":"/openapi.json post /sandbox/payins/{payinId}/complete","href":"/api-reference/sandbox/emulate-the-arrival-of-the-funds-a-pay-in-is-waiting-for"},{"title":"Move an emulated outgoing transfer to its next reported status","deprecated":null,"version":null,"openapi":"/openapi.json post /sandbox/payouts/{payoutId}/status","href":"/api-reference/sandbox/move-an-emulated-outgoing-transfer-to-its-next-reported-status"}]}]}]},"basePath":"","title":"Request a receiving account for a product - HEVN","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}