{
"success": false,
"error": {
"code": "AUTOMATED_PAYOUTS_ACTIVE",
"message": "This store pays vendors automatically, so payouts cannot also be made through the API. To pay through the API, go to Settings > Payouts > Automated Payouts and select \"Disable Automated Payouts\".",
"errorId": "err_1792776147401_4vdjdqw"
}
}
Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice.
Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE.
Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED.
method: "manual" only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout’s payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/ and GET /payouts/transactions. batches[].markAsPaid has marked only.
{
"success": false,
"error": {
"code": "AUTOMATED_PAYOUTS_ACTIVE",
"message": "This store pays vendors automatically, so payouts cannot also be made through the API. To pay through the API, go to Settings > Payouts > Automated Payouts and select \"Disable Automated Payouts\".",
"errorId": "err_1792776147401_4vdjdqw"
}
}
Pay line items and adjustments to one or more vendors.
When to use
After a successful preview. The payout runs in the background. You get a transactionId to poll. Send one Idempotency-Key per payout. Part of the Pay vendors with the API flow.Same key and the same body:
Still processing: 409 IDEMPOTENCY_IN_PROGRESS. Poll details.transactionId.
After the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. transactionId, dryRun, vendors and totalPayout match the first response. Nothing is paid twice.
Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. Use a new key.Read status from the response you get. Retry code must accept either 202 or 200 and read status from the body. For the latest status, call Get a payout (GET /payouts/make-payment/{id}).
Request and response
The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.A finished replay is 200. The body has these fields:
Field
Meaning
requestId
Request ID; quote it to support.
status
The current status. Usually completed by the time this 200 is returned.
JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.
Headers
Idempotency-Key
string
required
Required. A unique string you choose, 8–128 characters (a UUID works). Use one key per payout you intend to make. Same key and the same body while the first request is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. A new key is a new payout.
Required string length: 8 - 128
Body
application/json
vendors
object[]
required
The vendors to pay, one group each, paid as one batch per vendor. A vendorId may appear only once, and a line item or adjustment id under only one vendor (ids compare case-insensitively). Every vendor must belong to this shop and be ready for the method, or the whole request is refused and nothing is paid.
Required array length: 1 - 50 elements
Show child attributes
method
enum<string>
required
READ-side method name, one for every vendor of the run; mapped to legacy resolver keys at the bridge. manual records a payment made outside the app and needs manualMethod
Available options:
stripe,
paypal,
globalPayouts,
manual
manualMethod
enum<string>
How a manual payout was made, the same options as the merchant portal. Required when method is manual, refused with any other method. Shown in the vendor email. A manual payout's payoutMethod is other.
Available options:
bankTransfer,
paypal,
cash,
other
Example:
"bankTransfer"
notifyVendor
boolean
default:true
Whether the run emails the vendor
payoutDate
string<date-time>string<date>
Recorded as the payout date. Either an RFC 3339 date-time or a calendar date without a time (YYYY-MM-DD), recorded as that day in the merchant portal's MM/DD/YYYY. When omitted, defaults to today in the shop's timezone (as MM/DD/YYYY), as the merchant portal pre-fills it
Example:
"2026-03-02"
comment
string
Free-text note recorded with the run
Maximum string length: 2000
Response
Same Idempotency-Key and the same body, after the run has finished. replay is true. status is the current status. It moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. transactionId, dryRun, vendors and totalPayout match the first response. Nothing is paid twice. Read status here, or call GET /payouts/make-payment/{transactionId} for the latest status.
success
boolean
data
object
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PuppetVendors API","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/light.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=334773803bc34a3293e61a5efa488140","dark":"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/dark.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=203f04ba19ba014e8b2e5d16adb535dd"},"favicon":"https://mintcdn.com/puppetvendors-26/sD9D69AzyUrevT_4/favicon.svg?fit=max\u0026auto=format\u0026n=sD9D69AzyUrevT_4\u0026q=85\u0026s=da8f4187f7e57f1a74e0b540a4b31f87","api":{"mdx":{"auth":{"method":"key","name":"x-access-token"},"server":"https://production-api.puppetvendors.com"}},"navbar":{"links":[{"href":"mailto:support@puppetvendors.com","label":"Support"}]},"footer":{},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"PuppetVendors","icon":"globe","href":"https://puppetvendors.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"puppetvendors-26","hasAudioNarration":false,"actualSubdomain":"puppetvendors-26","customDomains":["dev.puppetvendors.com"],"gitSource":{"type":"github","owner":"puppetvendors","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adcc9066fc254ddb8b5a521","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Vendors - V2","count":100},{"language":"default","tag":"Merchants - V2","count":48},{"language":"default","tag":"API V1","count":27},{"language":"default","tag":"Products","count":27},{"language":"default","tag":"Vendors","count":19},{"language":"default","tag":"Payouts","count":16},{"language":"default","tag":"Users","count":15},{"language":"default","tag":"Integrations","count":13},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Fulfillments","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/v2/merchant/endpoint/make-payout-payment","slug":"/api-reference/v2/merchant/endpoint/make-payout-payment","pageMetadata":{"openapi":"openapi-merchant.json POST /payouts/make-payment","title":"Create a payout","description":"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a `transactionId` to poll. Send a unique `Idempotency-Key` so a retry does not pay twice.\n\nNot available while Automated Payouts is on: returns 409 `AUTOMATED_PAYOUTS_ACTIVE`.\n\nIdempotency: send an `Idempotency-Key` header. Same key and the same body while the run is still processing: 409 `IDEMPOTENCY_IN_PROGRESS`. Same key and the same body after the run finishes: 200 with `replay: true` and the current `status`. `status` moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same `transactionId`, `dryRun`, `vendors` and `totalPayout` as the first response, and nothing is paid twice. Read `status` from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 `IDEMPOTENCY_KEY_REUSED`.\n\n`method: \"manual\"` only records a payout you settle yourself; no money moves through PuppetVendors. `manualMethod` (`bankTransfer`, `paypal`, `cash`, `other`) is required with it. A manual payout's `payoutMethod` is `other`. Your `comment` is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. `batches[].markAsPaid` has `marked` only.","href":"/api-reference/v2/merchant/endpoint/make-payout-payment"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a \", _jsx(_components.code, {\n children: \"transactionId\"\n }), \" to poll. Send a unique \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" so a retry does not pay twice.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Not available while Automated Payouts is on: returns 409 \", _jsx(_components.code, {\n children: \"AUTOMATED_PAYOUTS_ACTIVE\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Idempotency: send an \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" header. Same key and the same body while the run is still processing: 409 \", _jsx(_components.code, {\n children: \"IDEMPOTENCY_IN_PROGRESS\"\n }), \". Same key and the same body after the run finishes: 200 with \", _jsx(_components.code, {\n children: \"replay: true\"\n }), \" and the current \", _jsx(_components.code, {\n children: \"status\"\n }), \". \", _jsx(_components.code, {\n children: \"status\"\n }), \" moves from \", _jsx(_components.code, {\n children: \"processing\"\n }), \" to \", _jsx(_components.code, {\n children: \"completed\"\n }), \" once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same \", _jsx(_components.code, {\n children: \"transactionId\"\n }), \", \", _jsx(_components.code, {\n children: \"dryRun\"\n }), \", \", _jsx(_components.code, {\n children: \"vendors\"\n }), \" and \", _jsx(_components.code, {\n children: \"totalPayout\"\n }), \" as the first response, and nothing is paid twice. Read \", _jsx(_components.code, {\n children: \"status\"\n }), \" from the response you get. For the latest status, call GET /payouts/make-payment/\", \". Same key and a different body: 422 \", _jsx(_components.code, {\n children: \"IDEMPOTENCY_KEY_REUSED\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"method: \\\"manual\\\"\"\n }), \" only records a payout you settle yourself; no money moves through PuppetVendors. \", _jsx(_components.code, {\n children: \"manualMethod\"\n }), \" (\", _jsx(_components.code, {\n children: \"bankTransfer\"\n }), \", \", _jsx(_components.code, {\n children: \"paypal\"\n }), \", \", _jsx(_components.code, {\n children: \"cash\"\n }), \", \", _jsx(_components.code, {\n children: \"other\"\n }), \") is required with it. A manual payout’s \", _jsx(_components.code, {\n children: \"payoutMethod\"\n }), \" is \", _jsx(_components.code, {\n children: \"other\"\n }), \". Your \", _jsx(_components.code, {\n children: \"comment\"\n }), \" is returned on the payout. Read both from GET /payouts/make-payment/\", \" and GET /payouts/transactions. \", _jsx(_components.code, {\n children: \"batches[].markAsPaid\"\n }), \" has \", _jsx(_components.code, {\n children: \"marked\"\n }), \" only.\"]\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`purpose`,children:`Purpose`}),`\n`,_jsx(_components.p,{children:`Pay line items and adjustments to one or more vendors.`}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use`,children:`When to use`}),`\n`,_jsxs(_components.p,{children:[`After a successful preview. The payout runs in the background. You get a `,_jsx(_components.code,{children:`transactionId`}),` to poll. Send one `,_jsx(_components.code,{children:`Idempotency-Key`}),` per payout. Part of the `,_jsx(_components.a,{href:`/api-reference/v2/merchant/guides/pay-vendors`,children:`Pay vendors with the API`}),` flow.`]}),`\n`,_jsx(_components.p,{children:`Same key and the same body:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Still processing: `,_jsx(_components.code,{children:`409 IDEMPOTENCY_IN_PROGRESS`}),`. Poll `,_jsx(_components.code,{children:`details.transactionId`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`After the run finishes: `,_jsx(_components.code,{children:`200`}),` with `,_jsx(_components.code,{children:`replay: true`}),` and the current `,_jsx(_components.code,{children:`status`}),`. `,_jsx(_components.code,{children:`status`}),` moves from `,_jsx(_components.code,{children:`processing`}),` to `,_jsx(_components.code,{children:`completed`}),` once the background job finishes, usually 30 to 60 seconds after the first call. `,_jsx(_components.code,{children:`transactionId`}),`, `,_jsx(_components.code,{children:`dryRun`}),`, `,_jsx(_components.code,{children:`vendors`}),` and `,_jsx(_components.code,{children:`totalPayout`}),` match the first response. Nothing is paid twice.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Same key and a different body: `,_jsx(_components.code,{children:`422 IDEMPOTENCY_KEY_REUSED`}),`. Use a new key.`]}),`\n`,_jsxs(_components.p,{children:[`Read `,_jsx(_components.code,{children:`status`}),` from the response you get. Retry code must accept either `,_jsx(_components.code,{children:`202`}),` or `,_jsx(_components.code,{children:`200`}),` and read `,_jsx(_components.code,{children:`status`}),` from the body. For the latest status, call `,_jsx(_components.a,{href:`/api-reference/v2/merchant/endpoint/get-payout-run`,children:`Get a payout`}),` (`,_jsx(_components.code,{children:`GET /payouts/make-payment/{id}`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-and-response`,children:`Request and response`}),`\n`,_jsx(_components.p,{children:`The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.`}),`\n`,_jsxs(_components.p,{children:[`A finished replay is `,_jsx(_components.code,{children:`200`}),`. The body has these fields:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`requestId`})}),_jsx(_components.td,{children:`Request ID; quote it to support.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsxs(_components.td,{children:[`The current status. Usually `,_jsx(_components.code,{children:`completed`}),` by the time this `,_jsx(_components.code,{children:`200`}),` is returned.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`replay`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`true`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transactionId`})}),_jsx(_components.td,{children:`Same as the first response.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`dryRun`})}),_jsx(_components.td,{children:`Same as the first response.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vendors`})}),_jsx(_components.td,{children:`Same as the first response.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`totalPayout`})}),_jsx(_components.td,{children:`Same as the first response.`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,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:`20`,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:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"requestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6adc216010794278e53fed32\"`}),_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:`\"completed\"`}),_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:` \"replay\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:`\"YSR66PQUCL\"`}),_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:` \"dryRun\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_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:` \"vendors\"`}),_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`,_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:`\"6a956f90bffa472b6babe773\"`}),_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:` \"vendorName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Example Vendor\"`}),_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:` \"totalAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.5`}),_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:` \"totalLineItemsCount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_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:` \"issue\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalPayout\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.5`})]}),`\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:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Every error has the shape `,_jsx(_components.code,{children:`{\"success\": false, \"error\": {\"code\", \"message\", \"errorId\", \"details\"}}`}),`. Branch on `,_jsx(_components.code,{children:`error.code`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`}),_jsx(_components.th,{children:`Fix`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION_ERROR`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Idempotency-Key`}),` header missing or not 8–128 characters.`]}),_jsx(_components.td,{children:`Send a unique key, e.g. a UUID.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION_ERROR`})}),_jsxs(_components.td,{children:[`A parameter or body field is missing or invalid. `,_jsx(_components.code,{children:`error.details`}),` names the field.`]}),_jsx(_components.td,{children:`Fix the field and resend.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_FOUND`})}),_jsx(_components.td,{children:`A vendor is not in your store.`}),_jsx(_components.td,{children:`Remove that vendor.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`AUTOMATED_PAYOUTS_ACTIVE`})}),_jsx(_components.td,{children:`Your store pays vendors automatically.`}),_jsxs(_components.td,{children:[`Settings > Payouts > Automated Payouts > `,_jsx(_components.strong,{children:`Disable Automated Payouts`}),`. Nothing was started.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`IDEMPOTENCY_IN_PROGRESS`})}),_jsx(_components.td,{children:`A request with this key is still processing.`}),_jsxs(_components.td,{children:[`Poll `,_jsx(_components.code,{children:`details.transactionId`}),` instead of resending.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PAYOUT_ITEMS_LOCKED`})}),_jsx(_components.td,{children:`Another payout is paying some of these items now.`}),_jsx(_components.td,{children:`Wait for it, then check what is still unpaid.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`IDEMPOTENCY_KEY_REUSED`})}),_jsx(_components.td,{children:`This key was used with a different body.`}),_jsx(_components.td,{children:`Use a new key for a new request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ADJUSTMENTS_NOT_PAYABLE`})}),_jsxs(_components.td,{children:[`Some adjustments are not this vendor’s, not unpaid, or excluded. `,_jsx(_components.code,{children:`details`}),` lists them.`]}),_jsx(_components.td,{children:`Remove those ids, or check them with List pending items.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VENDOR_NOT_READY_FOR_METHOD`})}),_jsxs(_components.td,{children:[`A vendor is not set up for this method. `,_jsx(_components.code,{children:`details.vendorIds`}),` lists them.`]}),_jsx(_components.td,{children:`Pick a method from List payout methods.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAUTHORIZED`})}),_jsx(_components.td,{children:`Token missing, invalid or expired.`}),_jsx(_components.td,{children:`Call POST /authenticate again and resend.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{children:`The token belongs to a vendor key.`}),_jsxs(_components.td,{children:[`Use a merchant API key (`,_jsx(_components.code,{children:`mk_live_…`}),`).`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`previous-step`,children:`Previous step`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`/api-reference/v2/merchant/endpoint/dry-run-payout`,children:`Preview a payout`})}),`\n`,_jsx(Heading,{level:`2`,id:`next-step`,children:`Next step`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`/api-reference/v2/merchant/endpoint/get-payout-run`,children:`Get a payout`})})]})}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":{"openapi":"openapi-merchant.json POST /payouts/make-payment","title":"Create a payout","description":"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a `transactionId` to poll. Send a unique `Idempotency-Key` so a retry does not pay twice.\n\nNot available while Automated Payouts is on: returns 409 `AUTOMATED_PAYOUTS_ACTIVE`.\n\nIdempotency: send an `Idempotency-Key` header. Same key and the same body while the run is still processing: 409 `IDEMPOTENCY_IN_PROGRESS`. Same key and the same body after the run finishes: 200 with `replay: true` and the current `status`. `status` moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same `transactionId`, `dryRun`, `vendors` and `totalPayout` as the first response, and nothing is paid twice. Read `status` from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 `IDEMPOTENCY_KEY_REUSED`.\n\n`method: \"manual\"` only records a payout you settle yourself; no money moves through PuppetVendors. `manualMethod` (`bankTransfer`, `paypal`, `cash`, `other`) is required with it. A manual payout's `payoutMethod` is `other`. Your `comment` is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. `batches[].markAsPaid` has `marked` only.","href":"/api-reference/v2/merchant/endpoint/make-payout-payment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Purpose","slug":"purpose","depth":2,"children":[]},{"title":"When to use","slug":"when-to-use","depth":2,"children":[]},{"title":"Request and response","slug":"request-and-response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Previous step","slug":"previous-step","depth":2,"children":[]},{"title":"Next step","slug":"next-step","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payouts"],"summary":"Create a payout","description":"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a `transactionId` to poll. Send a unique `Idempotency-Key` so a retry does not pay twice.\n\nNot available while Automated Payouts is on: returns 409 `AUTOMATED_PAYOUTS_ACTIVE`.\n\nIdempotency: send an `Idempotency-Key` header. Same key and the same body while the run is still processing: 409 `IDEMPOTENCY_IN_PROGRESS`. Same key and the same body after the run finishes: 200 with `replay: true` and the current `status`. `status` moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same `transactionId`, `dryRun`, `vendors` and `totalPayout` as the first response, and nothing is paid twice. Read `status` from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 `IDEMPOTENCY_KEY_REUSED`.\n\n`method: \"manual\"` only records a payout you settle yourself; no money moves through PuppetVendors. `manualMethod` (`bankTransfer`, `paypal`, `cash`, `other`) is required with it. A manual payout's `payoutMethod` is `other`. Your `comment` is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. `batches[].markAsPaid` has `marked` only.","operationId":"makePayoutPayment","security":["3d420635-6277-4a62-bae3-ac2e1d340fce"],"parameters":["53b82162-530b-4fcf-91f9-1bf684fee797"],"requestBody":"1c3bda9e-ff07-456f-8e67-d585b52a65ac","responses":{"200":"c02b5bfb-ac74-47bc-945c-6cc056dc708f","202":"9dff1fa6-d1d8-43ae-80ac-400db70a8199","400":"0e35e34f-91d9-4cba-8151-1bc3f33c9d2b","401":"93ed3d76-fcf0-4244-bc71-e3c31520de10","403":"fd739135-9cfc-4049-967c-96c01c7d6c83","404":"6a587897-9d01-42fc-b693-194d38a34b64","409":"71c581bd-fd1f-436d-ae8f-e280ee26152d","422":"54a52551-74ba-4533-9e67-a4fe543684fb"},"method":"post","type":"path","servers":["2db9fc60-25d9-439d-a78c-11a94ea1b52b","0ac88649-853d-49c9-b889-36f894ea7b65"],"path":"/payouts/make-payment","baseUrlOptions":["https://production-api.puppetvendors.com","http://localhost:8082"],"title":"Create a payout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"53b82162-530b-4fcf-91f9-1bf684fee797":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"isRequired":true,"description":"Required. A unique string you choose, 8–128 characters (a UUID works). Use one key per payout you intend to make. Same key and the same body while the first request is still processing: 409 `IDEMPOTENCY_IN_PROGRESS`. Same key and the same body after the run finishes: 200 with `replay: true` and the current `status`. `status` moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same `transactionId`, `dryRun`, `vendors` and `totalPayout` as the first response, and nothing is paid twice. Read `status` from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 `IDEMPOTENCY_KEY_REUSED`. A new key is a new payout.","uniqueKey":"","typeLabel":"string"},"description":"Required. A unique string you choose, 8–128 characters (a UUID works). Use one key per payout you intend to make. Same key and the same body while the first request is still processing: 409 `IDEMPOTENCY_IN_PROGRESS`. Same key and the same body after the run finishes: 200 with `replay: true` and the current `status`. `status` moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same `transactionId`, `dryRun`, `vendors` and `totalPayout` as the first response, and nothing is paid twice. Read `status` from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 `IDEMPOTENCY_KEY_REUSED`. A new key is a new payout.","example":"3f1c2b9e-6a1d-4c55-9d0e-2b7f1e8a4c10"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vendors","method"],"properties":{"vendors":{"type":"array","minItems":1,"maxItems":50,"description":"The vendors to pay, one group each, paid as one batch per vendor. A vendorId may appear only once, and a line item or adjustment id under only one vendor (ids compare case-insensitively). Every vendor must belong to this shop and be ready for the method, or the whole request is refused and nothing is paid.","items":{"type":"object","required":["vendorId"],"properties":{"vendorId":{"type":"string","description":"The vendor being paid (24-char hex ObjectId), must belong to this shop","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"vendors.items.[INDEX].vendorId","typeLabel":"string"},"lineItemIds":{"type":"array","default":[],"items":{"type":"string","uniqueKey":"vendors.items.[INDEX].lineItemIds.items.[INDEX]","typeLabel":"string"},"description":"This vendor's line items to pay (24-char hex ObjectIds; type lineItem in GET /payouts/pending/items/{vendorId}). Send at least one line item or one adjustment per vendor. A line item of another vendor is refused with ITEM_VENDOR_MISMATCH.","example":["507f1f77bcf86cd799439099"],"uniqueKey":"vendors.items.[INDEX].lineItemIds","typeLabel":"string[]"},"adjustmentIds":{"type":"array","default":[],"items":{"type":"string","uniqueKey":"vendors.items.[INDEX].adjustmentIds.items.[INDEX]","typeLabel":"string"},"description":"This vendor's adjustments to pay in the same batch (24-char hex ObjectIds; type customItem in GET /payouts/pending/items/{vendorId}). Each must be this vendor's, unpaid and not excluded from payouts, or the request is refused with ADJUSTMENTS_NOT_PAYABLE. May be sent without lineItemIds for an adjustments-only payout.","example":["507f1f77bcf86cd799439088"],"uniqueKey":"vendors.items.[INDEX].adjustmentIds","typeLabel":"string[]"}},"uniqueKey":"vendors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"vendors","typeLabel":"object[]"},"method":{"type":"string","enum":["stripe","paypal","globalPayouts","manual"],"description":"READ-side method name, one for every vendor of the run; mapped to legacy resolver keys at the bridge. manual records a payment made outside the app and needs manualMethod","isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"manualMethod":{"type":"string","enum":["bankTransfer","paypal","cash","other"],"description":"How a manual payout was made, the same options as the merchant portal. Required when method is manual, refused with any other method. Shown in the vendor email. A manual payout's `payoutMethod` is `other`.","example":"bankTransfer","uniqueKey":"manualMethod","typeLabel":"enum\u003cstring>"},"notifyVendor":{"type":"boolean","default":true,"description":"Whether the run emails the vendor","uniqueKey":"notifyVendor","typeLabel":"boolean"},"payoutDate":{"oneOf":[{"type":"string","description":"Recorded as the payout date. Either an RFC 3339 date-time or a calendar date without a time (YYYY-MM-DD), recorded as that day in the merchant portal's MM/DD/YYYY. When omitted, defaults to today in the shop's timezone (as MM/DD/YYYY), as the merchant portal pre-fills it","format":"date-time","example":"2026-03-02","uniqueKey":"payoutDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"Recorded as the payout date. Either an RFC 3339 date-time or a calendar date without a time (YYYY-MM-DD), recorded as that day in the merchant portal's MM/DD/YYYY. When omitted, defaults to today in the shop's timezone (as MM/DD/YYYY), as the merchant portal pre-fills it","format":"date","example":"2026-03-02","uniqueKey":"payoutDate.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"payoutDate","typeLabel":"string\u003cdate-time> | string\u003cdate>"},"comment":{"type":"string","maxLength":2000,"description":"Free-text note recorded with the run","uniqueKey":"comment","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"vendors":[{"vendorId":"507f1f77bcf86cd799439012","lineItemIds":["507f1f77bcf86cd799439099","507f1f77bcf86cd79943909a"],"adjustmentIds":["507f1f77bcf86cd799439088"]},{"vendorId":"507f1f77bcf86cd799439013","lineItemIds":["507f1f77bcf86cd7994390b1"]}],"method":"stripe","notifyVendor":true,"payoutDate":"2026-03-02","comment":"March payouts"},"examples":{"Example":{"title":"Example","value":{"vendors":[{"vendorId":"507f1f77bcf86cd799439012","lineItemIds":["507f1f77bcf86cd799439099","507f1f77bcf86cd79943909a"],"adjustmentIds":["507f1f77bcf86cd799439088"]},{"vendorId":"507f1f77bcf86cd799439013","lineItemIds":["507f1f77bcf86cd7994390b1"]}],"method":"stripe","notifyVendor":true,"payoutDate":"2026-03-02","comment":"March payouts"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c02b5bfb-ac74-47bc-945c-6cc056dc708f":{"description":"Same Idempotency-Key and the same body, after the run has finished. `replay` is true. `status` is the current status. It moves from `processing` to `completed` once the background job finishes, usually 30 to 60 seconds after the first call. `transactionId`, `dryRun`, `vendors` and `totalPayout` match the first response. Nothing is paid twice. Read `status` here, or call GET /payouts/make-payment/{transactionId} for the latest status.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID; quote it to support.","uniqueKey":"data.requestId","typeLabel":"string"},"status":{"type":"string","enum":["processing","completed","failed"],"description":"The payout's current status.","example":"completed","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"replay":{"type":"boolean","enum":[true],"description":"True on this replay.","uniqueKey":"data.replay","typeLabel":"enum\u003cboolean>"},"transactionId":{"oneOf":[{"type":"string","description":"Same as the first response. The poll key for GET /payouts/make-payment/{transactionId}.","uniqueKey":"data.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Same as the first response. The poll key for GET /payouts/make-payment/{transactionId}.","uniqueKey":"data.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.transactionId","typeLabel":"string | null"},"dryRun":{"type":"boolean","enum":[false],"description":"Same as the first response.","uniqueKey":"data.dryRun","typeLabel":"enum\u003cboolean>"},"vendors":{"type":"array","description":"Same as the first response.","items":{"type":"object","properties":{"vendorId":{"type":"string","uniqueKey":"data.vendors.items.[INDEX].vendorId","typeLabel":"string"},"vendorName":{"type":"string","uniqueKey":"data.vendors.items.[INDEX].vendorName","typeLabel":"string"},"totalAmount":{"type":"number","uniqueKey":"data.vendors.items.[INDEX].totalAmount","typeLabel":"number"},"totalLineItemsCount":{"type":"integer","uniqueKey":"data.vendors.items.[INDEX].totalLineItemsCount","typeLabel":"integer"},"issue":{"oneOf":[{"type":"string","uniqueKey":"data.vendors.items.[INDEX].issue.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.vendors.items.[INDEX].issue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vendors.items.[INDEX].issue","typeLabel":"string | null"}},"uniqueKey":"data.vendors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.vendors","typeLabel":"object[]"},"totalPayout":{"oneOf":[{"type":"number","description":"Same as the first response.","uniqueKey":"data.totalPayout.oneOf.0","typeLabel":"number"},{"type":"null","description":"Same as the first response.","uniqueKey":"data.totalPayout.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.totalPayout","typeLabel":"number | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"requestId":"6adc216010794278e53fed32","status":"completed","replay":true,"transactionId":"YSR66PQUCL","dryRun":false,"vendors":[{"vendorId":"6a956f90bffa472b6babe773","vendorName":"Example Vendor","totalAmount":0.5,"totalLineItemsCount":1,"issue":null}],"totalPayout":0.5}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"requestId":"6adc216010794278e53fed32","status":"completed","replay":true,"transactionId":"YSR66PQUCL","dryRun":false,"vendors":[{"vendorId":"6a956f90bffa472b6babe773","vendorName":"Example Vendor","totalAmount":0.5,"totalLineItemsCount":1,"issue":null}],"totalPayout":0.5}}}},"exampleType":"examples"}},"exampleType":"examples"},"9dff1fa6-d1d8-43ae-80ac-400db70a8199":{"description":"Run accepted; executing asynchronously. `status` is `processing`. Poll GET /payouts/make-payment/{transactionId} for the latest status. A replay after the run finishes is 200, with `replay: true` and the current `status`.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID; quote it to support.","uniqueKey":"data.requestId","typeLabel":"string"},"transactionId":{"oneOf":[{"type":"string","description":"Pre-generated; the poll key for GET /payouts/make-payment/{transactionId}","uniqueKey":"data.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pre-generated; the poll key for GET /payouts/make-payment/{transactionId}","uniqueKey":"data.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.transactionId","typeLabel":"string | null"},"status":{"type":"string","example":"processing","uniqueKey":"data.status","typeLabel":"string"},"dryRun":{"type":"boolean","enum":[false],"uniqueKey":"data.dryRun","typeLabel":"enum\u003cboolean>"},"vendors":{"type":"array","description":"Accept-time totals, same row shape as the dry-run response","items":{"type":"object","properties":{"vendorId":{"type":"string","uniqueKey":"data.vendors.items.[INDEX].vendorId","typeLabel":"string"},"vendorName":{"type":"string","uniqueKey":"data.vendors.items.[INDEX].vendorName","typeLabel":"string"},"totalAmount":{"type":"number","uniqueKey":"data.vendors.items.[INDEX].totalAmount","typeLabel":"number"},"totalLineItemsCount":{"type":"integer","uniqueKey":"data.vendors.items.[INDEX].totalLineItemsCount","typeLabel":"integer"},"issue":{"oneOf":[{"type":"string","uniqueKey":"data.vendors.items.[INDEX].issue.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.vendors.items.[INDEX].issue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vendors.items.[INDEX].issue","typeLabel":"string | null"}},"uniqueKey":"data.vendors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.vendors","typeLabel":"object[]"},"totalPayout":{"oneOf":[{"type":"number","uniqueKey":"data.totalPayout.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.totalPayout.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.totalPayout","typeLabel":"number | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"requestId":"6adc216010794278e53fed32","transactionId":"YSR66PQUCL","status":"processing","dryRun":false,"vendors":[{"vendorId":"6a956f90bffa472b6babe773","vendorName":"Example Vendor","totalAmount":0.5,"totalLineItemsCount":1,"issue":null}],"totalPayout":0.5}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"requestId":"6adc216010794278e53fed32","transactionId":"YSR66PQUCL","status":"processing","dryRun":false,"vendors":[{"vendorId":"6a956f90bffa472b6babe773","vendorName":"Example Vendor","totalAmount":0.5,"totalLineItemsCount":1,"issue":null}],"totalPayout":0.5}}}},"exampleType":"examples"}},"exampleType":"examples"},"0e35e34f-91d9-4cba-8151-1bc3f33c9d2b":{"description":"Missing/short Idempotency-Key, or an invalid body (no vendors or more than 50, a vendor with no line items or adjustments selected, the same vendorId twice, a line item or adjustment id under two vendors, non-hex ids, the old top-level vendorId / lineItemIds / adjustmentIds sent instead of vendors[], customItemIds sent instead of adjustmentIds, unknown method, manual without manualMethod or manualMethod with another method, payoutDate neither a YYYY-MM-DD date nor an RFC 3339 date-time)","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Resource not found","code":"NOT_FOUND","errorId":"err_1783365360839_j281w7b","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"93ed3d76-fcf0-4244-bc71-e3c31520de10":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Resource not found","code":"NOT_FOUND","errorId":"err_1783365360839_j281w7b","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"fd739135-9cfc-4049-967c-96c01c7d6c83":{"description":"Forbidden. The token belongs to a vendor API key. Payouts endpoints need a merchant API key (`mk_live_…`).","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Resource not found","code":"NOT_FOUND","errorId":"err_1783365360839_j281w7b","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"6a587897-9d01-42fc-b693-194d38a34b64":{"description":"Some vendors are not in this shop (NOT_FOUND, details.vendorIds lists every one; another shop's vendorId reads the same as an unknown one). Nothing is paid","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Resource not found","code":"NOT_FOUND","errorId":"err_1783365360839_j281w7b","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"71c581bd-fd1f-436d-ae8f-e280ee26152d":{"description":"`AUTOMATED_PAYOUTS_ACTIVE`: your store pays vendors automatically, so you can't also pay through the API. Fix: go to Settings > Payouts > Automated Payouts and select **Disable Automated Payouts**. Nothing was started and the Idempotency-Key is not used up. Other 409 codes: A run with this Idempotency-Key is already in flight (IDEMPOTENCY_IN_PROGRESS; details.transactionId is the poll key, poll it instead of retrying), or another payout run is paying some of these line items right now (PAYOUT_ITEMS_LOCKED, details.conflicts lists them; nothing was started and the key is not used up; wait for that run, then check what is still unpaid)","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"AUTOMATED_PAYOUTS_ACTIVE","message":"This store pays vendors automatically, so payouts cannot also be made through the API. To pay through the API, go to Settings > Payouts > Automated Payouts and select \"Disable Automated Payouts\".","errorId":"err_1792776147401_4vdjdqw"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"AUTOMATED_PAYOUTS_ACTIVE","message":"This store pays vendors automatically, so payouts cannot also be made through the API. To pay through the API, go to Settings > Payouts > Automated Payouts and select \"Disable Automated Payouts\".","errorId":"err_1792776147401_4vdjdqw"}}}},"exampleType":"examples"}},"exampleType":"examples"},"54a52551-74ba-4533-9e67-a4fe543684fb":{"description":"The Idempotency-Key was already used for a different request (IDEMPOTENCY_KEY_REUSED, details.requestId is the run it was used for; nothing is started), or the selection cannot be paid and the whole request is refused, no vendor is paid (PAYOUT_METHOD_UNAVAILABLE, VENDOR_NOT_READY_FOR_METHOD (details.vendorIds lists every vendor not ready for the method), VENDOR_HIDDEN (details.vendorIds lists every vendor the merchant has hidden; hidden vendors are not payable), or an engine rejection whose code and details pass through verbatim, such as LINE_ITEMS_NOT_FOUND, ITEM_VENDOR_MISMATCH (a line item listed under a vendor it does not belong to; details.otherVendor and details.noVendor list the line item ids, or, when the dry run resolved a vendor that was not requested, details.requested and details.resolved list the vendorIds), ADJUSTMENTS_NOT_PAYABLE (details lists the refused ids under notFound, otherVendor, notUnpaid and excludedFromPayout), PAYOUT_NO_ITEMS, or PAYOUT_VALIDATION_FAILED (details.issues lists each vendor's issue as { vendorId, issue }, or details.vendorIds names vendors with nothing payable))","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Indicates the request failed","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message","example":"Resource not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.\u003ccode>). Server errors always report INTERNAL_SERVER_ERROR.","example":"NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"errorId":{"type":"string","description":"Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error.","example":"err_1783365360839_j281w7b","uniqueKey":"error.errorId","typeLabel":"string"},"details":{"type":"object","description":"Additional client-error context (e.g. field-level validation errors). Never populated for server errors.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Resource not found","code":"NOT_FOUND","errorId":"err_1783365360839_j281w7b","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3d420635-6277-4a62-bae3-ac2e1d340fce":{"bearerAuth":{"type":"apiKey","in":"header","name":"x-access-token","description":"JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate. Send the token value directly, with no \"Bearer\" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"2db9fc60-25d9-439d-a78c-11a94ea1b52b":{"url":"https://production-api.puppetvendors.com","description":"Production"},"0ac88649-853d-49c9-b889-36f894ea7b65":{"url":"http://localhost:8082","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-access-token","description":"JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate. Send the token value directly, with no \"Bearer\" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"x-access-token","type":"string","description":"JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate. Send the token value directly, with no \"Bearer\" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"bearerAuth","name":"x-access-token"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi-merchant.json"},"subdomain":"puppetvendors-26","siteName":"PuppetVendors API","title":"Create a payout - PuppetVendors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T15:04:48.217Z","originalFileLocation":"api-reference/v2/merchant/endpoint/make-payout-payment.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=\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice. Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE. Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. method: \u0026quot;manual\u0026quot; only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout\u0026#x27;s payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. batches[].markAsPaid has marked only.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PuppetVendors API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a payout - PuppetVendors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice. Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE. Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. method: \u0026quot;manual\u0026quot; only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout\u0026#x27;s payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. batches[].markAsPaid has marked only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PuppetVendors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://puppetvendors-26.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+a+payout\u0026amp;description=Pay+a+selection+of+line+items+and+adjustments+for+one+or+more+vendors+%28up+to+50%29%2C+one+batch+per+vendor+using+a+single+payout+method.+Runs+asynchronously%3A+return\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=5150213753d55897cce0ac16dd01f5e8e426b6ed971c538c36d81305ba7df321\">\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 a payout - PuppetVendors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice. Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE. Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. method: \u0026quot;manual\u0026quot; only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout\u0026#x27;s payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. batches[].markAsPaid has marked only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://puppetvendors-26.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+a+payout\u0026amp;description=Pay+a+selection+of+line+items+and+adjustments+for+one+or+more+vendors+%28up+to+50%29%2C+one+batch+per+vendor+using+a+single+payout+method.+Runs+asynchronously%3A+return\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=5150213753d55897cce0ac16dd01f5e8e426b6ed971c538c36d81305ba7df321\">\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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PuppetVendors API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/merchant/endpoint/make-payout-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.puppetvendors.com/#organization\",\"name\":\"PuppetVendors API\",\"url\":\"https://dev.puppetvendors.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/light.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=334773803bc34a3293e61a5efa488140\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.puppetvendors.com#website\",\"name\":\"PuppetVendors API\",\"url\":\"https://dev.puppetvendors.com\",\"publisher\":{\"@id\":\"https://dev.puppetvendors.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment#webpage\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment\",\"name\":\"Create a payout\",\"description\":\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice. Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE. Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. method: \\\"manual\\\" only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout's payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. batches[].markAsPaid has marked only.\",\"dateModified\":\"2026-10-24T15:04:48.217Z\",\"isPartOf\":{\"@id\":\"https://dev.puppetvendors.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payouts\",\"item\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-payout-methods\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a payout\",\"item\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment#apireference\",\"headline\":\"Create a payout\",\"name\":\"Create a payout\",\"description\":\"Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a transactionId to poll. Send a unique Idempotency-Key so a retry does not pay twice. Not available while Automated Payouts is on: returns 409 AUTOMATED_PAYOUTS_ACTIVE. Idempotency: send an Idempotency-Key header. Same key and the same body while the run is still processing: 409 IDEMPOTENCY_IN_PROGRESS. Same key and the same body after the run finishes: 200 with replay: true and the current status. status moves from processing to completed once the background job finishes, usually 30 to 60 seconds after the first call. The replay has the same transactionId, dryRun, vendors and totalPayout as the first response, and nothing is paid twice. Read status from the response you get. For the latest status, call GET /payouts/make-payment/{transactionId}. Same key and a different body: 422 IDEMPOTENCY_KEY_REUSED. method: \\\"manual\\\" only records a payout you settle yourself; no money moves through PuppetVendors. manualMethod (bankTransfer, paypal, cash, other) is required with it. A manual payout's payoutMethod is other. Your comment is returned on the payout. Read both from GET /payouts/make-payment/{transactionId} and GET /payouts/transactions. batches[].markAsPaid has marked only.\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment\",\"mainEntityOfPage\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment#webpage\"},\"dateModified\":\"2026-10-24T15:04:48.217Z\",\"publisher\":{\"@id\":\"https://dev.puppetvendors.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.puppetvendors.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PuppetVendors API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PuppetVendors API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/merchant/endpoint/make-payout-payment.md","siteName":"PuppetVendors API","nav":{"global":{"anchors":[{"anchor":"PuppetVendors","icon":"globe","href":"https://puppetvendors.com"}]},"tabs":[{"tab":"API V1","pages":[{"title":"API V1","href":""}]},{"tab":"Vendors - V2","pages":[{"title":"Vendors - V2","href":"/api-reference/v2/vendor/introduction"}]},{"tab":"Merchants - V2","groups":[{"group":"Getting Started","pages":[{"title":"V2 Merchant API Introduction","href":"/api-reference/v2/merchant/introduction"},{"title":"Merchant Authentication","href":"/api-reference/v2/merchant/authentication"}]},{"group":"Authentication","pages":[{"openapi":"openapi-merchant.json POST /authenticate","title":"Authenticate and get API token","href":"/api-reference/v2/merchant/endpoint/authenticate"},{"openapi":"openapi-merchant.json POST /verify","title":"Verify an API key reaches the service","href":"/api-reference/v2/merchant/endpoint/verify"},{"openapi":"openapi-merchant.json POST /refresh-token","title":"Refresh API token","href":"/api-reference/v2/merchant/endpoint/refresh-token"}]},{"group":"Guides","pages":[{"title":"Pay vendors with the API","href":"/api-reference/v2/merchant/guides/pay-vendors"}]},{"group":"Vendors","pages":[{"openapi":"openapi-merchant.json GET /vendors","title":"List vendors with pagination","href":"/api-reference/v2/merchant/endpoint/list-vendors"},{"openapi":"openapi-merchant.json POST /vendors","title":"Create a new vendor","href":"/api-reference/v2/merchant/endpoint/create-vendor"},{"openapi":"openapi-merchant.json GET /vendors/{vendorId}","title":"Get a single vendor","href":"/api-reference/v2/merchant/endpoint/get-vendor"},{"openapi":"openapi-merchant.json PUT /vendors/{vendorId}","title":"Update a vendor","href":"/api-reference/v2/merchant/endpoint/update-vendor"},{"openapi":"openapi-merchant.json DELETE /vendors/{vendorId}","title":"Delete a vendor (soft delete)","href":"/api-reference/v2/merchant/endpoint/delete-vendor"},{"openapi":"openapi-merchant.json GET /vendors/{vendorId}/profile","title":"Get vendor profile","href":"/api-reference/v2/merchant/endpoint/get-vendor-profile"},{"openapi":"openapi-merchant.json PUT /vendors/{vendorId}/profile","title":"Update vendor profile","href":"/api-reference/v2/merchant/endpoint/update-vendor-profile"},{"openapi":"openapi-merchant.json GET /vendors/{vendorId}/address","title":"Get vendor address","href":"/api-reference/v2/merchant/endpoint/get-vendor-address"},{"openapi":"openapi-merchant.json PUT /vendors/{vendorId}/address","title":"Update vendor address","href":"/api-reference/v2/merchant/endpoint/update-vendor-address"}]},{"group":"Users","pages":[{"openapi":"openapi-merchant.json GET /users","title":"List users (vendor-scoped)","href":"/api-reference/v2/merchant/endpoint/list-users"},{"openapi":"openapi-merchant.json POST /users","title":"Create user (vendor-scoped)","href":"/api-reference/v2/merchant/endpoint/create-user"},{"openapi":"openapi-merchant.json GET /users/{userId}","title":"Get a single user","href":"/api-reference/v2/merchant/endpoint/get-user"},{"openapi":"openapi-merchant.json PUT /users/{userId}","title":"Update user (vendor-scoped)","href":"/api-reference/v2/merchant/endpoint/update-user"},{"openapi":"openapi-merchant.json DELETE /users/{userId}","title":"Delete user (vendor-scoped)","href":"/api-reference/v2/merchant/endpoint/delete-user"}]},{"group":"Payouts","pages":[{"openapi":"openapi-merchant.json GET /payouts/methods","title":"List payout methods","href":"/api-reference/v2/merchant/endpoint/list-payout-methods"},{"openapi":"openapi-merchant.json GET /payouts/pending","title":"List pending payouts","href":"/api-reference/v2/merchant/endpoint/list-pending-payouts"},{"openapi":"openapi-merchant.json GET /payouts/pending/items/{vendorId}","title":"List a vendor's pending items","href":"/api-reference/v2/merchant/endpoint/list-pending-payout-items"},{"openapi":"openapi-merchant.json POST /payouts/make-payment/dry-run","title":"Preview a payout","description":"Preview what a payout would pay, with totals and any validation issues, without creating anything.\n\nNot available while Automated Payouts is on: returns 409 `AUTOMATED_PAYOUTS_ACTIVE`. The preview runs the same store checks as Create a payout, so a preview that succeeds will not be refused for a store-level reason.","href":"/api-reference/v2/merchant/endpoint/dry-run-payout"},{"openapi":"openapi-merchant.json POST /payouts/make-payment","title":"Create a payout","href":"/api-reference/v2/merchant/endpoint/make-payout-payment"},{"openapi":"openapi-merchant.json GET /payouts/make-payment/{transactionId}","title":"Get a payout","description":"Get the current status of a payout and its per-vendor batches by `transactionId`.\n\nPoll every 2–5 seconds until `status` is `completed` or `failed`. Manual payouts usually finish within a few seconds. The payout includes `payoutMethod` (for example `other`) and `comment`. `batches[].markAsPaid` has `marked` only. Batch `status` is one of `pending`, `paid`, `failed`, `cancelled`.","href":"/api-reference/v2/merchant/endpoint/get-payout-run"},{"openapi":"openapi-merchant.json POST /payouts/batches/{batchId}/retry","title":"Retry a payout batch","href":"/api-reference/v2/merchant/endpoint/retry-payout-batch"},{"openapi":"openapi-merchant.json POST /payouts/batches/{batchId}/mark-paid","title":"Mark a payout batch as paid","href":"/api-reference/v2/merchant/endpoint/mark-payout-batch-paid"},{"openapi":"openapi-merchant.json GET /payouts/transactions","title":"List payout transactions","href":"/api-reference/v2/merchant/endpoint/list-payout-transactions"}]},{"group":"Payout Adjustments","pages":[{"openapi":"openapi-merchant.json GET /payouts/adjustments","title":"List payout adjustments","href":"/api-reference/v2/merchant/endpoint/list-payout-adjustments"},{"openapi":"openapi-merchant.json POST /payouts/adjustments","title":"Create a payout adjustment","href":"/api-reference/v2/merchant/endpoint/create-payout-adjustment"},{"openapi":"openapi-merchant.json GET /payouts/adjustments/{id}","title":"Get a payout adjustment","href":"/api-reference/v2/merchant/endpoint/get-payout-adjustment"},{"openapi":"openapi-merchant.json PATCH /payouts/adjustments/{id}","title":"Update a payout adjustment","href":"/api-reference/v2/merchant/endpoint/update-payout-adjustment"},{"openapi":"openapi-merchant.json DELETE /payouts/adjustments/{id}","title":"Delete a payout adjustment","href":"/api-reference/v2/merchant/endpoint/delete-payout-adjustment"}]},{"group":"Products","pages":[{"openapi":"openapi-merchant.json GET /products","title":"List products","href":"/api-reference/v2/merchant/endpoint/list-products"},{"openapi":"openapi-merchant.json GET /products/{productId}","title":"Get a product","href":"/api-reference/v2/merchant/endpoint/get-product"},{"openapi":"openapi-merchant.json POST /products","title":"Create a product","href":"/api-reference/v2/merchant/endpoint/create-product"},{"openapi":"openapi-merchant.json PUT /products/{productId}","title":"Update a product","href":"/api-reference/v2/merchant/endpoint/update-product"},{"openapi":"openapi-merchant.json DELETE /products/{productId}","title":"Delete a product","href":"/api-reference/v2/merchant/endpoint/delete-product"},{"openapi":"openapi-merchant.json GET /products/counts","title":"Get product counts","href":"/api-reference/v2/merchant/endpoint/get-product-counts"},{"openapi":"openapi-merchant.json PATCH /products/{productId}/status","title":"Update product status","href":"/api-reference/v2/merchant/endpoint/update-product-status"},{"openapi":"openapi-merchant.json POST /products/{productId}/duplicate","title":"Duplicate a product","href":"/api-reference/v2/merchant/endpoint/duplicate-product"},{"openapi":"openapi-merchant.json PATCH /products/{productId}/inventory","title":"Update product inventory","href":"/api-reference/v2/merchant/endpoint/update-product-inventory"},{"openapi":"openapi-merchant.json POST /products/media","title":"Upload product media","href":"/api-reference/v2/merchant/endpoint/upload-product-media"},{"openapi":"openapi-merchant.json POST /products/ai/description","title":"Generate an AI product description","href":"/api-reference/v2/merchant/endpoint/ai-product-description"},{"openapi":"openapi-merchant.json POST /products/barcode","title":"Generate a barcode","href":"/api-reference/v2/merchant/endpoint/generate-barcode"},{"openapi":"openapi-merchant.json POST /products/approve","title":"Approve products","href":"/api-reference/v2/merchant/endpoint/approve-products"},{"openapi":"openapi-merchant.json POST /products/reject","title":"Reject products","href":"/api-reference/v2/merchant/endpoint/reject-products"}]}]}]},"basePath":"","title":"Create a payout - PuppetVendors API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}