Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to track the start of vendor payout movement.
Delivery Contract
Field
Value
Encoding
JSON: id, type, version, source, created_at, occurred_at, data
Delivery
At least once
Idempotency
Deduplicate on the envelope’s id: it is covered by the signature, and every retry and replay of this event repeats it. The X-Cope-Event-Id header carries the same value but is not signed.
Source
cope.payouts
Category
Payouts
Availability
Planned; not currently emitted.
Payload schema
Pending publication
Payload Contract
This event is part of the intended public webhook surface but is not currently emitted. Its payload schema will be published before the event is enabled for external subscriptions.
Compatibility
Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"COPE","description":"COPE developer documentation: the public API, the Checkout SDK, webhooks, and AI agents.","colors":{"primary":"#101828","light":"#344054","dark":"#F9FAFB"},"api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"href":"https://cope.com","label":"COPE"},{"href":"https://app.cope.com","label":"App"},{"href":"/ai-agents/merchant-assistant","label":"MCP"}]},"footer":{"socials":{}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cope-demo","hasAudioNarration":false,"actualSubdomain":"cope-demo","customDomains":["docs.staging.cope-demo.com"],"gitSource":{"type":"github","owner":"copecart","repo":"cope","deployBranch":"new_architecture","contentDirectory":"apps/cope-docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6b01b8ac3b287a20965722fd","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Public API","count":62},{"language":"default","tag":"Webhooks","count":56},{"language":"default","tag":"Commerce","count":42},{"language":"default","tag":"Event Reference","count":34},{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Subscriptions","count":14},{"language":"default","tag":"Products","count":9},{"language":"default","tag":"Payouts","count":8},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Disputes","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":"webhooks/events/payouts.transfer.initiated","slug":"/webhooks/events/payouts.transfer.initiated","pageMetadata":{"title":"payouts.transfer.initiated","description":"A payout transfer has been initiated.","public":true,"href":"/webhooks/events/payouts.transfer.initiated"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"A payout transfer has been initiated.\"\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={blockquote:`blockquote`,code:`code`,p:`p`,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:`1`,id:`payouts-transfer-initiated`,children:`payouts.transfer.initiated`}),`\n`,_jsxs(_components.blockquote,{children:[`\n`,_jsx(_components.p,{children:`Generated from COPE public event contracts. Do not edit this page by hand.`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Use this event to track the start of vendor payout movement.`}),`\n`,_jsx(Heading,{level:`2`,id:`delivery-contract`,children:`Delivery Contract`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Value`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Encoding`}),_jsxs(_components.td,{children:[`JSON: `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`type`}),`, `,_jsx(_components.code,{children:`version`}),`, `,_jsx(_components.code,{children:`source`}),`, `,_jsx(_components.code,{children:`created_at`}),`, `,_jsx(_components.code,{children:`occurred_at`}),`, `,_jsx(_components.code,{children:`data`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Delivery`}),_jsx(_components.td,{children:`At least once`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Idempotency`}),_jsxs(_components.td,{children:[`Deduplicate on the envelope’s `,_jsx(_components.code,{children:`id`}),`: it is covered by the signature, and every retry and replay of this event repeats it. The `,_jsx(_components.code,{children:`X-Cope-Event-Id`}),` header carries the same value but is not signed.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Source`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`cope.payouts`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Category`}),_jsx(_components.td,{children:`Payouts`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Availability`}),_jsx(_components.td,{children:`Planned; not currently emitted.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Payload schema`}),_jsx(_components.td,{children:`Pending publication`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`payload-contract`,children:`Payload Contract`}),`\n`,_jsx(_components.p,{children:`This event is part of the intended public webhook surface but is not currently emitted. Its payload schema will be published before the event is enabled for external subscriptions.`}),`\n`,_jsx(Heading,{level:`2`,id:`compatibility`,children:`Compatibility`}),`\n`,_jsx(_components.p,{children:`Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.`})]})}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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"payouts.transfer.initiated","description":"A payout transfer has been initiated.","public":true,"href":"/webhooks/events/payouts.transfer.initiated"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"payouts.transfer.initiated","slug":"payouts-transfer-initiated","depth":1,"children":[]},{"title":"Delivery Contract","slug":"delivery-contract","depth":2,"children":[]},{"title":"Payload Contract","slug":"payload-contract","depth":2,"children":[]},{"title":"Compatibility","slug":"compatibility","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cope-demo","siteName":"COPE","title":"payouts.transfer.initiated - COPE","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T22:32:29.933Z","originalFileLocation":"webhooks/events/payouts.transfer.initiated.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=\"A payout transfer has been initiated.\">\u003cmeta data-mint-head name=\"application-name\" content=\"COPE\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cope-demo/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cope-demo/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cope-demo/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cope-demo/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"payouts.transfer.initiated - COPE\">\u003cmeta data-mint-head property=\"og:description\" content=\"A payout transfer has been initiated.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"COPE\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cope-demo.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=payouts.transfer.initiated\u0026amp;description=A+payout+transfer+has+been+initiated.\u0026amp;theme=91de461e0a61f712a6597810\u0026amp;signature=3bfac158ee026571f3fdbc74b1e9295bf5871df7b33e278530510626dad0ee26\">\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=\"payouts.transfer.initiated - COPE\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A payout transfer has been initiated.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cope-demo.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=payouts.transfer.initiated\u0026amp;description=A+payout+transfer+has+been+initiated.\u0026amp;theme=91de461e0a61f712a6597810\u0026amp;signature=3bfac158ee026571f3fdbc74b1e9295bf5871df7b33e278530510626dad0ee26\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/cope-demo/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"COPE\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#101828\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/events/payouts.transfer.initiated.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.staging.cope-demo.com/#organization\",\"name\":\"COPE\",\"url\":\"https://docs.staging.cope-demo.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.staging.cope-demo.com#website\",\"name\":\"COPE\",\"url\":\"https://docs.staging.cope-demo.com\",\"publisher\":{\"@id\":\"https://docs.staging.cope-demo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated#webpage\",\"url\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated\",\"name\":\"payouts.transfer.initiated\",\"description\":\"A payout transfer has been initiated.\",\"dateModified\":\"2026-11-11T22:32:29.933Z\",\"isPartOf\":{\"@id\":\"https://docs.staging.cope-demo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.staging.cope-demo.com/webhooks/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Event Reference\",\"item\":\"https://docs.staging.cope-demo.com/webhooks/events\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"payouts.transfer.initiated\",\"item\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated#article\",\"headline\":\"payouts.transfer.initiated\",\"name\":\"payouts.transfer.initiated\",\"description\":\"A payout transfer has been initiated.\",\"url\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated\",\"mainEntityOfPage\":{\"@id\":\"https://docs.staging.cope-demo.com/webhooks/events/payouts.transfer.initiated#webpage\"},\"dateModified\":\"2026-11-11T22:32:29.933Z\",\"publisher\":{\"@id\":\"https://docs.staging.cope-demo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.staging.cope-demo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"COPE\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"COPE\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/webhooks/events/payouts.transfer.initiated.md","siteName":"COPE","nav":{"global":null,"groups":[{"group":"Start","public":true,"icon":"play","root":{"title":"COPE developer docs","href":"/index"},"pages":[{"title":"Build a vendor integration","href":"/quickstart/build-an-integration"},{"title":"Consume webhooks","href":"/quickstart/consume-webhooks"}]},{"group":"Public API","public":true,"icon":"cart-shopping","root":{"title":"Public API overview","href":"/api-reference/overview"},"pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"API key integrations","href":"/api-reference/api-key-integrations"},{"title":"Errors","href":"/api-reference/errors"},{"group":"Commerce","public":true,"icon":"plug","pages":[{"group":"Balances","pages":[{"title":"List balances","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/balances","href":"/api-reference/balances/list-balances"}]},{"group":"Chargebacks","pages":[{"title":"List chargebacks","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/chargebacks","href":"/api-reference/chargebacks/list-chargebacks"},{"title":"Retrieve a chargeback","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/chargebacks/{id}","href":"/api-reference/chargebacks/retrieve-a-chargeback"}]},{"group":"Checkouts","pages":[{"title":"Create a checkout","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/checkouts","href":"/api-reference/checkouts/create-a-checkout"},{"title":"Retrieve a checkout","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/checkouts/{id}","href":"/api-reference/checkouts/retrieve-a-checkout"}]},{"group":"Currencies","pages":[{"title":"Retrieve sellable currencies","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/currencies","href":"/api-reference/currencies/retrieve-sellable-currencies"}]},{"group":"Disputes","pages":[{"title":"List disputes","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/disputes","href":"/api-reference/disputes/list-disputes"},{"title":"Retrieve a dispute","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/disputes/{id}","href":"/api-reference/disputes/retrieve-a-dispute"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/invoices/{id}","href":"/api-reference/invoices/retrieve-an-invoice"}]},{"group":"Offers","pages":[{"title":"List offers","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/offers","href":"/api-reference/offers/list-offers"},{"title":"Create an offer","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/offers","href":"/api-reference/offers/create-an-offer"},{"title":"Retrieve an offer","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/offers/{id}","href":"/api-reference/offers/retrieve-an-offer"},{"title":"Cancel an offer","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/offers/{id}/cancel","href":"/api-reference/offers/cancel-an-offer"},{"title":"Resend an offer to its buyer","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/offers/{id}/resend","href":"/api-reference/offers/resend-an-offer-to-its-buyer"},{"title":"Send an offer to its buyer","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/offers/{id}/send","href":"/api-reference/offers/send-an-offer-to-its-buyer"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/orders","href":"/api-reference/orders/list-orders"},{"title":"Retrieve an order","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/orders/{id}","href":"/api-reference/orders/retrieve-an-order"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/payments","href":"/api-reference/payments/list-payments"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/payments/{id}","href":"/api-reference/payments/retrieve-a-payment"}]},{"group":"Refunds","pages":[{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/payments/{id}/refunds","href":"/api-reference/refunds/refund-a-payment"},{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/refunds/{id}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Retrieve a payout","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/payouts/{id}","href":"/api-reference/payouts/retrieve-a-payout"},{"title":"List a payout's transactions","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/payouts/{id}/transactions","href":"/api-reference/payouts/list-a-payouts-transactions"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/products","href":"/api-reference/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/products","href":"/api-reference/products/create-a-product"},{"title":"Retrieve a product","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/products/{id}","href":"/api-reference/products/retrieve-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json patch /v1/commerce/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Attach a downloadable file","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/products/{product_id}/attachments","href":"/api-reference/products/attach-a-downloadable-file"},{"title":"Attach a product image","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/products/{product_id}/images","href":"/api-reference/products/attach-a-product-image"},{"title":"Create a media upload session","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/uploads","href":"/api-reference/products/create-a-media-upload-session"}]},{"group":"Subscriptions","pages":[{"title":"List subscriptions changed in a time window","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/subscriptions","href":"/api-reference/subscriptions/list-subscriptions-changed-in-a-time-window"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/subscriptions/{id}","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-a-subscription"},{"title":"List a subscription's price and plan change attempts","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json get /v1/commerce/subscriptions/{id}/changes","href":"/api-reference/subscriptions/list-a-subscriptions-price-and-plan-change-attempts"},{"title":"Pause a subscription's renewals","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-a-subscriptions-renewals"},{"title":"Create a payment recovery link","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/payment-recovery-links","href":"/api-reference/subscriptions/create-a-payment-recovery-link"},{"title":"Move a subscription to another plan","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/plan","href":"/api-reference/subscriptions/move-a-subscription-to-another-plan"},{"title":"Change a subscription's recurring amount","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/price","href":"/api-reference/subscriptions/change-a-subscriptions-recurring-amount"},{"title":"Resume a paused subscription","deprecated":null,"version":null,"openapi":"/api-reference/commerce-v1.openapi.json post /v1/commerce/subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-a-paused-subscription"}]}]},{"group":"Webhooks","public":true,"icon":"webhook","pages":[{"group":"API Reference","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/deliveries","href":"/api-reference/list-webhook-deliveries"},{"title":"Retrieve a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/deliveries/{delivery_id}","href":"/api-reference/retrieve-a-webhook-delivery"},{"title":"Replay a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json post /v1/webhooks/deliveries/{delivery_id}/replay","href":"/api-reference/replay-a-webhook-delivery"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/endpoints","href":"/api-reference/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json post /v1/webhooks/endpoints","href":"/api-reference/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/endpoints/{id}","href":"/api-reference/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json delete /v1/webhooks/endpoints/{id}","href":"/api-reference/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json patch /v1/webhooks/endpoints/{id}","href":"/api-reference/update-a-webhook-endpoint"},{"title":"List webhook endpoint event subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/endpoints/{id}/event-subscriptions","href":"/api-reference/list-webhook-endpoint-event-subscriptions"},{"title":"Update webhook endpoint event subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json put /v1/webhooks/endpoints/{id}/event-subscriptions","href":"/api-reference/update-webhook-endpoint-event-subscriptions"},{"title":"Rotate a webhook endpoint signing secret","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json post /v1/webhooks/endpoints/{id}/secret-rotations","href":"/api-reference/rotate-a-webhook-endpoint-signing-secret"},{"title":"Send a test event to a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json post /v1/webhooks/endpoints/{id}/test-events","href":"/api-reference/send-a-test-event-to-a-webhook-endpoint"},{"title":"List public webhook event types","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/event-types","href":"/api-reference/list-public-webhook-event-types"},{"title":"Retrieve a public webhook event type","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/event-types/{id}","href":"/api-reference/retrieve-a-public-webhook-event-type"},{"title":"Create a webhook delivery replay job","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json post /v1/webhooks/replay-jobs","href":"/api-reference/create-a-webhook-delivery-replay-job"},{"title":"Retrieve a webhook delivery replay job","deprecated":null,"version":null,"openapi":"/api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/replay-jobs/{id}","href":"/api-reference/retrieve-a-webhook-delivery-replay-job"}]}]}]},{"group":"Checkout SDK","public":true,"icon":"code","root":{"title":"Checkout SDK overview","href":"/checkout-sdk/overview"},"pages":[{"title":"Metadata and attribution","href":"/checkout-sdk/metadata-and-attribution"},{"title":"Embedded hosted checkout","href":"/checkout-sdk/embedded-checkout"},{"title":"Prefilled checkout","href":"/checkout-sdk/prefilled-checkout"},{"title":"Checkout from your server","href":"/checkout-sdk/server-checkout"}]},{"group":"AI agents \u0026 MCP","public":true,"icon":"robot","pages":[{"title":"MCP for AI shopping agents (cope-sdk/mcp)","href":"/ai-agents/shopping-agents"},{"title":"MCP server for your store (cope-mcp)","href":"/ai-agents/merchant-assistant"}]},{"group":"Changelog","public":true,"icon":"newspaper","pages":[{"title":"Changelog","href":"/changelog"}]},{"group":"Webhooks","public":true,"icon":"webhook","root":{"title":"Webhooks overview","href":"/webhooks/overview"},"pages":[{"title":"Webhook endpoints","href":"/webhooks/endpoints"},{"title":"Webhook deliveries and replay","href":"/webhooks/deliveries"},{"title":"Event type discovery","href":"/webhooks/event-types"},{"title":"Webhook signing","href":"/webhooks/signing"},{"title":"Who started a refund","href":"/webhooks/refund-initiator"},{"group":"Event Reference","public":true,"icon":"braces","pages":[{"title":"Webhook events","href":"/webhooks/events/index"},{"group":"Products","public":true,"pages":[{"title":"cart.product.created","href":"/webhooks/events/cart.product.created"},{"title":"cart.product.approval_status.changed","href":"/webhooks/events/cart.product.approval_status.changed"}]},{"group":"Cart","public":true,"pages":[{"title":"cart.cart.created","href":"/webhooks/events/cart.cart.created"},{"title":"cart.cart_line.added","href":"/webhooks/events/cart.cart_line.added"},{"title":"cart.cart_line.removed","href":"/webhooks/events/cart.cart_line.removed"},{"title":"cart.cart.abandoned","href":"/webhooks/events/cart.cart.abandoned"}]},{"group":"Checkout","public":true,"pages":[{"title":"cart.checkout.created","href":"/webhooks/events/cart.checkout.created"},{"title":"cart.checkout.cancelled","href":"/webhooks/events/cart.checkout.cancelled"},{"title":"cart.checkout.expired","href":"/webhooks/events/cart.checkout.expired"}]},{"group":"Orders","public":true,"pages":[{"title":"cart.order.created","href":"/webhooks/events/cart.order.created"},{"title":"cart.order.completed","href":"/webhooks/events/cart.order.completed"},{"title":"cart.order.failed","href":"/webhooks/events/cart.order.failed"}]},{"group":"Payments","public":true,"pages":[{"title":"payment.sale.succeeded","href":"/webhooks/events/payment.sale.succeeded"},{"title":"payment.failed","href":"/webhooks/events/payment.failed"},{"title":"payment.attempt.failed","href":"/webhooks/events/payment.attempt.failed"},{"title":"payment.refund.created","href":"/webhooks/events/payment.refund.created"},{"title":"payment.refund.reversed","href":"/webhooks/events/payment.refund.reversed"}]},{"group":"Subscriptions","public":true,"pages":[{"title":"subscription.amount_changed","href":"/webhooks/events/subscription.amount_changed"},{"title":"subscription.plan_changed","href":"/webhooks/events/subscription.plan_changed"},{"title":"subscription.paused","href":"/webhooks/events/subscription.paused"},{"title":"subscription.resumed","href":"/webhooks/events/subscription.resumed"},{"title":"subscription.cancelled","href":"/webhooks/events/subscription.cancelled"}]},{"group":"Disputes","public":true,"pages":[{"title":"payment.dispute.opened","href":"/webhooks/events/payment.dispute.opened"},{"title":"payment.dispute.won","href":"/webhooks/events/payment.dispute.won"},{"title":"payment.dispute.lost","href":"/webhooks/events/payment.dispute.lost"},{"title":"payment.dispute.counter_fee.created","href":"/webhooks/events/payment.dispute.counter_fee.created"}]},{"group":"Chargebacks","public":true,"pages":[{"title":"payment.chargeback.created","href":"/webhooks/events/payment.chargeback.created"},{"title":"payment.chargeback.reversed","description":"A chargeback has been reversed.","href":"/webhooks/events/payment.chargeback.reversed"}]},{"group":"Payouts","public":true,"pages":[{"title":"payouts.transfer.initiated","public":true,"href":"/webhooks/events/payouts.transfer.initiated"},{"title":"payouts.transfer.completed","description":"A payout transfer has completed.","href":"/webhooks/events/payouts.transfer.completed"},{"title":"payouts.external_payout.paid","href":"/webhooks/events/payouts.external_payout.paid"},{"title":"payouts.external_payout.failed","href":"/webhooks/events/payouts.external_payout.failed"},{"title":"payouts.external_payout.canceled","href":"/webhooks/events/payouts.external_payout.canceled"}]}]}]},{"group":"Reference","public":true,"icon":"book-open","pages":[{"title":"Cart, checkout, and order lifecycle","href":"/reference/cart-checkout-order-lifecycle"},{"title":"Payment lifecycle","href":"/reference/payment-lifecycle"},{"title":"Event envelope","href":"/reference/event-envelope"}]}]},"basePath":"","title":"payouts.transfer.initiated - COPE","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}