Creates a payout from the authenticated merchant’s permanent NGN master wallet. You do not send a customerId, wallet ID, or source account—the API derives the source wallet from your live API key.The destination account number determines how the payout is routed:
Destination
Route returned
Fee
A customer wallet belonging to your business
same_business
Free
A FossaPay wallet belonging to another business
fossapay_cross_business
Applicable payout fee
An external Nigerian bank account
external_bank
Applicable payout fee
Perform a Bank Name Enquiry first and submit the returned bank code, bank name, account name, and account number.
Beneficiary account number, up to 199 characters. FossaPay uses this value to detect same-business and cross-business wallet destinations automatically.
The endpoint returns HTTP 202. A same-business transfer may already be completed; other routes normally begin as processing and reach a terminal state asynchronously.
Retrying the identical request with the same idempotency key returns the original payout without another debit.
Reusing an idempotency key with a different body returns HTTP 409.
Each reference must also be unique for the authenticated merchant.
If a request times out, retrieve the payout by reference before deciding whether to retry. Never retry a payout with a new key merely because the first response was delayed.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FossaPay","colors":{"primary":"#0066CC","light":"#07C983","dark":"#0080FF"},"logo":{"light":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/light.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=1fdb0f379c8126b92430802a7a34cfee","dark":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/dark.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=8886a66dbff40d1edb1c472f50b2682b"},"favicon":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/favicon.ico?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=5592701e459c5143ef1e0c926ba2c478","navbar":{"links":[{"href":"mailto:product@fossapay.com","label":"Support"}],"primary":{"type":"button","label":"Get API Access","href":"https://dashboard.fossapay.com/login"}},"footer":{"socials":{"x":"https://x.com/fossapay","github":"https://github.com/fossapay","linkedin":"https://linkedin.com/company/fossapay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://t.me/+N1-Gq6L5WStmYWM8"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.fossapay.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fossapay","hasAudioNarration":false,"actualSubdomain":"fossapay","customDomains":["docs.fossapay.com"],"gitSource":{"type":"github","owner":"codewithmide","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adda9db3f04217bb37161c4","collectionId":"11ef541a-ce49-4414-9fe9-cd123722563f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adda9db3f04217bb37161c4"},"entitlements":{},"buildId":"6adda9db3f04217bb37161c4","clientVersion":"0.0.4039","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Crypto Wallets","count":10},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Virtual Wallets","count":6},{"language":"default","tag":"Bulk Payouts","count":5},{"language":"default","tag":"NGN Transfers","count":5},{"language":"default","tag":"Core Concepts","count":5},{"language":"default","tag":"Checkout Wallet","count":4},{"language":"default","tag":"Customers","count":3}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payouts/create-payout","slug":"/api-reference/payouts/create-payout","pageMetadata":{"title":"Create Master Wallet Payout","openapi":"api-reference/openapi.json POST /api/v1/payouts","description":"Send NGN directly from your business master wallet","href":"/api-reference/payouts/create-payout"},"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: \"Send NGN directly from your business master wallet\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,Table,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Creates a payout from the authenticated merchant’s permanent NGN master wallet. You do not send a `,_jsx(_components.code,{children:`customerId`}),`, wallet ID, or source account—the API derives the source wallet from your live API key.`]}),`\n`,_jsx(_components.p,{children:`The destination account number determines how the payout is routed:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Destination`}),_jsx(_components.th,{children:`Route returned`}),_jsx(_components.th,{children:`Fee`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`A customer wallet belonging to your business`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`same_business`})}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`A FossaPay wallet belonging to another business`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`fossapay_cross_business`})}),_jsx(_components.td,{children:`Applicable payout fee`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`An external Nigerian bank account`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`external_bank`})}),_jsx(_components.td,{children:`Applicable payout fee`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Perform a `,_jsx(_components.a,{href:`/api-reference/fiat-transfers/bank-name-enquiry`,children:`Bank Name Enquiry`}),` first and submit the returned bank code, bank name, account name, and account number.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`x-api-key`,type:`string`,required:true,id:`param-x-api-key`,children:_jsx(_components.p,{children:`An active production FossaPay API key with full permission. The associated business must be verified.`})}),`\n`,_jsx(ParamField,{header:`X-Idempotency-Key`,type:`string`,required:true,id:`param-x-idempotency-key`,children:_jsxs(_components.p,{children:[`A unique key of up to 255 characters for this logical payout. `,_jsx(_components.code,{children:`Idempotency-Key`}),` is also accepted. If both headers are sent, their values must match.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`amount`,type:`integer`,required:true,id:`param-amount`,children:_jsxs(_components.p,{children:[`Amount the beneficiary should receive in NGN. Minimum `,_jsx(_components.code,{children:`1`}),`.`]})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,required:true,id:`param-currency`,children:_jsxs(_components.p,{children:[`Currency code. Currently only `,_jsx(_components.code,{children:`NGN`}),` is supported.`]})}),`\n`,_jsx(ParamField,{body:`reference`,type:`string`,required:true,id:`param-reference`,children:_jsxs(_components.p,{children:[`Your unique payout reference, 1–100 characters. Allowed characters are letters, numbers, `,_jsx(_components.code,{children:`.`}),`, `,_jsx(_components.code,{children:`_`}),`, `,_jsx(_components.code,{children:`:`}),`, and `,_jsx(_components.code,{children:`-`}),`.`]})}),`\n`,_jsx(ParamField,{body:`destinationBankCode`,type:`string`,required:true,id:`param-destination-bank-code`,children:_jsx(_components.p,{children:`Bank code returned by the supported-banks or bank-name-enquiry endpoint.`})}),`\n`,_jsx(ParamField,{body:`destinationBankName`,type:`string`,required:true,id:`param-destination-bank-name`,children:_jsx(_components.p,{children:`Beneficiary bank name, up to 199 characters.`})}),`\n`,_jsx(ParamField,{body:`destinationAccountName`,type:`string`,required:true,id:`param-destination-account-name`,children:_jsx(_components.p,{children:`Verified beneficiary account name, up to 199 characters.`})}),`\n`,_jsx(ParamField,{body:`destinationAccountNumber`,type:`string`,required:true,id:`param-destination-account-number`,children:_jsx(_components.p,{children:`Beneficiary account number, up to 199 characters. FossaPay uses this value to detect same-business and cross-business wallet destinations automatically.`})}),`\n`,_jsx(ParamField,{body:`remarks`,type:`string`,id:`param-remarks`,children:_jsx(_components.p,{children:`Optional payout narration, up to 255 characters.`})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`Optional merchant-defined JSON, up to 4,096 UTF-8 bytes. It is returned unchanged in API responses and payout webhooks.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api-production.fossapay.com/api/v1/payouts`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$FOSSAPAY_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-Idempotency-Key: payout-order-10025-v1'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"amount\": 5000,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"currency\": \"NGN\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"reference\": \"PAYOUT-10025\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"destinationBankCode\": \"058\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"destinationBankName\": \"Guaranty Trust Bank\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"destinationAccountName\": \"JOHN DOE\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"destinationAccountNumber\": \"0123456789\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"remarks\": \"Vendor settlement\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"metadata\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"vendorId\": \"VEN-42\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"invoiceId\": \"INV-10025\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`The endpoint returns HTTP `,_jsx(_components.code,{children:`202`}),`. A same-business transfer may already be `,_jsx(_components.code,{children:`completed`}),`; other routes normally begin as `,_jsx(_components.code,{children:`processing`}),` and reach a terminal state asynchronously.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`30`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`30`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"statusCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`202`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Payout request processed successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payoutId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"a9af907d-965f-4ad8-9472-f437fc11df21\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"transactionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5a0bb85c-268b-44fa-a57d-70b2944688bc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PAYOUT-10025\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"processing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"route\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"external_bank\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5000.00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fee\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"80.00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalDebited\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5080.00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"NGN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recipient\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bankCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"058\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bankName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Guaranty Trust Bank\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accountName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"JOHN DOE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accountNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0123456789\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"providerReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PYT_K8Q4D2M7N5R3T9A_1789098000000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"vendorId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"VEN-42\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invoiceId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INV-10025\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"completedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"failedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reversedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`idempotency`,children:`Idempotency`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Retrying the identical request with the same idempotency key returns the original payout without another debit.`}),`\n`,_jsxs(_components.li,{children:[`Reusing an idempotency key with a different body returns HTTP `,_jsx(_components.code,{children:`409`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Each `,_jsx(_components.code,{children:`reference`}),` must also be unique for the authenticated merchant.`]}),`\n`,_jsx(_components.li,{children:`If a request times out, retrieve the payout by reference before deciding whether to retry. Never retry a payout with a new key merely because the first response was delayed.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`statuses`,children:`Statuses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`processing`})}),_jsx(_components.td,{children:`Accepted and awaiting a final provider result. Do not retry.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`completed`})}),_jsx(_components.td,{children:`The payout completed successfully.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`reversed`})}),_jsx(_components.td,{children:`The payout did not complete and the reserved funds were returned.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`failed`})}),_jsx(_components.td,{children:`The payout failed. Retrieve its latest state and contact support if funds appear reserved.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP status`}),_jsx(_components.th,{children:`When it occurs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Invalid body, missing/conflicting idempotency headers, missing master wallet, self-payment, insufficient funds, or unavailable payout configuration/provider.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Missing, invalid, inactive, revoked, non-live, or non-full-permission API key.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`The merchant has not completed business verification.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Duplicate reference or incompatible reuse of an idempotency key.`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Treat `,_jsx(_components.code,{children:`processing`}),` as non-terminal. Confirm the outcome using a signed payout webhook or either retrieval endpoint before marking a payout final.`]})})]})}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":"Create Master Wallet Payout","openapi":"api-reference/openapi.json POST /api/v1/payouts","description":"Send NGN directly from your business master wallet","href":"/api-reference/payouts/create-payout"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Body","slug":"body","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Idempotency","slug":"idempotency","depth":2,"children":[]},{"title":"Statuses","slug":"statuses","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"ExternalPayoutController_create","tags":["Master Wallet Payouts"],"summary":"Create a payout from the merchant master NGN wallet","description":"Send NGN directly from your business master wallet","parameters":["c4b22643-6e83-4e31-b635-6bc43f80fd9a"],"requestBody":"a9ea25c3-cba7-4eea-87c1-4189def43acb","responses":{"202":"417844eb-aecd-4908-9132-8097bedf0656","400":"2b2acdb9-3555-4f36-b56c-c5db79c1bc21","401":"bb1e4016-f79a-426c-a7ce-2c1b7e54efee","403":"a13639c3-bf17-4dcc-8548-3ad2583deffb","409":"deafe3dc-e7c6-47b8-bc5e-368c3e48f3bd"},"method":"post","type":"path","servers":["54b50761-17c4-4458-96ac-039d52a87412"],"security":["ce72eaae-7808-4474-855f-f963b9fae001"],"path":"/api/v1/payouts","baseUrlOptions":["https://api-production.fossapay.com"],"title":"Create a payout from the merchant master NGN wallet","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c4b22643-6e83-4e31-b635-6bc43f80fd9a":{"name":"X-Idempotency-Key","in":"header","required":true,"description":"Unique key for this logical payout. Idempotency-Key is also accepted; if both headers are sent, they must match.","schema":{"type":"string","maxLength":255,"isRequired":true,"description":"Unique key for this logical payout. Idempotency-Key is also accepted; if both headers are sent, they must match.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","reference","destinationBankCode","destinationBankName","destinationAccountName","destinationAccountNumber"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Amount the beneficiary receives in NGN.","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","enum":["NGN"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9._:-]+$","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"destinationBankCode":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"destinationBankCode","typeLabel":"string"},"destinationBankName":{"type":"string","minLength":1,"maxLength":199,"isRequired":true,"uniqueKey":"destinationBankName","typeLabel":"string"},"destinationAccountName":{"type":"string","minLength":1,"maxLength":199,"isRequired":true,"uniqueKey":"destinationAccountName","typeLabel":"string"},"destinationAccountNumber":{"type":"string","minLength":1,"maxLength":199,"isRequired":true,"uniqueKey":"destinationAccountNumber","typeLabel":"string"},"remarks":{"type":"string","maxLength":255,"uniqueKey":"remarks","typeLabel":"string"},"metadata":{"type":"object","description":"Optional merchant data limited to 4,096 UTF-8 bytes and returned unchanged.","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":2,"currency":"NGN","reference":"\u003cstring>","destinationBankCode":"\u003cstring>","destinationBankName":"\u003cstring>","destinationAccountName":"\u003cstring>","destinationAccountNumber":"\u003cstring>","remarks":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"417844eb-aecd-4908-9132-8097bedf0656":{"description":"Payout accepted, completed synchronously, or idempotently replayed","content":{"application/json":{"schema":{"type":"object","required":["status","statusCode","message","data"],"properties":{"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"statusCode":{"type":"integer","enum":[200,202],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","required":["payoutId","transactionId","reference","status","route","amount","fee","totalDebited","currency","recipient","providerReference","metadata","completedAt","failedAt","reversedAt"],"properties":{"payoutId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.payoutId","typeLabel":"string\u003cuuid>"},"transactionId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.transactionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.transactionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.transactionId","typeLabel":"string\u003cuuid> | null"},"reference":{"type":"string","isRequired":true,"uniqueKey":"data.reference","typeLabel":"string"},"status":{"type":"string","enum":["processing","completed","failed","reversed"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"route":{"type":"string","enum":["same_business","fossapay_cross_business","external_bank"],"isRequired":true,"uniqueKey":"data.route","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.amount","typeLabel":"string"},"fee":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.fee","typeLabel":"string"},"totalDebited":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.totalDebited","typeLabel":"string"},"currency":{"type":"string","enum":["NGN"],"isRequired":true,"uniqueKey":"data.currency","typeLabel":"enum\u003cstring>"},"recipient":{"type":"object","required":["bankCode","bankName","accountName","accountNumber"],"properties":{"bankCode":{"type":"string","isRequired":true,"uniqueKey":"data.recipient.bankCode","typeLabel":"string"},"bankName":{"type":"string","isRequired":true,"uniqueKey":"data.recipient.bankName","typeLabel":"string"},"accountName":{"type":"string","isRequired":true,"uniqueKey":"data.recipient.accountName","typeLabel":"string"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"data.recipient.accountNumber","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.recipient","typeLabel":"object"},"providerReference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.providerReference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.providerReference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.providerReference","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"data.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"isRequired":true,"uniqueKey":"data.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.completedAt","typeLabel":"string\u003cdate-time> | null"},"failedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.failedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.failedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.failedAt","typeLabel":"string\u003cdate-time> | null"},"reversedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.reversedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.reversedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.reversedAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","statusCode":200,"message":"\u003cstring>","data":{"payoutId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","transactionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reference":"\u003cstring>","status":"processing","route":"same_business","amount":"\u003cstring>","fee":"\u003cstring>","totalDebited":"\u003cstring>","currency":"NGN","recipient":{"bankCode":"\u003cstring>","bankName":"\u003cstring>","accountName":"\u003cstring>","accountNumber":"\u003cstring>"},"providerReference":"\u003cstring>","metadata":{},"completedAt":"2023-11-07T05:31:56Z","failedAt":"2023-11-07T05:31:56Z","reversedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2b2acdb9-3555-4f36-b56c-c5db79c1bc21":{"description":"Validation, wallet, funds, configuration, provider, or idempotency-header error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"bb1e4016-f79a-426c-a7ce-2c1b7e54efee":{"description":"Missing, invalid, inactive, revoked, non-live, or non-full-permission API key","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"a13639c3-bf17-4dcc-8548-3ad2583deffb":{"description":"Merchant KYC approval is required","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"deafe3dc-e7c6-47b8-bc5e-368c3e48f3bd":{"description":"Duplicate reference or incompatible idempotency-key reuse","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ce72eaae-7808-4474-855f-f963b9fae001":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"54b50761-17c4-4458-96ac-039d52a87412":{"url":"https://api-production.fossapay.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"fossapay","siteName":"FossaPay","title":"Create Master Wallet Payout - FossaPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T12:24:06.073Z","originalFileLocation":"api-reference/payouts/create-payout.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=\"Send NGN directly from your business master wallet\">\u003cmeta data-mint-head name=\"application-name\" content=\"FossaPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Master Wallet Payout - FossaPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send NGN directly from your business master wallet\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FossaPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fossapay.com/api-reference/payouts/create-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fossapay.mintlify.app/_mintlify/api/og/v2?division=Master+Wallet+Payouts\u0026amp;title=Create+Master+Wallet+Payout\u0026amp;description=Send+NGN+directly+from+your+business+master+wallet\u0026amp;theme=6dbf89206398ec1903cd51dc\u0026amp;signature=cfaf16ab18f659430de35a50441f37681913878bb0d80daca8adaa9cef1544c0\">\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=\"Create Master Wallet Payout - FossaPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send NGN directly from your business master wallet\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fossapay.mintlify.app/_mintlify/api/og/v2?division=Master+Wallet+Payouts\u0026amp;title=Create+Master+Wallet+Payout\u0026amp;description=Send+NGN+directly+from+your+business+master+wallet\u0026amp;theme=6dbf89206398ec1903cd51dc\u0026amp;signature=cfaf16ab18f659430de35a50441f37681913878bb0d80daca8adaa9cef1544c0\">\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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FossaPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fossapay.com/api-reference/payouts/create-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payouts/create-payout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fossapay.com/#organization\",\"name\":\"FossaPay\",\"url\":\"https://docs.fossapay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/light.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=1fdb0f379c8126b92430802a7a34cfee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fossapay.com#website\",\"name\":\"FossaPay\",\"url\":\"https://docs.fossapay.com\",\"publisher\":{\"@id\":\"https://docs.fossapay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fossapay.com/api-reference/payouts/create-payout#webpage\",\"url\":\"https://docs.fossapay.com/api-reference/payouts/create-payout\",\"name\":\"Create Master Wallet Payout\",\"description\":\"Send NGN directly from your business master wallet\",\"dateModified\":\"2026-09-15T12:24:06.073Z\",\"isPartOf\":{\"@id\":\"https://docs.fossapay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fossapay.com/api-reference/payouts/create-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fossapay.com/api-reference/payouts/create-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"FossaPay\",\"item\":\"https://docs.fossapay.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Master Wallet Payout\",\"item\":\"https://docs.fossapay.com/api-reference/payouts/create-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fossapay.com/api-reference/payouts/create-payout#apireference\",\"headline\":\"Create Master Wallet Payout\",\"name\":\"Create Master Wallet Payout\",\"description\":\"Send NGN directly from your business master wallet\",\"url\":\"https://docs.fossapay.com/api-reference/payouts/create-payout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fossapay.com/api-reference/payouts/create-payout#webpage\"},\"dateModified\":\"2026-09-15T12:24:06.073Z\",\"publisher\":{\"@id\":\"https://docs.fossapay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fossapay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FossaPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FossaPay","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://t.me/+N1-Gq6L5WStmYWM8"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.fossapay.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Customers","pages":[{"title":"Create Customer Account","openapi":"api-reference/openapi.json POST /api/v1/customers","href":"/api-reference/customers/create-customer"},{"title":"Get All Customers","openapi":"api-reference/openapi.json GET /api/v1/customers","href":"/api-reference/customers/get-all-customers"},{"title":"Get Customer by ID","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"}]},{"group":"Virtual Wallets","pages":[{"title":"Create Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/fiat/create","href":"/api-reference/virtual-account/create-wallet"},{"title":"Get Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/{walletId}","href":"/api-reference/virtual-account/get-wallet"},{"title":"Get Master NGN Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/master","href":"/api-reference/virtual-account/get-master-wallet"},{"title":"Get Wallet by Account Number","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/account/{accountNumber}","href":"/api-reference/virtual-account/get-wallet-by-account"},{"title":"Fetch Wallet Transactions","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/{walletId}/transactions","href":"/api-reference/virtual-account/wallet-transactions"},{"title":"Fetch Wallet Single Transaction","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/transactions/{transactionId}","href":"/api-reference/virtual-account/wallet-transaction"}]},{"group":"Checkout Wallet","pages":[{"title":"Create Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts","href":"/api-reference/checkouts/create-checkout"},{"title":"Get Checkout by ID","openapi":"api-reference/openapi.json GET /api/v1/checkouts/{id}","href":"/api-reference/checkouts/get-checkout"},{"title":"Get Checkout by Reference","openapi":"api-reference/openapi.json GET /api/v1/checkouts/reference/{reference}","href":"/api-reference/checkouts/get-checkout-by-reference"},{"title":"Expire Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts/{id}/expire","href":"/api-reference/checkouts/expire-checkout"}]},{"group":"Identity Verification","pages":[{"title":"Verify Identity","openapi":"api-reference/openapi.json POST /api/v1/kyc/verifications","description":"Look up a Nigerian NIN for ₦120 or BVN for ₦70 per attempt","href":"/api-reference/identity-verification/verify-identity"}]},{"group":"Master Wallet Payouts","pages":[{"title":"Create Master Wallet Payout","openapi":"api-reference/openapi.json POST /api/v1/payouts","href":"/api-reference/payouts/create-payout"},{"title":"Get Payout by ID","openapi":"api-reference/openapi.json GET /api/v1/payouts/{id}","description":"Retrieve a master-wallet payout using its FossaPay payout ID","href":"/api-reference/payouts/get-payout"},{"title":"Get Payout by Reference","openapi":"api-reference/openapi.json GET /api/v1/payouts/reference/{reference}","href":"/api-reference/payouts/get-payout-by-reference"}]},{"group":"NGN Transfers","pages":[{"title":"Get Supported Banks","openapi":"api-reference/openapi.json GET /api/v1/transfers/fiat/banks","href":"/api-reference/fiat-transfers/get-supported-banks"},{"title":"Bank Name Enquiry","openapi":"api-reference/openapi.json POST /api/v1/transfers/fiat/bank-name-enquiry","href":"/api-reference/fiat-transfers/bank-name-enquiry"},{"title":"Wallet-to-Wallet Transfer (Free)","openapi":"api-reference/openapi.json POST /api/v1/wallets/fiat/transfers/wallet-to-wallet","href":"/api-reference/virtual-account/wallet-transfer"},{"title":"Inter-Bank Transfer (External Bank)","openapi":"api-reference/openapi.json POST /api/v1/transfers/fiat/inter-bank","href":"/api-reference/fiat-transfers/inter-bank-transfer"},{"title":"Calculate NGN Transfer Fee","openapi":"api-reference/openapi.json GET /api/v1/transfers/fiat/calculate-fee","href":"/api-reference/fiat-transfers/calculate-fee"}]},{"group":"Bulk Payouts","pages":[{"title":"Create Bulk Payout Batch","openapi":"api-reference/openapi.json POST /api/v1/payouts/batches","playground":"interactive","href":"/api-reference/bulk-payouts/create-batch"},{"title":"List Bulk Payout Batches","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches","playground":"interactive","href":"/api-reference/bulk-payouts/list-batches"},{"title":"Get Bulk Payout Batch","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch"},{"title":"Get Bulk Payout Recipients","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}/recipients","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch-recipients"},{"title":"Get Bulk Payout Status","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}/status","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch-status"}]},{"group":"Crypto Wallets","pages":[{"title":"Create Crypto Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/create","href":"/api-reference/crypto-wallets/create-wallet"},{"title":"Create Master Crypto Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/master/create","href":"/api-reference/crypto-wallets/create-master-wallet"},{"title":"Get Master Crypto Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/master","href":"/api-reference/crypto-wallets/get-master-wallet"},{"title":"Get Customer Wallet Balance","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/customer/{customerId}/balance","href":"/api-reference/crypto-wallets/get-customer-balance"},{"title":"Sign a Master Wallet Transaction","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/master/transactions/sign-and-broadcast","href":"/api-reference/crypto-wallets/sign-master-transaction"},{"title":"Sign a Customer Wallet Transaction","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/customer/{customerId}/transactions/sign-and-broadcast","href":"/api-reference/crypto-wallets/sign-customer-transaction"},{"title":"Get Wallet by ID","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/{walletId}","href":"/api-reference/crypto-wallets/get-wallet-by-id"},{"title":"Get Wallet by Address","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/address/{address}","href":"/api-reference/crypto-wallets/get-wallet-by-address"},{"title":"Get All Wallet Transactions","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/{walletId}/transactions","href":"/api-reference/crypto-wallets/wallet-transactions"},{"title":"Get Wallet Single Transaction","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/transactions/{transactionId}","href":"/api-reference/crypto-wallets/wallet-transaction"}]},{"group":"Crypto Transfers","pages":[{"title":"Crypto Transfer","openapi":"api-reference/openapi.json POST /api/v1/transfers/crypto","href":"/api-reference/crypto-transfers/crypto-transfer"},{"title":"Calculate Crypto Transfer Fee","openapi":"api-reference/openapi.json GET /api/v1/transfers/crypto/calculate-fee","href":"/api-reference/crypto-transfers/calculate-fee"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/api-reference/webhooks/overview"},{"title":"Webhook Events","href":"/api-reference/webhooks/events"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]}]},"basePath":"","title":"Create Master Wallet Payout - FossaPay","buildId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","deploymentId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CVpqyvFO.js","utils-vpweLD0v.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BIOodqb0.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1LM3qmu.js","snippetPresets-C5xK0GtN.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CCsxLnQl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C2-WKG22.js","shallow-SdoLUC-q.js","getApiPlaygroundDisplay-BnI8L2hB.js","CodeSnippet-D5M8NCHI.js","CodeSnippets-CXRO8Uom.js","Page-CN9QbZiA.js","getPastedJson-CrfHEdRt.js","icon-Cr8AyUnW.js","MethodPill-J_Cs0kNw.js","DuplicateIcon-DrMboxGw.js","createIcon-B4CIWVbU.js","DynamicMarkdown-D9cdbgj9.js","SectionHeading-BO4CouT0.js","axios-vUo_bRtp.js","Markdown-L1m1-PSi.js","clsx-rIpTdK8h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-ptfS1uB_.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D31Sm3f9.js"]}