{
"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"
}
}
Preview what a payout would pay, with totals and any validation issues, without creating anything.
Not 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.
{
"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"
}
}
Always, right before Create a payout. It runs the same checks, so a preview that succeeds will not fail for a store-level reason. Part of the Pay vendors with the API flow.
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.
Errors
Every error has the shape {"success": false, "error": {"code", "message", "errorId", "details"}}. Branch on error.code.
Status
Code
Meaning
Fix
400
VALIDATION_ERROR
A parameter or body field is missing or invalid. error.details names the field.
Fix the field and resend.
404
NOT_FOUND
A vendor is not in your store. details.vendorIds lists them.
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.
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
The computation a make-payment run would perform, without writing anything
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/dry-run-payout","slug":"/api-reference/v2/merchant/endpoint/dry-run-payout","pageMetadata":{"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"},"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: [_jsx(_components.p, {\n children: \"Preview what a payout would pay, with totals and any validation issues, without creating anything.\"\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 }), \". 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.\"]\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`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;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:`Preview a payout without paying anything.`}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use`,children:`When to use`}),`\n`,_jsxs(_components.p,{children:[`Always, right before Create a payout. It runs the same checks, so a preview that succeeds will not fail for a store-level reason. Part of the `,_jsx(_components.a,{href:`/api-reference/v2/merchant/guides/pay-vendors`,children:`Pay vendors with the API`}),` flow.`]}),`\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`,_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:[`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`})}),_jsxs(_components.td,{children:[`A vendor is not in your store. `,_jsx(_components.code,{children:`details.vendorIds`}),` lists them.`]}),_jsx(_components.td,{children:`Remove those vendors.`})]}),_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:`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/list-pending-payout-items`,children:`List a vendor’s pending items`})}),`\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/make-payout-payment`,children:`Create 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/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"}}},"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":"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.","operationId":"dryRunPayoutMakePayment","security":["0c3908a5-33fb-4a92-9d71-cce12ed12b41"],"requestBody":"15229499-f52f-49a8-9696-eda6c60c7038","responses":{"200":"fc635674-8a15-42d2-8be0-2b6ae6417703","400":"0e1a3b84-9640-47d0-acf3-d91ed5cf9517","401":"8277e6b0-d812-4adf-92ed-0153a62ff28e","403":"51f8665b-3f5a-48f7-b47d-8ef29e748117","404":"c47bd3e1-8669-41ce-9b82-bbb2d7811bfe","409":"b47e5742-a857-496f-ba32-fb8321fe9231","422":"a6bead6d-b34c-4f6a-8c4c-316486fa8832"},"method":"post","type":"path","servers":["2db9fc60-25d9-439d-a78c-11a94ea1b52b","0ac88649-853d-49c9-b889-36f894ea7b65"],"path":"/payouts/make-payment/dry-run","baseUrlOptions":["https://production-api.puppetvendors.com","http://localhost:8082"],"title":"Preview a payout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"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":{"fc635674-8a15-42d2-8be0-2b6ae6417703":{"description":"The computation a make-payment run would perform, without writing anything","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"dryRun":{"type":"boolean","enum":[true],"uniqueKey":"data.dryRun","typeLabel":"enum\u003cboolean>"},"vendors":{"type":"array","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","description":"The guard string the run would reject this vendor on, null when clean","uniqueKey":"data.vendors.items.[INDEX].issue.oneOf.0","typeLabel":"string"},{"type":"null","description":"The guard string the run would reject this vendor on, null when clean","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":{"type":"number","uniqueKey":"data.totalPayout","typeLabel":"number"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"dryRun":true,"vendors":[{"vendorId":"\u003cstring>","vendorName":"\u003cstring>","totalAmount":123,"totalLineItemsCount":123,"issue":"\u003cstring>"}],"totalPayout":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"0e1a3b84-9640-47d0-acf3-d91ed5cf9517":{"description":"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"},"8277e6b0-d812-4adf-92ed-0153a62ff28e":{"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"},"51f8665b-3f5a-48f7-b47d-8ef29e748117":{"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"},"c47bd3e1-8669-41ce-9b82-bbb2d7811bfe":{"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)","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"},"b47e5742-a857-496f-ba32-fb8321fe9231":{"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.","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"},"a6bead6d-b34c-4f6a-8c4c-316486fa8832":{"description":"The selection cannot be paid, and the whole request is refused (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":{"0c3908a5-33fb-4a92-9d71-cce12ed12b41":{"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":"Preview a payout - PuppetVendors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T15:04:48.781Z","originalFileLocation":"api-reference/v2/merchant/endpoint/dry-run-payout.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Preview what a payout would pay, with totals and any validation issues, without creating anything. Not 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.\">\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=\"Preview a payout - PuppetVendors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Preview what a payout would pay, with totals and any validation issues, without creating anything. Not 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.\">\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/dry-run-payout\">\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=Preview+a+payout\u0026amp;description=Preview+what+a+payout+would+pay%2C+with+totals+and+any+validation+issues%2C+without+creating+anything.%0A%0ANot+available+while+Automated+Payouts+is+on%3A+returns+409+%60AU\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=3792c28a29c0e01971576eed301adca8970297a539993ca5898187628e0a4373\">\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=\"Preview a payout - PuppetVendors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Preview what a payout would pay, with totals and any validation issues, without creating anything. Not 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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://puppetvendors-26.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Preview+a+payout\u0026amp;description=Preview+what+a+payout+would+pay%2C+with+totals+and+any+validation+issues%2C+without+creating+anything.%0A%0ANot+available+while+Automated+Payouts+is+on%3A+returns+409+%60AU\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=3792c28a29c0e01971576eed301adca8970297a539993ca5898187628e0a4373\">\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/dry-run-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/merchant/endpoint/dry-run-payout.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/dry-run-payout#webpage\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout\",\"name\":\"Preview a payout\",\"description\":\"Preview what a payout would pay, with totals and any validation issues, without creating anything. Not 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.\",\"dateModified\":\"2026-10-24T15:04:48.781Z\",\"isPartOf\":{\"@id\":\"https://dev.puppetvendors.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout#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\":\"Preview a payout\",\"item\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout#apireference\",\"headline\":\"Preview a payout\",\"name\":\"Preview a payout\",\"description\":\"Preview what a payout would pay, with totals and any validation issues, without creating anything. Not 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.\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout\",\"mainEntityOfPage\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout#webpage\"},\"dateModified\":\"2026-10-24T15:04:48.781Z\",\"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/dry-run-payout.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","description":"List the unpaid line items and adjustments that make up one vendor's pending payout.","href":"/api-reference/v2/merchant/endpoint/list-pending-payout-items"},{"openapi":"openapi-merchant.json POST /payouts/make-payment/dry-run","title":"Preview a payout","href":"/api-reference/v2/merchant/endpoint/dry-run-payout"},{"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"},{"openapi":"openapi-merchant.json GET /payouts/make-payment/{transactionId}","title":"Get a payout","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":"Preview 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"]}