Under Schedule Only Recovery, when a transaction made outside Hyperswitch is reported to POST /v2/recovery, Hyperswitch tells when to retry the invoice. After recording the transaction, it decides the invoice’s next retry and sends it to the profile’s webhook URL.A transaction that doesn’t change the next retry sends no webhook: for example, one made with the customer present, or a charge that recovers the invoice.Each webhook has its own event_id, and the request is signed in the X-Webhook-Signature-512 header, like every Hyperswitch outgoing webhook.
Webhook body
string
required
The provider merchant id (platform/business owner).
string
required
The unique event id for each webhook.
string
required
recovery_retry_scheduled or recovery_limits_exhausted.
object
required
Hide properties
string
required
Always recovery_retry_details.
object
required
The next retry of the invoice. Every field is always present.
Hide properties
string
required
Unique identifier of the invoice in Hyperswitch.
string
required
Unique identifier of the invoice in the merchant’s billing system.
integer
required
Number of the next retry, counted the way the max_retry_count of the profile counts them: the first retry after the original payment is 1.
string | null
required
The time to trigger the retry at, then report its result through the recovery API. null when no retry is scheduled.
string | null
required
Why no retry is scheduled: retries_exhausted, grace_period_expired or hard_declined. null when a retry is scheduled.
string
The time at which the webhook was sent.
string | null
The merchant id of the merchant account whose connector credentials are used for payment processing.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperswitch","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa","dark":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/dark.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=ba1e1063c50d5e3e6814ac1394cbe0bd"},"favicon":"https://mintcdn.com/juspay-78/lgBtlsxwQg1XCgqU/favicon.png?fit=max\u0026auto=format\u0026n=lgBtlsxwQg1XCgqU\u0026q=85\u0026s=1e2ff54d240ff03d1e663390917f2fb6","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml","decision_engine_openapi-specs.json"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://inviter.co/hyperswitch-slack","label":"Contact Us"},{"href":"https://deepwiki.com/juspay/hyperswitch","label":"Explore with Deepwiki"}],"primary":{"type":"button","label":"Self-Deploy","href":"https://docs.hyperswitch.io/self-hosting"}},"footer":{"socials":{"github":"https://github.com/juspay/hyperswitch","linkedin":"https://www.linkedin.com/company/hyperswitch"}},"integrations":{"gtm":{"tagId":"GTM-PLBNKQFQ"},"mixpanel":{"projectToken":"b00355f29d9548d1333608df71d5d53d"}},"contextual":{"options":["copy","claude","chatgpt","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"juspay-78","hasAudioNarration":false,"actualSubdomain":"juspay-78","customDomains":["api-reference.hyperswitch.io"],"gitSource":{"type":"github","owner":"juspay","repo":"hyperswitch","deployBranch":"main","contentDirectory":"api-reference","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc98929848465aa458a85f","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":224},{"language":"default","tag":"Decision Engine API Reference","count":121},{"language":"default","tag":"Payments Core APIs","count":69},{"language":"default","tag":"API Examples (curl flows)","count":44},{"language":"default","tag":"Other APIs","count":39},{"language":"default","tag":"Payments Core APIs [BETA]","count":33},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Payments","count":27},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payment Methods","count":24}]},"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/revenue-recovery/revenue-recovery--webhook","slug":"/v2/revenue-recovery/revenue-recovery--webhook","pageMetadata":{"title":"Outgoing Webhook","description":"The next retry of an invoice under Schedule Only Recovery, sent to the profile's webhook URL","href":"/v2/revenue-recovery/revenue-recovery--webhook"},"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: \"The next retry of an invoice under Schedule Only Recovery, sent to the profile’s webhook URL\"\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`,..._provideComponents(),...props.components},{Expandable,Heading,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Under Schedule Only Recovery, when a transaction made outside Hyperswitch is reported to `,_jsx(_components.a,{href:`/v2/revenue-recovery/revenue-recovery--create`,children:_jsx(_components.code,{children:`POST /v2/recovery`})}),`, Hyperswitch tells when to retry the invoice. After recording the transaction, it decides the invoice’s next retry and sends it to the profile’s webhook URL.`]}),`\n`,_jsx(_components.p,{children:`A transaction that doesn’t change the next retry sends no webhook: for example, one made with the customer present, or a charge that recovers the invoice.`}),`\n`,_jsxs(_components.p,{children:[`Each webhook has its own `,_jsx(_components.code,{children:`event_id`}),`, and the request is signed in the `,_jsx(_components.code,{children:`X-Webhook-Signature-512`}),` header, like every Hyperswitch outgoing webhook.`]}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-body`,children:`Webhook body`}),`\n`,_jsx(ResponseField,{name:`merchant_id`,type:`string`,required:true,id:`param-merchant-id`,children:_jsx(_components.p,{children:`The provider merchant id (platform/business owner).`})}),`\n`,_jsx(ResponseField,{name:`event_id`,type:`string`,required:true,id:`param-event-id`,children:_jsx(_components.p,{children:`The unique event id for each webhook.`})}),`\n`,_jsx(ResponseField,{name:`event_type`,type:`string`,required:true,id:`param-event-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`recovery_retry_scheduled`}),` or `,_jsx(_components.code,{children:`recovery_limits_exhausted`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`content`,type:`object`,required:true,id:`param-content`,children:_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`recovery_retry_details`}),`.`]})}),_jsxs(ResponseField,{name:`object`,type:`object`,required:true,id:`param-object`,children:[_jsx(_components.p,{children:`The next retry of the invoice. Every field is always present.`}),_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier of the invoice in Hyperswitch.`})}),_jsx(ResponseField,{name:`merchant_reference_id`,type:`string`,required:true,id:`param-merchant-reference-id`,children:_jsx(_components.p,{children:`Unique identifier of the invoice in the merchant’s billing system.`})}),_jsx(ResponseField,{name:`retry_count`,type:`integer`,required:true,id:`param-retry-count`,children:_jsxs(_components.p,{children:[`Number of the next retry, counted the way the `,_jsx(_components.code,{children:`max_retry_count`}),` of the profile counts them: the first retry after the original payment is 1.`]})}),_jsx(ResponseField,{name:`schedule_time`,type:`string | null`,required:true,id:`param-schedule-time`,children:_jsxs(_components.p,{children:[`The time to trigger the retry at, then report its result through the recovery API. `,_jsx(_components.code,{children:`null`}),` when no retry is scheduled.`]})}),_jsx(ResponseField,{name:`reason`,type:`string | null`,required:true,id:`param-reason`,children:_jsxs(_components.p,{children:[`Why no retry is scheduled: `,_jsx(_components.code,{children:`retries_exhausted`}),`, `,_jsx(_components.code,{children:`grace_period_expired`}),` or `,_jsx(_components.code,{children:`hard_declined`}),`. `,_jsx(_components.code,{children:`null`}),` when a retry is scheduled.`]})})]})]})]})}),`\n`,_jsx(ResponseField,{name:`timestamp`,type:`string`,id:`param-timestamp`,children:_jsx(_components.p,{children:`The time at which the webhook was sent.`})}),`\n`,_jsx(ResponseField,{name:`processor_merchant_id`,type:`string | null`,id:`param-processor-merchant-id`,children:_jsx(_components.p,{children:`The merchant id of the merchant account whose connector credentials are used for payment processing.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Outgoing Webhook","description":"The next retry of an invoice under Schedule Only Recovery, sent to the profile's webhook URL","href":"/v2/revenue-recovery/revenue-recovery--webhook"}}},"mdxSourceWithNoJs":{"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`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,RequestExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Under Schedule Only Recovery, when a transaction made outside Hyperswitch is reported to `,_jsx(_components.a,{href:`/v2/revenue-recovery/revenue-recovery--create`,children:_jsx(_components.code,{children:`POST /v2/recovery`})}),`, Hyperswitch tells when to retry the invoice. After recording the transaction, it decides the invoice’s next retry and sends it to the profile’s webhook URL.`]}),`\n`,_jsx(_components.p,{children:`A transaction that doesn’t change the next retry sends no webhook: for example, one made with the customer present, or a charge that recovers the invoice.`}),`\n`,_jsxs(_components.p,{children:[`Each webhook has its own `,_jsx(_components.code,{children:`event_id`}),`, and the request is signed in the `,_jsx(_components.code,{children:`X-Webhook-Signature-512`}),` header, like every Hyperswitch outgoing webhook.`]}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-body`,children:`Webhook body`}),`\n`,_jsx(ResponseField,{name:`merchant_id`,type:`string`,required:true,id:`param-merchant-id`,children:_jsx(_components.p,{children:`The provider merchant id (platform/business owner).`})}),`\n`,_jsx(ResponseField,{name:`event_id`,type:`string`,required:true,id:`param-event-id`,children:_jsx(_components.p,{children:`The unique event id for each webhook.`})}),`\n`,_jsx(ResponseField,{name:`event_type`,type:`string`,required:true,id:`param-event-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`recovery_retry_scheduled`}),` or `,_jsx(_components.code,{children:`recovery_limits_exhausted`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`content`,type:`object`,required:true,id:`param-content`,children:_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`recovery_retry_details`}),`.`]})}),_jsxs(ResponseField,{name:`object`,type:`object`,required:true,id:`param-object`,children:[_jsx(_components.p,{children:`The next retry of the invoice. Every field is always present.`}),_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier of the invoice in Hyperswitch.`})}),_jsx(ResponseField,{name:`merchant_reference_id`,type:`string`,required:true,id:`param-merchant-reference-id`,children:_jsx(_components.p,{children:`Unique identifier of the invoice in the merchant’s billing system.`})}),_jsx(ResponseField,{name:`retry_count`,type:`integer`,required:true,id:`param-retry-count`,children:_jsxs(_components.p,{children:[`Number of the next retry, counted the way the `,_jsx(_components.code,{children:`max_retry_count`}),` of the profile counts them: the first retry after the original payment is 1.`]})}),_jsx(ResponseField,{name:`schedule_time`,type:`string | null`,required:true,id:`param-schedule-time`,children:_jsxs(_components.p,{children:[`The time to trigger the retry at, then report its result through the recovery API. `,_jsx(_components.code,{children:`null`}),` when no retry is scheduled.`]})}),_jsx(ResponseField,{name:`reason`,type:`string | null`,required:true,id:`param-reason`,children:_jsxs(_components.p,{children:[`Why no retry is scheduled: `,_jsx(_components.code,{children:`retries_exhausted`}),`, `,_jsx(_components.code,{children:`grace_period_expired`}),` or `,_jsx(_components.code,{children:`hard_declined`}),`. `,_jsx(_components.code,{children:`null`}),` when a retry is scheduled.`]})})]})]})]})}),`\n`,_jsx(ResponseField,{name:`timestamp`,type:`string`,id:`param-timestamp`,children:_jsx(_components.p,{children:`The time at which the webhook was sent.`})}),`\n`,_jsx(ResponseField,{name:`processor_merchant_id`,type:`string | null`,id:`param-processor-merchant-id`,children:_jsx(_components.p,{children:`The merchant id of the merchant account whose connector credentials are used for payment processing.`})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`Webhook body`,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"merchant_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"merchant_1234567890\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"evt_01a1d62a41b17a208968368ec06459d7\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"recovery_retry_scheduled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"content\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"recovery_retry_details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"12_pay_01a3868d94a471219b5c4bc71638e2zc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"merchant_reference_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invoice_mbabizu24mvu3mela5njyh\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"retry_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schedule_time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-13T21:31:24.979Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-13T18:27:35.985Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"processor_merchant_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"merchant_1234567890\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Outgoing Webhook","description":"The next retry of an invoice under Schedule Only Recovery, sent to the profile's webhook URL","href":"/v2/revenue-recovery/revenue-recovery--webhook"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Webhook body","slug":"webhook-body","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Webhook body","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"17\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"merchant_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"merchant_1234567890\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"event_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"evt_01a1d62a41b17a208968368ec06459d7\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"event_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"recovery_retry_scheduled\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"content\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"recovery_retry_details\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"object\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"12_pay_01a3868d94a471219b5c4bc71638e2zc\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"merchant_reference_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"invoice_mbabizu24mvu3mela5njyh\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"retry_count\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"schedule_time\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-11-13T21:31:24.979Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"reason\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-11-13T18:27:35.985Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"processor_merchant_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"merchant_1234567890\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":[],"subdomain":"juspay-78","siteName":"Hyperswitch","title":"Outgoing Webhook - Hyperswitch","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0":{"href":"/v2/revenue-recovery/revenue-recovery--webhook","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T18:10:40.468Z","originalFileLocation":"v2/revenue-recovery/revenue-recovery--webhook.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=\"The next retry of an invoice under Schedule Only Recovery, sent to the profile\u0026#x27;s webhook URL\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Outgoing Webhook - Hyperswitch\">\u003cmeta data-mint-head property=\"og:description\" content=\"The next retry of an invoice under Schedule Only Recovery, sent to the profile\u0026#x27;s webhook URL\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperswitch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Revenue+Recovery\u0026amp;title=Outgoing+Webhook\u0026amp;description=The+next+retry+of+an+invoice+under+Schedule+Only+Recovery%2C+sent+to+the+profile%27s+webhook+URL\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=7b40c8627fa2fd4ff9803ec50e5519359239a2c5752bbe923b115f2ccff275b6\">\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=\"Outgoing Webhook - Hyperswitch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The next retry of an invoice under Schedule Only Recovery, sent to the profile\u0026#x27;s webhook URL\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Revenue+Recovery\u0026amp;title=Outgoing+Webhook\u0026amp;description=The+next+retry+of+an+invoice+under+Schedule+Only+Recovery%2C+sent+to+the+profile%27s+webhook+URL\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=7b40c8627fa2fd4ff9803ec50e5519359239a2c5752bbe923b115f2ccff275b6\">\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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/revenue-recovery/revenue-recovery--webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-reference.hyperswitch.io/#organization\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-reference.hyperswitch.io#website\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook#webpage\",\"url\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook\",\"name\":\"Outgoing Webhook\",\"description\":\"The next retry of an invoice under Schedule Only Recovery, sent to the profile's webhook URL\",\"dateModified\":\"2026-11-17T18:10:40.468Z\",\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"},\"breadcrumb\":{\"@id\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Revenue Recovery\",\"item\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Outgoing Webhook\",\"item\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook#article\",\"headline\":\"Outgoing Webhook\",\"name\":\"Outgoing Webhook\",\"description\":\"The next retry of an invoice under Schedule Only Recovery, sent to the profile's webhook URL\",\"url\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook\",\"mainEntityOfPage\":{\"@id\":\"https://api-reference.hyperswitch.io/v2/revenue-recovery/revenue-recovery--webhook#webpage\"},\"dateModified\":\"2026-11-17T18:10:40.468Z\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperswitch\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperswitch\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v2/revenue-recovery/revenue-recovery--webhook.md","siteName":"Hyperswitch","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","pages":[{"title":"1.0.0","href":"/introduction"}]},{"version":"2.0.0","groups":[{"group":"Get Started [BETA]","pages":[{"title":"👋 Welcome to Hyperswitch API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction"}]},{"group":"Essentials [BETA]","pages":[{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs [BETA]","pages":[{"group":"Payments","pages":[{"openapi":"post /v2/payments/create-intent","title":"Payments - Create Intent","href":"/v2/payments/payments--create-intent"},{"openapi":"get /v2/payments/{id}/get-intent","title":"Payments - Get Intent","href":"/v2/payments/payments--get-intent"},{"openapi":"put /v2/payments/{id}/update-intent","title":"Payments - Update Intent","href":"/v2/payments/payments--update-intent"},{"openapi":"post /v2/payments/{payment_id}/create-external-sdk-tokens","title":"Payments - Session token","href":"/v2/payments/payments--session-token"},{"openapi":"get /v2/payments/{id}/payment-methods","title":"Payments - Payment Methods List","href":"/v2/payments/payments--payment-methods-list"},{"openapi":"post /v2/payments/{id}/confirm-intent","title":"Payments - Confirm Intent","href":"/v2/payments/payments--confirm-intent"},{"openapi":"get /v2/payments/{id}","title":"Payments - Get","href":"/v2/payments/payments--get"},{"openapi":"post /v2/payments","title":"Payments - Create and Confirm Intent","href":"/v2/payments/payments--create-and-confirm-intent"},{"openapi":"get /v2/payments/list","title":"Payments - List","href":"/v2/payments/payments--list"},{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","href":"/v2/payments/payments--check-balance-and-apply-pm-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /v2/payment-methods","title":"Payment Method - Create","href":"/v2/payment-methods/payment-method--create"},{"openapi":"post /v2/payment-methods/create-intent","title":"Payment Method - Create Intent","href":"/v2/payment-methods/payment-method--create-intent"},{"openapi":"post /v2/payment-methods/{id}/confirm-intent","title":"Payment Method - Confirm Intent","href":"/v2/payment-methods/payment-method--confirm-intent"},{"openapi":"put /v2/payment-methods/{id}/update-saved-payment-method","title":"Payment Method - Update","href":"/v2/payment-methods/payment-method--update"},{"openapi":"get /v2/payment-methods/{id}","title":"Payment Method - Retrieve","href":"/v2/payment-methods/payment-method--retrieve"},{"openapi":"delete /v2/payment-methods/{id}","title":"Payment Method - Delete","href":"/v2/payment-methods/payment-method--delete"},{"openapi":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods"},{"title":"List saved payment methods for a customer","href":"/v2/payment-methods/list-saved-payment-methods-for-a-customer"}]},{"group":"Network Tokenization","pages":[{"title":"Check network token status","href":"/v2/payment-methods/check-network-token-status"}]},{"group":"Payment Method Session","pages":[{"openapi":"post /v2/payment-method-sessions","title":"Payment Method Session - Create","href":"/v2/payment-method-session/payment-method-session--create"},{"openapi":"get /v2/payment-method-sessions/{id}","title":"Payment Method Session - Retrieve","href":"/v2/payment-method-session/payment-method-session--retrieve"},{"openapi":"get /v2/payment-method-sessions/{id}/list-payment-methods","title":"Payment Method Session - List Payment Methods","href":"/v2/payment-method-session/payment-method-session--list-payment-methods"},{"openapi":"put /v2/payment-method-sessions/{id}/update-saved-payment-method","title":"Payment Method Session - Update a saved payment method","href":"/v2/payment-method-session/payment-method-session--update-a-saved-payment-method"},{"openapi":"post /v2/payment-method-sessions/{id}/confirm","title":"Payment Method Session - Confirm a payment method session","href":"/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session"},{"openapi":"delete /v2/payment-method-sessions/{id}","title":"Payment Method Session - Delete a saved payment method","href":"/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /v2/customers","title":"Customers - Create","href":"/v2/customers/customers--create"},{"openapi":"get /v2/customers/{id}","title":"Customers - Retrieve","href":"/v2/customers/customers--retrieve"},{"openapi":"get /v2/customers/reference/{merchant_reference_id}","title":"Customers - Retrieve using Merchant Reference ID","href":"/v2/customers/customers--retrieve-by-merchant-reference-id"},{"openapi":"put /v2/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update"},{"openapi":"delete /v2/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete"},{"openapi":"get /v2/customers/list","title":"Customers - List","href":"/v2/customers/customers--list"}]},{"group":"Refunds","pages":[{"openapi":"post /v2/refunds","title":"Refunds - Create","href":"/v2/refunds/refunds--create"},{"openapi":"put /v2/refunds/{id}/update_metadata","title":null,"href":"/v2/refunds/refunds--metadata-update"},{"openapi":"get /v2/refunds/{id}","title":"Refunds - Retrieve","href":"/v2/refunds/refunds--retrieve"},{"openapi":"post /v2/refunds/list","title":"Refunds - List","href":"/v2/refunds/refunds--list"}]}]},{"group":"Account management APIs [BETA]","pages":[{"group":"Organization","pages":[{"openapi":"post /v2/organizations","title":"Organization - Create","href":"/v2/organization/organization--create"},{"openapi":"get /v2/organizations/{id}","title":"Organization - Retrieve","href":"/v2/organization/organization--retrieve"},{"openapi":"put /v2/organizations/{id}","title":"Organization - Update","href":"/v2/organization/organization--update"},{"openapi":"get /v2/organizations/{id}/merchant-accounts","title":"Organization - Merchant Account - List","href":"/v2/organization/organization--merchant-account--list"}]},{"group":"Merchant Account","pages":[{"openapi":"post /v2/merchant-accounts","title":"Merchant Account - Create","href":"/v2/merchant-account/merchant-account--create"},{"openapi":"get /v2/merchant-accounts/{id}","title":"Merchant Account - Retrieve","href":"/v2/merchant-account/merchant-account--retrieve"},{"openapi":"put /v2/merchant-accounts/{id}","title":"Merchant Account - Update","href":"/v2/merchant-account/merchant-account--update"},{"openapi":"get /v2/merchant-accounts/{id}/profiles","title":"Merchant Account - Profile List","href":"/v2/merchant-account/business-profile--list"}]},{"group":"Profile","pages":[{"openapi":"post /v2/profiles","title":"Profile - Create","href":"/v2/profile/profile--create"},{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","href":"/v2/profile/profile--update"},{"openapi":"patch /v2/profiles/{id}/activate-routing-algorithm","title":"Profile - Activate routing algorithm","href":"/v2/profile/profile--activate-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/fallback-routing","title":"Profile - Update Default Fallback Routing Algorithm","href":"/v2/profile/profile--update-default-fallback-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/deactivate-routing-algorithm","title":"Profile - Deactivate routing algorithm","href":"/v2/profile/profile--deactivate-routing-algorithm"},{"openapi":"get /v2/profiles/{id}","title":"Profile - Retrieve","href":"/v2/profile/profile--retrieve"},{"openapi":"get /v2/profiles/{id}/connector-accounts","title":"Profile - Connector Accounts List","href":"/v2/profile/merchant-connector--list"},{"openapi":"get /v2/profiles/{id}/routing-algorithm","title":"Profile - Retrieve Active Routing Algorithm","href":"/v2/profile/profile--retrieve-active-routing-algorithm"},{"openapi":"get /v2/profiles/{id}/fallback-routing","title":"Profile - Retrieve Default Fallback Routing Algorithm","href":"/v2/profile/profile--retrieve-default-fallback-routing-algorithm"}]},{"group":"Connector Account","pages":[{"openapi":"post /v2/connector-accounts","title":"Connector Account - Create","href":"/v2/connector-account/connector-account--create"},{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","href":"/v2/connector-account/connector-account--retrieve"},{"openapi":"put /v2/connector-accounts/{id}","title":"Connector Account - Update","href":"/v2/connector-account/connector-account--update"}]},{"group":"API Key","pages":[{"openapi":"post /v2/api-keys","title":"API Key - Create","href":"/v2/api-key/api-key--create"},{"openapi":"get /v2/api-keys/{id}","title":"API Key - Retrieve","href":"/v2/api-key/api-key--retrieve"},{"openapi":"put /v2/api-keys/{id}","title":"API Key - Update","href":"/v2/api-key/api-key--update"},{"openapi":"delete /v2/api-keys/{id}","title":"API Key - Revoke","href":"/v2/api-key/api-key--revoke"},{"openapi":"get /v2/api-keys/list","title":"API Key - List","href":"/v2/api-key/api-key--list"}]},{"group":"Routing","pages":[{"openapi":"post /v2/routing-algorithms","title":"Routing - Create","href":"/v2/routing/routing--create"},{"openapi":"get /v2/routing-algorithms/{id}","title":"Routing - Retrieve","href":"/v2/routing/routing--retrieve"}]}]},{"group":"Other APIs [BETA]","pages":[{"group":"Proxy","pages":[{"openapi":"post /v2/proxy","title":"Proxy","href":"/v2/proxy/proxy"}]},{"group":"Tokenization","pages":[{"openapi":"post /v2/tokenize","title":"Tokenization - Create","href":"/v2/tokenization/tokenization--create"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v2/schemas/outgoing--webhook"}]}]},{"group":"Revenue Recovery","pages":[{"openapi":"post /v2/recovery","title":"Revenue Recovery - Create","href":"/v2/revenue-recovery/revenue-recovery--create"},{"openapi":"post /v2/recovery/{merchant_reference_id}/cancel","title":"Revenue Recovery - Cancel","description":"Cancel the revenue recovery workflow of an invoice that is still in recovery: its scheduled\nretries are stopped and no further recovery attempts are made. A `failed` payment moves to\n`cancelled`, and a partially captured payment moves to `cancelled_post_capture`. The request\nis refused with `400` when the payment is in any other state, when a retry is in progress,\nor when recovery already reached a terminal status. The invoice is looked up by its merchant\nreference id within the business profile given in the `X-Profile-Id` header.","href":"/v2/revenue-recovery/revenue-recovery--cancel"},{"title":"Outgoing Webhook","href":"/v2/revenue-recovery/revenue-recovery--webhook"}]}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Decision Engine API Reference","pages":[{"title":"Decision Engine API Reference","href":"/decision-engine-api-reference/introduction"}]}]},"basePath":"","title":"Outgoing Webhook - Hyperswitch","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["2b790eda92"],"chunks":["ApiExamples-C0px4Tml.js","utils-DbZn3Mjn.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","cloneDeep-CnBnaSyy.js","utils-Bl2DvzOJ.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js"]}