This endpoint is step 1 of the 2-step payout account setup for off-ramp settlement. It links a recipient’s bank account to a crypto withdrawal address. When stablecoins land at this address, the off-ramp transfer to the recipient’s bank is triggered automatically.
1
Step 1 — POST /v1/payout/accounts/setup/liquidation-address (this endpoint)
Creates or returns the withdrawal address for (beneficiaryId, beneficiaryAccountId, chain, currency). Idempotent — calling twice returns the same address.
2
Step 2 — POST /v1/payout/accounts/setup/virtual-account
Creates a fiat virtual account (e.g. a SPEI CLABE in Mexico) tied to the withdrawal address. Returns the account number your client deposits fiat into. Also idempotent.
3
Operate — quote and execute
Use POST /v1/payout/accounts/quote and POST /v1/payout/accounts/execute to move money. Track via GET /v1/orders/{orderId}.
Both setup endpoints are idempotent. You can call them on every order without worrying about duplicates. This is the recommended pattern: don’t cache setup IDs in your backend, just call setup before each payment.
Prerequisites
Workspace KYB completed (one-time, via dashboard)
Recipient created (POST /v1/payout/recipients)
Recipient’s bank account added (POST /v1/payout/recipients/{id}/accounts or via invite link)
Request body
string
required
Recipient ID (from POST /v1/payout/recipients).
string
required
The recipient’s bank account ID (from POST /v1/payout/recipients/{id}/accounts).
string
required
Stablecoin chain. Supported: base, polygon, arbitrum, solana. More on request.
string
required
Stablecoin symbol on the chosen chain. Supported: usdc, usdt.
Response
string
Internal withdrawal address ID. You generally don’t need to store this — call setup again to retrieve.
string
The crypto address. Send stablecoins here to trigger an off-ramp settlement to the recipient’s bank.
string
Echo of the chain you requested.
string
Echo of the stablecoin you requested.
Each (beneficiaryAccountId, chain, currency) triple maps to one withdrawal address forever. Different recipients get different addresses. Don’t reuse addresses across recipients.
What happens after a deposit?
When stablecoins arrive at the returned address, the off-ramp partner detects the deposit, settles the on-chain leg, and initiates the fiat transfer to the recipient’s bank. Track the full lifecycle as an order:
GET /v1/orders — list all ordersGET /v1/orders/{orderId} — get a single order with timelineGET /v1/payout/recipients/{id}/orders — orders for this recipient
Typical timeline: stablecoin deposit detected → confirmed on-chain → fiat transfer submitted → fiat received at recipient bank. End-to-end takes 1–2 business days via SPEI.
Authentication
Authorization: ApiKey rk_client_key_v1_... — workspace key with payout module enabled and payout:write scope.
Common errors
Status
Cause
Fix
400
Unsupported chain + currency combination
See /v1/action/tokens/{chain}/usdc for supported pairs
403
payout module not active for workspace
Activate Payout Kit in the dashboard
404
beneficiaryId or beneficiaryAccountId not found, or belongs to another workspace
Cross-tenant lookups always return 404 (no existence leak)
422
Recipient’s bank account is not yet usable (pending registration)
Wait for the rails partner to confirm the bank account, then retry
Next steps
POST /v1/payout/accounts/setup/virtual-account — Step 2: create the fiat virtual account
POST /v1/payout/accounts/quote then POST /v1/payout/accounts/execute — operate once setup is complete
{"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.4227","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":[],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/flows/payout-setup","slug":"/api-reference/flows/payout-setup","pageMetadata":{"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"},"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 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient’s bank account.\"\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`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,ResponseField,Step,Steps,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);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);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This endpoint is `,_jsx(_components.strong,{children:`step 1 of the 2-step payout account setup`}),` for off-ramp settlement. It links a recipient’s bank account to a crypto withdrawal address. When stablecoins land at this address, the off-ramp transfer to the recipient’s bank is triggered automatically.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Step 1 — POST /v1/payout/accounts/setup/liquidation-address (this endpoint)`,children:_jsxs(_components.p,{children:[`Creates or returns the withdrawal address for `,_jsx(_components.code,{children:`(beneficiaryId, beneficiaryAccountId, chain, currency)`}),`. Idempotent — calling twice returns the same address.`]})}),_jsx(Step,{title:`Step 2 — POST /v1/payout/accounts/setup/virtual-account`,children:_jsx(_components.p,{children:`Creates a fiat virtual account (e.g. a SPEI CLABE in Mexico) tied to the withdrawal address. Returns the account number your client deposits fiat into. Also idempotent.`})}),_jsx(Step,{title:`Operate — quote and execute`,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`POST /v1/payout/accounts/quote`}),` and `,_jsx(_components.code,{children:`POST /v1/payout/accounts/execute`}),` to move money. Track via `,_jsx(_components.code,{children:`GET /v1/orders/{orderId}`}),`.`]})})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Both setup endpoints are `,_jsx(_components.strong,{children:`idempotent`}),`. You can call them on every order without worrying about duplicates. This is the recommended pattern: don’t cache setup IDs in your backend, just call setup before each payment.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Workspace KYB completed (one-time, via dashboard)`}),`\n`,_jsxs(_components.li,{children:[`Recipient created (`,_jsx(_components.code,{children:`POST /v1/payout/recipients`}),`)`]}),`\n`,_jsxs(_components.li,{children:[`Recipient’s bank account added (`,_jsx(_components.code,{children:`POST /v1/payout/recipients/{id}/accounts`}),` or via invite link)`]}),`\n`]}),`\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:[`Recipient ID (from `,_jsx(_components.code,{children:`POST /v1/payout/recipients`}),`).`]})}),`\n`,_jsx(ParamField,{body:`beneficiaryAccountId`,type:`string`,required:true,id:`param-beneficiary-account-id`,children:_jsxs(_components.p,{children:[`The recipient’s bank account ID (from `,_jsx(_components.code,{children:`POST /v1/payout/recipients/{id}/accounts`}),`).`]})}),`\n`,_jsx(ParamField,{body:`chain`,type:`string`,required:true,id:`param-chain`,children:_jsxs(_components.p,{children:[`Stablecoin chain. Supported: `,_jsx(_components.code,{children:`base`}),`, `,_jsx(_components.code,{children:`polygon`}),`, `,_jsx(_components.code,{children:`arbitrum`}),`, `,_jsx(_components.code,{children:`solana`}),`. More on request.`]})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,required:true,id:`param-currency`,children:_jsxs(_components.p,{children:[`Stablecoin symbol on the chosen chain. Supported: `,_jsx(_components.code,{children:`usdc`}),`, `,_jsx(_components.code,{children:`usdt`}),`.`]})}),`\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 withdrawal address ID. You generally don’t need to store this — call setup again to retrieve.`})}),`\n`,_jsx(ResponseField,{name:`address`,type:`string`,id:`param-address`,children:_jsx(_components.p,{children:`The crypto address. Send stablecoins here to trigger an off-ramp settlement to the recipient’s bank.`})}),`\n`,_jsx(ResponseField,{name:`chain`,type:`string`,id:`param-chain-1`,children:_jsx(_components.p,{children:`Echo of the chain you requested.`})}),`\n`,_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-1`,children:_jsx(_components.p,{children:`Echo of the stablecoin you requested.`})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Each `,_jsx(_components.code,{children:`(beneficiaryAccountId, chain, currency)`}),` triple maps to `,_jsx(_components.strong,{children:`one withdrawal address forever`}),`. Different recipients get different addresses. Don’t reuse addresses across recipients.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`what-happens-after-a-deposit`,children:`What happens after a deposit?`}),`\n`,_jsxs(_components.p,{children:[`When stablecoins arrive at the returned `,_jsx(_components.code,{children:`address`}),`, the off-ramp partner detects the deposit, settles the on-chain leg, and initiates the fiat transfer to the recipient’s bank. Track the full lifecycle as an order:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`4`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/orders — list all orders`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/orders/{orderId} — get a single order with timeline`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/payout/recipients/{id}/orders — orders for this recipient`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Typical timeline: stablecoin deposit detected → confirmed on-chain → fiat transfer submitted → fiat received at recipient bank. End-to-end takes 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 `,_jsx(_components.code,{children:`payout: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:[`Unsupported `,_jsx(_components.code,{children:`chain`}),` + `,_jsx(_components.code,{children:`currency`}),` combination`]}),_jsxs(_components.td,{children:[`See `,_jsx(_components.code,{children:`/v1/action/tokens/{chain}/usdc`}),` for supported pairs`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`payout`}),` module not active for workspace`]}),_jsx(_components.td,{children:`Activate Payout Kit in the dashboard`})]}),_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, or belongs to another workspace`]}),_jsx(_components.td,{children:`Cross-tenant lookups always 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 registration)`}),_jsx(_components.td,{children:`Wait for the rails partner to confirm the bank account, then retry`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/payout/accounts/setup/virtual-account`}),` — Step 2: create the fiat virtual account`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/payout/flow-guide`,children:`Payout Kit Flow Guide`}),` — full end-to-end narrative with code samples`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/payout/accounts/quote`}),` then `,_jsx(_components.code,{children:`POST /v1/payout/accounts/execute`}),` — operate once setup is complete`]}),`\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 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"}}},"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 1","path":"/v1/payout/accounts/setup/liquidation-address","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"beneficiaryId":[{"type":"string","description":"Recipient ID (from `POST /v1/payout/recipients` ).","required":true}],"beneficiaryAccountId":[{"type":"string","description":"The recipient’s bank account ID (from `POST /v1/payout/recipients/{id}/accounts` ).","required":true}],"chain":[{"type":"string","description":"Stablecoin chain. Supported: `base` , `polygon` , `arbitrum` , `solana` . More on request.","required":true}],"currency":[{"type":"string","description":"Stablecoin symbol on the chosen chain. Supported: `usdc` , `usdt` .","required":true}]}}],"examples":{"example":{"value":{"beneficiaryId":"\u003cstring>","beneficiaryAccountId":"\u003cstring>","chain":"\u003cstring>","currency":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"Internal withdrawal address ID. You generally don’t need to store this — call setup again to retrieve."}],"address":[{"type":"string","description":"The crypto address. Send stablecoins here to trigger an off-ramp settlement to the recipient’s bank."}],"chain":[{"type":"string","description":"Echo of the chain you requested."}],"currency":[{"type":"string","description":"Echo of the stablecoin you requested."}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","address":"\u003cstring>","chain":"\u003cstring>","currency":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"relayerfi","siteName":"Relayer.fi","title":"Set up a payout account — Step 1 - Relayer.fi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-16T02:21:20.404Z","originalFileLocation":"api-reference/flows/payout-setup.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 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient\u0026#x27;s bank account.\">\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 1 - Relayer.fi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Step 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient\u0026#x27;s bank account.\">\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-setup\">\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+1\u0026amp;description=Step+1+of+the+2-step+payout+account+setup.+Creates+a+crypto+withdrawal+address+linked+to+a+recipient%27s+bank+account.\u0026amp;theme=ac545d78a150f4a69952bd9f\u0026amp;signature=71d72d14f3027713635ff5aad87c1857e473d8bec6cdf6f2b66568229404a847\">\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 1 - Relayer.fi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Step 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient\u0026#x27;s bank account.\">\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+1\u0026amp;description=Step+1+of+the+2-step+payout+account+setup.+Creates+a+crypto+withdrawal+address+linked+to+a+recipient%27s+bank+account.\u0026amp;theme=ac545d78a150f4a69952bd9f\u0026amp;signature=71d72d14f3027713635ff5aad87c1857e473d8bec6cdf6f2b66568229404a847\">\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-setup\">\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-setup.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-setup#webpage\",\"url\":\"https://docs.relayer.fi/api-reference/flows/payout-setup\",\"name\":\"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.\",\"dateModified\":\"2026-05-16T02:21:20.404Z\",\"isPartOf\":{\"@id\":\"https://docs.relayer.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-setup#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-setup#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Relayer.fi\",\"item\":\"https://docs.relayer.fi\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Set up a payout account — Step 1\",\"item\":\"https://docs.relayer.fi/api-reference/flows/payout-setup\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-setup#apireference\",\"headline\":\"Set up a payout account — Step 1\",\"name\":\"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.\",\"url\":\"https://docs.relayer.fi/api-reference/flows/payout-setup\",\"mainEntityOfPage\":{\"@id\":\"https://docs.relayer.fi/api-reference/flows/payout-setup#webpage\"},\"dateModified\":\"2026-05-16T02:21:20.404Z\",\"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-setup.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","description":"The agent pays for a remote resource that requires USDC via the x402 protocol. Budget-checked, kill-switch-gated, atomically enforced.","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","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","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"},{"title":"Get a payment quote (MXN → USD)","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 1 - Relayer.fi","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}