{
"error": {
"code": "payload_too_large",
"message": "Request body is too large",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#payload_too_large"
}
}
{
"error": {
"code": "BUSINESS_BLOCKED",
"message": "This Business is blocked from authorising payouts; contact Cleff to resolve it. Payouts awaiting approval can still be rejected.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "production"
},
"docs_url": "https://docs.usecleff.com/errors#business_blocked"
}
}
{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}
Payouts
Bulk-create Payouts
Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.
Content hash of the uploaded file, computed client-side. Tags every Payout's via and seeds each row's idempotency key so a byte-identical re-upload replays instead of duplicating.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Cleff API","description":"What it is: Cleff is a payout orchestration platform. A business registers each payee (a Beneficiary), funds its Cleff Account and sends payout instructions. Cleff validates, routes and tracks each payout to disbursement. It is available through a REST/JSON API (api.usecleff.com) and a dashboard (app.usecleff.com).\n\nWho it’s for: Businesses that pay people at volume: contractors, traders and agents. The beachhead is prop trading firms, but the architecture isn’t tied to that industry.\n\nWhat sets it apart:\n\n- It does not hold or move funds. Cleff sends instructions to downstream providers, so it positions itself as infrastructure and not a money services business.\n- ACH is the default rail. RTP and FedNow are available once a Business is approved for them.\n- Sandbox is open as soon as you verify your email. Production unlocks after business verification.\n- It has webhooks, idempotency and approvals, and the docs are built for AI agents: llms.txt, per-page .md, an MCP server and an installable skill.","colors":{"primary":"#0E1216","light":"#42D898","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-White.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=39ae818520b68ee890b4d5008a4bc08d","href":"https://www.usecleff.com"},"favicon":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137"},"api":{"openapi":"openapi.json","examples":{"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"decoration":"grid","color":{"light":"#F8FAFB","dark":"#0E1216"}},"navbar":{"links":[{"href":"https://app.usecleff.com/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.usecleff.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cleff-inc","website":"https://www.usecleff.com","github":"https://github.com/usecleff"},"links":[{"header":"COMPANY","items":[{"label":"Brand Assets","href":"https://usecleff.com/brand-assets"},{"label":"Contact","href":"mailto:support@usecleff.com"}]},{"header":"LEGAL","items":[{"label":"Terms \u0026 Conditions","href":"https://usecleff.com/legal/terms"},{"label":"Privacy Policy","href":"https://usecleff.com/legal/privacy"}]}]},"seo":{"metatags":{"og:site_name":"Cleff API Docs","og:type":"website","robots":"index, follow, max-snippet:-1, max-image-preview:large","theme-color":"#0E1216"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cleff","hasAudioNarration":false,"actualSubdomain":"cleff","customDomains":["docs.usecleff.com"],"gitSource":{"type":"github","owner":"usecleff","repo":"cleff","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adba51ff69436d352bb4820","collectionId":"8ec4aa8d-643d-44f7-b69f-9f5b98e9747f","liveDeploymentHistoryId":"6adba51ff69436d352bb4820","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adba51ff69436d352bb4820","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Reference","count":34},{"language":"default","tag":"Beneficiaries","count":18},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Payouts","count":11},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Essentials","count":5},{"language":"default","tag":"Bank accounts","count":3},{"language":"default","tag":"Collection invites","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@usecleff.com"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payouts-bulk-create","slug":"/api-reference/payouts-bulk-create","pageMetadata":{"title":"Bulk-create Payouts","openapi":"POST /v1/payouts/bulk","description":"Creates one Payout per row, each in `pending_approval`, naming its Beneficiary by exactly one of `beneficiary_id` or `beneficiary_email` (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an `error_code` from [Errors](/errors) when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see [Idempotency](/idempotency#retry-a-bulk-upload).","href":"/api-reference/payouts-bulk-create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates one Payout per row, each in \", _jsx(_components.code, {\n children: \"pending_approval\"\n }), \", naming its Beneficiary by exactly one of \", _jsx(_components.code, {\n children: \"beneficiary_id\"\n }), \" or \", _jsx(_components.code, {\n children: \"beneficiary_email\"\n }), \" (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an \", _jsx(_components.code, {\n children: \"error_code\"\n }), \" from \", _jsx(_components.a, {\n href: \"/errors\",\n children: \"Errors\"\n }), \" when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see \", _jsx(_components.a, {\n href: \"/idempotency#retry-a-bulk-upload\",\n children: \"Idempotency\"\n }), \".\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Agents:`}),` fetch this page as plain markdown at\n`,_jsx(_components.code,{children:`https://docs.usecleff.com/api-reference/payouts-bulk-create.md`}),`.`]})})}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":"Bulk-create Payouts","openapi":"POST /v1/payouts/bulk","description":"Creates one Payout per row, each in `pending_approval`, naming its Beneficiary by exactly one of `beneficiary_id` or `beneficiary_email` (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an `error_code` from [Errors](/errors) when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see [Idempotency](/idempotency#retry-a-bulk-upload).","href":"/api-reference/payouts-bulk-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Creates one Payout per row, each in `pending_approval`, naming its Beneficiary by exactly one of `beneficiary_id` or `beneficiary_email` (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an `error_code` from [Errors](/errors) when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see [Idempotency](/idempotency#retry-a-bulk-upload).","operationId":"PayoutsController_bulkCreate","parameters":[],"requestBody":"21f361a9-3321-46f4-9a2c-6eaf37d4f60c","responses":{"200":"ae86b623-84b2-442a-82a9-abc450a12be1","400":"bea8f6d5-c68c-4c0f-b262-43ed3900e9d4","401":"c4a7d4a7-fd44-48cd-9785-fa4e177a5e87","403":"fc39465d-63b7-4e56-91ec-87e675821ef3","413":"43a965af-77c5-4418-8e8e-fb327f2f4418","422":"704244a9-5b4a-49d6-acb6-27f51d495a42","429":"abfaf952-6348-4f5c-ba14-87e5c98cf710"},"security":["3ee2dd6a-5f2e-49e0-a985-6261242f0514"],"summary":"Bulk-create Payout Intents from CSV rows","tags":["Payouts"],"method":"post","type":"path","servers":["23957774-ce69-4779-ae1b-7bae81a3b325"],"path":"/v1/payouts/bulk","baseUrlOptions":["https://api.usecleff.com"],"title":"Bulk-create Payout Intents from CSV rows","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","description":"Content hash of the uploaded file, computed client-side. Tags every Payout's `via` and seeds each row's idempotency key so a byte-identical re-upload replays instead of duplicating.","isRequired":true,"uniqueKey":"uploadId","typeLabel":"string"},"rows":{"description":"Parsed CSV rows (1..1000). Each row is validated individually server-side; a bad row fails only itself.","type":"array","items":{"type":"object","properties":{"amount_minor":{"type":"number","isRequired":true,"uniqueKey":"rows.items.[INDEX].amount_minor","typeLabel":"number"},"currency":{"type":"string","description":"ISO 4217 currency code","isRequired":true,"uniqueKey":"rows.items.[INDEX].currency","typeLabel":"string"},"purpose_of_payment":{"type":"string","enum":["advertising","advisor_fees","charity","education","family_support","investment","loan_repayment","medical","other","payroll","purchase_of_goods","purchase_of_services","real_estate","royalties","taxes","treasury","travel"],"isRequired":true,"uniqueKey":"rows.items.[INDEX].purpose_of_payment","typeLabel":"enum\u003cstring>"},"beneficiary_id":{"type":"string","format":"uuid","description":"Send exactly one of `beneficiary_id` and `beneficiary_email`.","uniqueKey":"rows.items.[INDEX].beneficiary_id","typeLabel":"string\u003cuuid>"},"beneficiary_email":{"type":"string","format":"email","description":"The Beneficiary's email, matched case-insensitively among your live (non-archived) Beneficiaries in this environment. Send exactly one of `beneficiary_id` and `beneficiary_email`. A row that matches none fails with BENEFICIARY_EMAIL_NOT_FOUND.","uniqueKey":"rows.items.[INDEX].beneficiary_email","typeLabel":"string\u003cemail>"},"destination_id":{"type":"string","format":"uuid","description":"Omit to pay the Beneficiary's declared destination, or their only payout-usable one. Name one of their destinations to pay that one instead.","uniqueKey":"rows.items.[INDEX].destination_id","typeLabel":"string\u003cuuid>"},"bank_account_id":{"type":"string","format":"uuid","deprecated":true,"uniqueKey":"rows.items.[INDEX].bank_account_id","typeLabel":"string\u003cuuid>"},"external_ref":{"type":"string","description":"Business-supplied reference (e.g. tradeId/jobId).","uniqueKey":"rows.items.[INDEX].external_ref","typeLabel":"string"},"idempotency_key":{"type":"string","description":"Overrides the derived `${uploadId}:${index}` key for this row.","uniqueKey":"rows.items.[INDEX].idempotency_key","typeLabel":"string"}},"required":["amount_minor","currency","purpose_of_payment"],"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rows","typeLabel":"object[]"}},"required":["uploadId","rows"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"uploadId":"\u003cstring>","rows":[{"amount_minor":123,"currency":"\u003cstring>","beneficiary_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","beneficiary_email":"jsmith@example.com","destination_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","bank_account_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","external_ref":"\u003cstring>","idempotency_key":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ae86b623-84b2-442a-82a9-abc450a12be1":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"Zero-based position of the row in the request.","isRequired":true,"uniqueKey":"results.items.[INDEX].index","typeLabel":"number"},"status":{"type":"string","enum":["created","replayed","failed"],"isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"payout_id":{"oneOf":[{"type":"string","description":"Set for created/replayed.","uniqueKey":"results.items.[INDEX].payout_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set for created/replayed.","uniqueKey":"results.items.[INDEX].payout_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].payout_id","typeLabel":"string | null"},"error":{"oneOf":[{"type":"string","description":"Field-level reason a failed row was rejected.","uniqueKey":"results.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field-level reason a failed row was rejected.","uniqueKey":"results.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].error","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","description":"The error code the single-payout endpoint would return for this refusal (see the error reference). Absent when the row failed on its shape.","uniqueKey":"results.items.[INDEX].error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code the single-payout endpoint would return for this refusal (see the error reference). Absent when the row failed on its shape.","uniqueKey":"results.items.[INDEX].error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].error_code","typeLabel":"string | null"}},"required":["index","status"],"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"}},"required":["results"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"index":123,"status":"created","payout_id":"\u003cstring>","error":"\u003cstring>","error_code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"bea8f6d5-c68c-4c0f-b262-43ed3900e9d4":{"description":"The upload itself failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"uploadId","code":"is_required","message":"uploadId should not be empty"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"uploadId","code":"is_required","message":"uploadId should not be empty"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c4a7d4a7-fd44-48cd-9785-fa4e177a5e87":{"description":"The API key is missing, invalid or revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fc39465d-63b7-4e56-91ec-87e675821ef3":{"description":"The API key's role cannot make this request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"43a965af-77c5-4418-8e8e-fb327f2f4418":{"description":"The upload is larger than the request body limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"payload_too_large","message":"Request body is too large","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#payload_too_large"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"payload_too_large","message":"Request body is too large","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#payload_too_large"}}}},"exampleType":"examples"}},"exampleType":"examples"},"704244a9-5b4a-49d6-acb6-27f51d495a42":{"description":"In production, Cleff has blocked this Business from authorising payouts.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"BUSINESS_BLOCKED","message":"This Business is blocked from authorising payouts; contact Cleff to resolve it. Payouts awaiting approval can still be rejected.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"production"},"docs_url":"https://docs.usecleff.com/errors#business_blocked"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BUSINESS_BLOCKED","message":"This Business is blocked from authorising payouts; contact Cleff to resolve it. Payouts awaiting approval can still be rejected.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"production"},"docs_url":"https://docs.usecleff.com/errors#business_blocked"}}}},"exampleType":"examples"}},"exampleType":"examples"},"abfaf952-6348-4f5c-ba14-87e5c98cf710":{"description":"Too many requests for this Business and environment.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3ee2dd6a-5f2e-49e0-a985-6261242f0514":{"api_key":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"}}},"servers":{"23957774-ce69-4779-ae1b-7bae81a3b325":{"url":"https://api.usecleff.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Cleff API key, created in the dashboard under Settings → API keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi.json"},"subdomain":"cleff","siteName":"Cleff API","title":"Bulk-create Payouts - Cleff API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T22:17:22.225Z","originalFileLocation":"api-reference/payouts-bulk-create.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=\"Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bulk-create Payouts - Cleff API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cleff API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usecleff.com/api-reference/payouts-bulk-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Bulk-create+Payouts\u0026amp;description=Creates+one+Payout+per+row%2C+each+in+%60pending_approval%60%2C+naming+its+Beneficiary+by+exactly+one+of+%60beneficiary_id%60+or+%60beneficiary_email%60+%28matched+case-insensiti\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=ddb38f0cd36938fe84f644c81a1b689efa88d6dd31272ca23db552f950845ab9\">\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=\"Bulk-create Payouts - Cleff API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Bulk-create+Payouts\u0026amp;description=Creates+one+Payout+per+row%2C+each+in+%60pending_approval%60%2C+naming+its+Beneficiary+by+exactly+one+of+%60beneficiary_id%60+or+%60beneficiary_email%60+%28matched+case-insensiti\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=ddb38f0cd36938fe84f644c81a1b689efa88d6dd31272ca23db552f950845ab9\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/cleff/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E1216\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0E1216\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usecleff.com/api-reference/payouts-bulk-create\">\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-bulk-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usecleff.com/#organization\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usecleff.com#website\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create#webpage\",\"url\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create\",\"name\":\"Bulk-create Payouts\",\"description\":\"Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.\",\"dateModified\":\"2026-10-01T22:17:22.225Z\",\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payouts\",\"item\":\"https://docs.usecleff.com/api-reference/payouts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bulk-create Payouts\",\"item\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create#apireference\",\"headline\":\"Bulk-create Payouts\",\"name\":\"Bulk-create Payouts\",\"description\":\"Creates one Payout per row, each in pending_approval, naming its Beneficiary by exactly one of beneficiary_id or beneficiary_email (matched case-insensitively among your live Beneficiaries). A row that fails is reported in its own result, with an error_code from Errors when the refusal has one, and never stops the rest of the file. Re-sending the same upload replays every row instead of duplicating it; see Idempotency.\",\"url\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecleff.com/api-reference/payouts-bulk-create#webpage\"},\"dateModified\":\"2026-10-01T22:17:22.225Z\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cleff API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cleff API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"rocket","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Reference","pages":[{"group":"Beneficiaries","pages":[{"title":"Beneficiaries","href":"/api-reference/beneficiaries"},{"title":"Create a Beneficiary","openapi":"POST /v1/beneficiaries","href":"/api-reference/beneficiaries-create"},{"title":"Import a Beneficiary base","openapi":"POST /v1/beneficiaries/import","href":"/api-reference/beneficiaries-import"},{"title":"Update a Beneficiary","openapi":"PUT /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-update"},{"title":"List Beneficiaries","openapi":"GET /v1/beneficiaries","href":"/api-reference/beneficiaries-list"},{"title":"Retrieve a Beneficiary","openapi":"GET /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-get"},{"title":"Export Beneficiaries","openapi":"GET /v1/beneficiaries/export","href":"/api-reference/beneficiaries-export"},{"title":"Archive a Beneficiary","openapi":"DELETE /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-archive"},{"title":"Acknowledge compliance","openapi":"POST /v1/beneficiaries/{id}/compliance-acknowledgment","href":"/api-reference/beneficiaries-acknowledge"},{"title":"Set a declared destination","openapi":"PUT /v1/beneficiaries/{id}/declared-destination","href":"/api-reference/beneficiaries-declared-destination-update"},{"group":"Collection invites","pages":[{"title":"Invite Beneficiaries to submit details","openapi":"POST /v1/beneficiaries/collection-invites","href":"/api-reference/beneficiaries-collection-invites"},{"title":"Bulk-invite Beneficiaries","openapi":"POST /v1/beneficiaries/bulk-invites","href":"/api-reference/beneficiaries-bulk-invites"},{"title":"Cancel a collection request","openapi":"DELETE /v1/beneficiaries/{id}/collection-requests/{requestId}","href":"/api-reference/beneficiaries-collection-requests-cancel"}]},{"group":"Bank accounts","pages":[{"title":"List bank accounts","openapi":"GET /v1/beneficiaries/{id}/bank-accounts","href":"/api-reference/beneficiaries-bank-accounts-list"},{"title":"Register a bank account","openapi":"POST /v1/beneficiaries/{id}/bank-accounts","href":"/api-reference/beneficiaries-bank-accounts-create"},{"title":"Delete a destination","openapi":"DELETE /v1/beneficiaries/{id}/bank-accounts/{accountId}","href":"/api-reference/beneficiaries-bank-accounts-delete"}]}]},{"group":"Funding","pages":[{"title":"Overview","href":"/api-reference/funding"},{"title":"Get Cleff Account","openapi":"GET /v1/funding/account","href":"/api-reference/funding-account-get"},{"title":"Top up sandbox balance","openapi":"POST /v1/business/funding-account/sandbox-balance","href":"/api-reference/funding-sandbox-balance"}]},{"group":"Payouts","pages":[{"title":"Overview","href":"/api-reference/payouts"},{"title":"Create a Payout","openapi":"POST /v1/payouts","description":"Creates a Payout in `pending_approval`, where it waits for a Decision. Every request carries an idempotency key, so a retry returns the original Payout instead of creating a second one; see [Idempotency](/idempotency#retry-a-payout-you-created). Each refusal and how to resolve it is listed on [Errors](/errors).","href":"/api-reference/payouts-create"},{"title":"Bulk-create Payouts","openapi":"POST /v1/payouts/bulk","href":"/api-reference/payouts-bulk-create"},{"title":"List Payouts","openapi":"GET /v1/payouts","description":null,"href":"/api-reference/payouts-list"},{"title":"Retrieve a Payout","openapi":"GET /v1/payouts/{payoutId}","href":"/api-reference/payouts-get"},{"title":"Approve a Payout","openapi":"POST /v1/payouts/{payoutId}/approve","href":"/api-reference/payouts-approve"},{"title":"Reject a Payout","openapi":"POST /v1/payouts/{payoutId}/reject","href":"/api-reference/payouts-reject"},{"title":"Submit a Decision","openapi":"POST /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-create"},{"title":"List Decisions","openapi":"GET /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-list"}]},{"group":"Webhooks","pages":[{"title":"Create or rotate a webhook subscription","openapi":"POST /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-create"},{"title":"Get the webhook subscription","openapi":"GET /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-get"},{"title":"Update the webhook subscription","openapi":"PATCH /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-update"},{"title":"Delete the webhook subscription","openapi":"DELETE /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-delete"},{"title":"Payout events","href":"/api-reference/webhook-events-payout"},{"title":"Beneficiary events","href":"/api-reference/webhook-events-beneficiary"}]}]}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Bulk-create Payouts - Cleff API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}