This endpoint closes the 2-step payout account setup. After you created a withdrawal address in step 1, this creates a permanent fiat virtual account (e.g. a CLABE in Mexico) that lets your client deposit fiat to trigger an off-ramp settlement.
1
Step 1 — POST /v1/payout/accounts/setup/liquidation-address
Created the crypto withdrawal address for (beneficiaryId, beneficiaryAccountId, chain, currency).
2
Step 2 — POST /v1/payout/accounts/setup/virtual-account (this endpoint)
Returns the fiat virtual account (CLABE for SPEI, account number + routing for ACH, IBAN for SEPA) backed by the withdrawal address.
3
Operate — quote then execute
POST /v1/payout/accounts/quote to get the rate, then POST /v1/payout/accounts/execute to trigger settlement. Track via GET /v1/orders/{orderId}.
Prerequisites
The recipient exists (POST /v1/payout/recipients)
The recipient’s bank account is registered (POST /v1/payout/recipients/{id}/accounts)
Step 1 (withdrawal address) succeeded for this (beneficiaryId, beneficiaryAccountId) pair
If step 1 hasn’t run for this pair, this endpoint returns 400.
Request body
string
required
The recipient (from POST /v1/payout/recipients).
string
required
The recipient’s bank account ID. Must be the same pair you used in step 1.
Response
string
Internal virtual account ID. You don’t need to store it — call setup again to retrieve.
string
The 18-digit SPEI CLABE for Mexican fiat deposits. Share this with your client.
string
Fiat currency. Today: MXN (CLABE/SPEI). Other rails (ACH USD, SEPA EUR) will surface here as those go live.
string
Echo of the recipient.
This call is idempotent — calling it twice with the same (beneficiaryId, beneficiaryAccountId) returns the same CLABE. Don’t cache; just call setup before each payment if you want to be sure the account is current.
What happens after a deposit
When your client wires MXN to the returned CLABE:
The fiat rails partner detects the deposit and credits the workspace’s float
An on-chain transfer of equivalent stablecoin is initiated from the withdrawal address
The stablecoin lands at the on-chain off-ramp partner, triggering the bank wire to the recipient
An order is created in /v1/orders with status transitioning: awaiting_funds → funds_received → payment_submitted → completed
End-to-end settlement: typically 1–2 business days via SPEI.
Authentication
Authorization: ApiKey rk_client_key_v1_... — workspace key with payout module enabled and write scope.
Common errors
Status
Cause
Fix
400
No withdrawal address exists for the (beneficiaryId, beneficiaryAccountId) pair
Run step 1 (/setup/liquidation-address) first
403
Workspace lacks payout module or write scope
Activate Payout Kit in dashboard; check API key scope
404
beneficiaryId or beneficiaryAccountId not found
Cross-tenant lookups return 404 (no existence leak)
422
Recipient’s bank account is not yet usable (pending rails partner approval)
Wait for the registration to confirm; retry
Next steps
After step 2 you’re operational. Recommended next reads:
POST /v1/payout/accounts/quote — get the exchange rate and fees for a payment
POST /v1/payout/accounts/execute — trigger settlement
GET /v1/orders/{orderId} — track the full timeline
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Relayer.fi","colors":{"primary":"#015F51","light":"#ECE6D6","dark":"#015F51"},"logo":{"light":"https://mintcdn.com/relayerfi/HPPc29pDPmX_uuYf/images/relayer-isotype-petrol.svg?fit=max\u0026auto=format\u0026n=HPPc29pDPmX_uuYf\u0026q=85\u0026s=4793c846712b8d1c6e643ece66ba100c","dark":"https://mintcdn.com/relayerfi/HPPc29pDPmX_uuYf/images/relayer-isotype-cream.svg?fit=max\u0026auto=format\u0026n=HPPc29pDPmX_uuYf\u0026q=85\u0026s=72ed743508c822637327cf1091b4ad24"},"favicon":{"light":"https://mintcdn.com/relayerfi/HPPc29pDPmX_uuYf/images/relayer-isotype-petrol.svg?fit=max\u0026auto=format\u0026n=HPPc29pDPmX_uuYf\u0026q=85\u0026s=4793c846712b8d1c6e643ece66ba100c","dark":"https://mintcdn.com/relayerfi/HPPc29pDPmX_uuYf/images/relayer-isotype-cream.svg?fit=max\u0026auto=format\u0026n=HPPc29pDPmX_uuYf\u0026q=85\u0026s=72ed743508c822637327cf1091b4ad24"},"appearance":{"default":"system"},"background":{"color":{"light":"#F6F6F4","dark":"#1A1A19"}},"navbar":{"links":[{"href":"mailto:dev@relayer.fi","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/RelayerProtocol","github":"https://github.com/relayerfi"}},"fonts":{"family":"Archivo"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://relayer.fi"},{"anchor":"GitHub","icon":"github","href":"https://github.com/relayerfi"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"relayerfi","hasAudioNarration":false,"actualSubdomain":"relayerfi","customDomains":["docs.relayer.fi"],"gitSource":{"type":"github","owner":"picklerfun","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae94b16d111843d72bcd8a4:success","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":37},{"language":"default","tag":"Get Started","count":16},{"language":"default","tag":"Agent Kit","count":10},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Widget Kit","count":8},{"language":"default","tag":"Transactions","count":8},{"language":"default","tag":"Widget Actions","count":7},{"language":"default","tag":"Runtime (HMAC)","count":6},{"language":"default","tag":"Global Payout","count":6},{"language":"default","tag":"Payout Kit","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"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":"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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/flows/payout-virtual-account","slug":"/api-reference/flows/payout-virtual-account","pageMetadata":{"title":"Set up a payout account — Step 2","description":"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.","sidebarTitle":"Setup virtual account","api":"POST /v1/payout/accounts/setup/virtual-account","href":"/api-reference/flows/payout-virtual-account"},"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: \"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note,ParamField,ResponseField,Step,Steps,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This endpoint `,_jsx(_components.strong,{children:`closes the 2-step payout account setup`}),`. After you created a withdrawal address in step 1, this creates a permanent fiat virtual account (e.g. a CLABE in Mexico) that lets your client deposit fiat to trigger an off-ramp settlement.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Step 1 — POST /v1/payout/accounts/setup/liquidation-address`,children:_jsxs(_components.p,{children:[`Created the crypto withdrawal address for `,_jsx(_components.code,{children:`(beneficiaryId, beneficiaryAccountId, chain, currency)`}),`.`]})}),_jsx(Step,{title:`Step 2 — POST /v1/payout/accounts/setup/virtual-account (this endpoint)`,children:_jsx(_components.p,{children:`Returns the fiat virtual account (CLABE for SPEI, account number + routing for ACH, IBAN for SEPA) backed by the withdrawal address.`})}),_jsx(Step,{title:`Operate — quote then execute`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /v1/payout/accounts/quote`}),` to get the rate, then `,_jsx(_components.code,{children:`POST /v1/payout/accounts/execute`}),` to trigger settlement. Track via `,_jsx(_components.code,{children:`GET /v1/orders/{orderId}`}),`.`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The recipient exists (`,_jsx(_components.code,{children:`POST /v1/payout/recipients`}),`)`]}),`\n`,_jsxs(_components.li,{children:[`The recipient’s bank account is registered (`,_jsx(_components.code,{children:`POST /v1/payout/recipients/{id}/accounts`}),`)`]}),`\n`,_jsxs(_components.li,{children:[`Step 1 (withdrawal address) succeeded for this `,_jsx(_components.code,{children:`(beneficiaryId, beneficiaryAccountId)`}),` pair`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`If step 1 hasn’t run for this pair, this endpoint returns `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request body`}),`\n`,_jsx(ParamField,{body:`beneficiaryId`,type:`string`,required:true,id:`param-beneficiary-id`,children:_jsxs(_components.p,{children:[`The recipient (from `,_jsx(_components.code,{children:`POST /v1/payout/recipients`}),`).`]})}),`\n`,_jsx(ParamField,{body:`beneficiaryAccountId`,type:`string`,required:true,id:`param-beneficiary-account-id`,children:_jsx(_components.p,{children:`The recipient’s bank account ID. Must be the same pair you used in step 1.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`Internal virtual account ID. You don’t need to store it — call setup again to retrieve.`})}),`\n`,_jsx(ResponseField,{name:`clabe`,type:`string`,id:`param-clabe`,children:_jsx(_components.p,{children:`The 18-digit SPEI CLABE for Mexican fiat deposits. Share this with your client.`})}),`\n`,_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency`,children:_jsxs(_components.p,{children:[`Fiat currency. Today: `,_jsx(_components.code,{children:`MXN`}),` (CLABE/SPEI). Other rails (ACH USD, SEPA EUR) will surface here as those go live.`]})}),`\n`,_jsx(ResponseField,{name:`beneficiaryId`,type:`string`,id:`param-beneficiary-id-1`,children:_jsx(_components.p,{children:`Echo of the recipient.`})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This call is `,_jsx(_components.strong,{children:`idempotent`}),` — calling it twice with the same `,_jsx(_components.code,{children:`(beneficiaryId, beneficiaryAccountId)`}),` returns the same CLABE. Don’t cache; just call setup before each payment if you want to be sure the account is current.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`what-happens-after-a-deposit`,children:`What happens after a deposit`}),`\n`,_jsx(_components.p,{children:`When your client wires MXN to the returned CLABE:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`The fiat rails partner detects the deposit and credits the workspace’s float`}),`\n`,_jsx(_components.li,{children:`An on-chain transfer of equivalent stablecoin is initiated from the withdrawal address`}),`\n`,_jsx(_components.li,{children:`The stablecoin lands at the on-chain off-ramp partner, triggering the bank wire to the recipient`}),`\n`,_jsxs(_components.li,{children:[`An order is created in `,_jsx(_components.code,{children:`/v1/orders`}),` with status transitioning: `,_jsx(_components.code,{children:`awaiting_funds`}),` → `,_jsx(_components.code,{children:`funds_received`}),` → `,_jsx(_components.code,{children:`payment_submitted`}),` → `,_jsx(_components.code,{children:`completed`})]}),`\n`]}),`\n`,_jsx(_components.p,{children:`End-to-end settlement: typically 1–2 business days via SPEI.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`Authorization: ApiKey rk_client_key_v1_...`}),` — workspace key with `,_jsx(_components.code,{children:`payout`}),` module enabled and write scope.`]}),`\n`,_jsx(Heading,{level:`2`,id:`common-errors`,children:`Common errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Cause`}),_jsx(_components.th,{children:`Fix`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`No withdrawal address exists for the `,_jsx(_components.code,{children:`(beneficiaryId, beneficiaryAccountId)`}),` pair`]}),_jsxs(_components.td,{children:[`Run step 1 (`,_jsx(_components.code,{children:`/setup/liquidation-address`}),`) first`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`Workspace lacks `,_jsx(_components.code,{children:`payout`}),` module or write scope`]}),_jsx(_components.td,{children:`Activate Payout Kit in dashboard; check API key scope`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`beneficiaryId`}),` or `,_jsx(_components.code,{children:`beneficiaryAccountId`}),` not found`]}),_jsx(_components.td,{children:`Cross-tenant lookups return 404 (no existence leak)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:`Recipient’s bank account is not yet usable (pending rails partner approval)`}),_jsx(_components.td,{children:`Wait for the registration to confirm; retry`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsx(_components.p,{children:`After step 2 you’re operational. Recommended next reads:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/payout/accounts/quote`}),` — get the exchange rate and fees for a payment`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/payout/accounts/execute`}),` — trigger settlement`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET /v1/orders/{orderId}`}),` — track the full timeline`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/payout/flow-guide`,children:`Payout Kit Flow Guide`}),` — narrative end-to-end`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Set up a payout account — Step 2","description":"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.","sidebarTitle":"Setup virtual account","api":"POST /v1/payout/accounts/setup/virtual-account","href":"/api-reference/flows/payout-virtual-account"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Request body","slug":"request-body","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"What happens after a deposit","slug":"what-happens-after-a-deposit","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Common errors","slug":"common-errors","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Set up a payout account — Step 2","path":"/v1/payout/accounts/setup/virtual-account","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"beneficiaryId":[{"type":"string","description":"The recipient (from `POST /v1/payout/recipients` ).","required":true}],"beneficiaryAccountId":[{"type":"string","description":"The recipient’s bank account ID. Must be the same pair you used in step 1.","required":true}]}}],"examples":{"example":{"value":{"beneficiaryId":"\u003cstring>","beneficiaryAccountId":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"Internal virtual account ID. You don’t need to store it — call setup again to retrieve."}],"clabe":[{"type":"string","description":"The 18-digit SPEI CLABE for Mexican fiat deposits. Share this with your client."}],"currency":[{"type":"string","description":"Fiat currency. Today: `MXN` (CLABE/SPEI). Other rails (ACH USD, SEPA EUR) will surface here as those go live."}],"beneficiaryId":[{"type":"string","description":"Echo of the recipient."}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","clabe":"\u003cstring>","currency":"\u003cstring>","beneficiaryId":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"relayerfi","siteName":"Relayer.fi","title":"Set up a payout account — Step 2 - Relayer.fi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-16T02:21:22.591Z","originalFileLocation":"api-reference/flows/payout-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=\"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Relayer.fi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_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/relayerfi/FmuHExnVftyvFhdQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set up a payout account — Step 2 - Relayer.fi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Relayer.fi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://relayerfi.mintlify.site/_mintlify/api/og/v2?division=Global+Payout\u0026amp;title=Set+up+a+payout+account+%E2%80%94+Step+2\u0026amp;description=Step+2+of+the+2-step+payout+setup.+Creates+a+fiat+virtual+account+%28CLABE%29+tied+to+the+withdrawal+address.\u0026amp;theme=ac545d78a150f4a69952bd9f\u0026amp;signature=0ff8157bf402a3e7fe1cd075144c1f6ae717d2dcf3baa49b1d0899f59b1b4c2e\">\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=\"Set up a payout account — Step 2 - Relayer.fi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://relayerfi.mintlify.site/_mintlify/api/og/v2?division=Global+Payout\u0026amp;title=Set+up+a+payout+account+%E2%80%94+Step+2\u0026amp;description=Step+2+of+the+2-step+payout+setup.+Creates+a+fiat+virtual+account+%28CLABE%29+tied+to+the+withdrawal+address.\u0026amp;theme=ac545d78a150f4a69952bd9f\u0026amp;signature=0ff8157bf402a3e7fe1cd075144c1f6ae717d2dcf3baa49b1d0899f59b1b4c2e\">\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/relayerfi/FmuHExnVftyvFhdQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Relayer.fi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#015F51\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.relayer.fi/api-reference/flows/payout-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/flows/payout-virtual-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.relayer.fi/#organization\",\"name\":\"Relayer.fi\",\"url\":\"https://docs.relayer.fi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/relayerfi/HPPc29pDPmX_uuYf/images/relayer-isotype-petrol.svg?fit=max\u0026auto=format\u0026n=HPPc29pDPmX_uuYf\u0026q=85\u0026s=4793c846712b8d1c6e643ece66ba100c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.relayer.fi#website\",\"name\":\"Relayer.fi\",\"url\":\"https://docs.relayer.fi\",\"publisher\":{\"@id\":\"https://docs.relayer.fi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account#webpage\",\"url\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account\",\"name\":\"Set up a payout account — Step 2\",\"description\":\"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\",\"dateModified\":\"2026-05-16T02:21:22.591Z\",\"isPartOf\":{\"@id\":\"https://docs.relayer.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Global Payout\",\"item\":\"https://docs.relayer.fi/api-reference/flows/payout-setup\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Set up a payout account — Step 2\",\"item\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account#apireference\",\"headline\":\"Set up a payout account — Step 2\",\"name\":\"Set up a payout account — Step 2\",\"description\":\"Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address.\",\"url\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-virtual-account#webpage\"},\"dateModified\":\"2026-05-16T02:21:22.591Z\",\"publisher\":{\"@id\":\"https://docs.relayer.fi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.relayer.fi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Relayer.fi\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Relayer.fi\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/flows/payout-virtual-account.md","siteName":"Relayer.fi","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://relayer.fi"},{"anchor":"GitHub","icon":"github","href":"https://github.com/relayerfi"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"Signing Kit","pages":[{"title":"Signing Kit","href":"/signing/overview"}]},{"tab":"Payout Kit","pages":[{"title":"Payout Kit","href":"/payout/overview"}]},{"tab":"Agent Kit","pages":[{"title":"Agent Kit","href":"/agent/overview"}]},{"tab":"Widget Kit","pages":[{"title":"Widget Kit","href":"/widget/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Wallets","pages":[]},{"group":"Addresses","pages":[]},{"group":"Transactions","pages":[{"title":"List transactions awaiting passkey signature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/pending-signature","href":"/api-reference/transactions/list-transactions-awaiting-passkey-signature"},{"title":"List signed transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/sign","href":"/api-reference/transactions/list-signed-transactions"},{"title":"Get signed transaction details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/sign/{transactionId}","href":"/api-reference/transactions/get-signed-transaction-details"},{"title":"Cancel a pending transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /transactions/sign/{transactionId}","href":"/api-reference/transactions/cancel-a-pending-transaction"},{"title":"Broadcast a signed transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transactions/broadcast/{transactionId}","href":"/api-reference/transactions/broadcast-a-signed-transaction"},{"title":"Broadcast a raw signed transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transactions/broadcast/raw","href":"/api-reference/transactions/broadcast-a-raw-signed-transaction"},{"title":"Get broadcast status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/broadcast/{transactionId}","href":"/api-reference/transactions/get-broadcast-status"},{"title":"Retry broadcasting a failed transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transactions/broadcast/{transactionId}/retry","href":"/api-reference/transactions/retry-broadcasting-a-failed-transaction"}]},{"group":"Widget Actions","pages":[{"title":"Widget Actions — overview","sidebarTitle":"Overview","href":"/api-reference/flows/actions-intro"},{"title":"Generate metadata for Swap application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /action/builders/swap","href":"/api-reference/action:-builders/generate-metadata-for-swap-application"},{"title":"Generate metadata for Native Token Transfer application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /action/builders/transfer-native","href":"/api-reference/action:-builders/generate-metadata-for-native-token-transfer-application"},{"title":"Generate metadata for Crosschain Transfer application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /action/builders/crosschain-transfer","href":"/api-reference/action:-builders/generate-metadata-for-crosschain-transfer-application"},{"title":"Generate metadata for Crosschain Bridge application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /action/builders/crosschain-bridge","href":"/api-reference/action:-builders/generate-metadata-for-crosschain-bridge-application"},{"title":"Get the Directory data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /action/directory","href":"/api-reference/action:-directory/get-the-directory-data"},{"title":"Retrieve protocol token list for a chain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /action/tokens/{chain}/{protocol}","href":"/api-reference/action:-tokens/retrieve-protocol-token-list-for-a-chain"}]},{"group":"Agents","pages":[{"group":"Operator (api-key)","pages":[{"title":"List all agents for the integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-all-agents-for-the-integrator"},{"title":"Get agent details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/agents/get-agent-details"},{"title":"Pause an agent (reversible)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/pause","href":"/api-reference/agents/pause-an-agent-reversible"},{"title":"Resume a paused agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/resume","href":"/api-reference/agents/resume-a-paused-agent"}]},{"group":"Runtime (HMAC)","pages":[{"title":"Get agent status and kill-switch state (HMAC or API key)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/status","href":"/api-reference/agents/get-agent-status-and-kill-switch-state-hmac-or-api-key"},{"title":"Get agent wallet balance with budget context (HMAC or API key)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/balance","href":"/api-reference/agents/get-agent-wallet-balance-with-budget-context-hmac-or-api-key"},{"title":"Get agent budget state (HMAC or API key)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/budget","href":"/api-reference/agents/get-agent-budget-state-hmac-or-api-key"},{"title":"Sign a Solana transaction for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/sign-transaction","href":"/api-reference/agents/sign-a-solana-transaction-for-an-agent"},{"title":"Batch ingest agent events (up to 100)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/events/batch","href":"/api-reference/agents/batch-ingest-agent-events-up-to-100"},{"title":"Pay for an x402-gated resource","sidebarTitle":"x402-pay","api":"POST /v1/agents/{id}/x402-pay","href":"/api-reference/flows/agent-x402-pay"}]}]},{"group":"Beneficiaries","pages":[]},{"group":"Global Payout","pages":[{"title":"Set up a payout account — Step 1","description":"Step 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient's bank account.","sidebarTitle":"Setup withdrawal address","api":"POST /v1/payout/accounts/setup/liquidation-address","href":"/api-reference/flows/payout-setup"},{"title":"Set up a payout account — Step 2","sidebarTitle":"Setup virtual account","api":"POST /v1/payout/accounts/setup/virtual-account","href":"/api-reference/flows/payout-virtual-account"},{"title":"Get a payment quote (MXN → USD)","description":"Returns an estimated exchange rate and fee breakdown. Rates update every ~30 seconds — this is not a locked quote.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payout/accounts/quote","href":"/api-reference/payout:-accounts/get-a-payment-quote-mxn-→-usd"},{"title":"Execute a fiat payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payout/accounts/execute","href":"/api-reference/payout:-accounts/execute-a-fiat-payment"},{"title":"List all payments for the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payout/accounts","href":"/api-reference/payout:-accounts/list-all-payments-for-the-authenticated-integrator"},{"title":"Get payment status by reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payout/accounts/{reference}/status","href":"/api-reference/payout:-accounts/get-payment-status-by-reference"}]},{"group":"On-ramp","pages":[{"title":"Get an on-ramp quote (fiat → stablecoin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payout/onramp/quote","href":"/api-reference/payout:-on-ramp/get-an-on-ramp-quote-fiat-→-stablecoin"},{"title":"Create or get a deposit account (idempotent)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payout/onramp/deposit-accounts","href":"/api-reference/payout:-on-ramp/create-or-get-a-deposit-account-idempotent"},{"title":"List my deposit accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payout/onramp/deposit-accounts","href":"/api-reference/payout:-on-ramp/list-my-deposit-accounts"},{"title":"Get a single deposit account by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payout/onramp/deposit-accounts/{id}","href":"/api-reference/payout:-on-ramp/get-a-single-deposit-account-by-id"},{"title":"List lifecycle events for a deposit account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payout/onramp/deposit-accounts/{id}/events","href":"/api-reference/payout:-on-ramp/list-lifecycle-events-for-a-deposit-account"}]}]}]},"basePath":"","title":"Set up a payout account — Step 2 - Relayer.fi","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js"]}