Webhook event triggered when a checkout session fails due to kyc, geo or fraud.
checkout.terminally_failed is off by default. It will not be delivered until you enable it in Dashboard → Developers. See Receiving Webhooks for instructions.
When Location Is Denied or Unavailable
A deposit or purchase doesn’t end when the player denies location or their location can’t be read. The checkout shows the player how to turn location on, with a Try again button, and stays open. If the player leaves it there, the checkout expires and sends checkout.expired instead, which is also off by default.A location check that fails, such as a position outside the states you allow, still ends the checkout and sends checkout.terminally_failed. A withdrawal goes on to the payout form when location is denied or can’t be read.
Payload Structure
interface WebhookEvent { event_id: string; data: { id: string; // id of the checkout you originally created terminally_failed_at: string; type: "deposit" | "withdrawal"; customer: { id: string; }; subscription: { id: string; interval: "day" | "week" | "month" | "year"; interval_count: number; line_items: Array<{ product_id: string; sku: string | null; // null when the product was created without a sku product_name: string; product_url: string | null; quantity: number; price_cents: number; total_amount_cents: number; }>; line_items_total_amount_cents: number | null; } | null; // null for non-subscription checkouts }; type: "checkout.terminally_failed";}
terminally_failed_at is a Ruby-formatted timestamp string ("2025-05-30 06:05:22 UTC"), not ISO 8601. Other webhook events, such as checkout.review.created, use ISO 8601 ("2026-04-08T14:30:00Z") for their timestamps. Handle both formats if you write a shared date parser across webhook events.
The terminally_failed_at timestamp indicates when the checkout session failed terminally, and the type field specifies whether it was a deposit or withdrawal attempt. Unlike temporarycheckout.failed events, terminal failures indicate that the session can no longer be continued.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Soap","colors":{"primary":"#4B9EF4","light":"#FFF5E1","dark":"#1C1C1E"},"logo":{"light":"https://mintcdn.com/soappaymentsinc/xLCEKqTin27F3B_G/logo/soap-payments-light-large.png?fit=max\u0026auto=format\u0026n=xLCEKqTin27F3B_G\u0026q=85\u0026s=80edefa85946042d6b589971385d221a","dark":"https://mintcdn.com/soappaymentsinc/xLCEKqTin27F3B_G/logo/soap-payments-dark-large.png?fit=max\u0026auto=format\u0026n=xLCEKqTin27F3B_G\u0026q=85\u0026s=5c1cd400b95800d745b2adfae3d0dbdf"},"favicon":"https://mintcdn.com/soappaymentsinc/wi7l5TPQvnY0ywwl/favicon.svg?fit=max\u0026auto=format\u0026n=wi7l5TPQvnY0ywwl\u0026q=85\u0026s=599c1c310c53f1e169af11ff2d739d3a","api":{"openapi":"api-reference/openapi.json"},"background":{"color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"links":[],"primary":{"type":"button","label":"Request Access","href":"https://www.paywithsoap.com"}},"footer":{"socials":{"twitter":"https://x.com/paywithsoap","github":"https://github.com/Soap-Payments","linkedin":"https://www.linkedin.com/company/soap-payments"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","add-mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"soappaymentsinc","hasAudioNarration":false,"actualSubdomain":"soappaymentsinc","customDomains":["docs.paywithsoap.com"],"gitSource":{"type":"github","owner":"soap-payments","repo":"soap-monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6adeb175ae0dc487a6162dea"},"entitlements":{},"buildId":"6afa7127439d1ec594761b1d","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Webhooks","count":19},{"language":"default","tag":"API Endpoints","count":16},{"language":"default","tag":"Checkouts","count":8},{"language":"default","tag":"Documentation","count":6},{"language":"default","tag":"Receive Payments","count":5},{"language":"default","tag":"API Documentation","count":3},{"language":"default","tag":"Dashboard","count":3},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Send Payments","count":2}]},"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/api-v1/webhooks/checkout-terminally-failed","slug":"/api-reference/api-v1/webhooks/checkout-terminally-failed","pageMetadata":{"title":"checkout.terminally_failed","description":"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.","href":"/api-reference/api-v1/webhooks/checkout-terminally-failed"},"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: \"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\"\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`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`checkout.terminally_failed`}),` is off by default. It will not be delivered until you enable it in Dashboard → Developers. See `,_jsx(_components.a,{href:`/api-reference/api-v1/webhooks/setup`,children:`Receiving Webhooks`}),` for instructions.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`when-location-is-denied-or-unavailable`,children:`When Location Is Denied or Unavailable`}),`\n`,_jsxs(_components.p,{children:[`A deposit or purchase doesn’t end when the player denies location or their location can’t be read. The checkout shows the player how to turn location on, with a Try again button, and stays open. If the player leaves it there, the checkout expires and sends `,_jsx(_components.a,{href:`/api-reference/api-v1/webhooks/checkout-expired`,children:_jsx(_components.code,{children:`checkout.expired`})}),` instead, which is also off by default.`]}),`\n`,_jsxs(_components.p,{children:[`A location check that fails, such as a position outside the states you allow, still ends the checkout and sends `,_jsx(_components.code,{children:`checkout.terminally_failed`}),`. A withdrawal goes on to the payout form when location is denied or can’t be read.`]}),`\n`,_jsx(Heading,{level:`2`,id:`payload-structure`,children:`Payload Structure`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,language:`typescript`,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:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`27`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`interface`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` WebhookEvent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` event_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// id of the checkout you originally created`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` terminally_failed_at`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"deposit\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"withdrawal\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` customer`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_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:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` subscription`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` interval`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"day\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"week\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"month\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"year\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` interval_count`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` line_items`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` Array`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` product_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` sku`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// null when the product was created without a sku`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` product_name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` product_url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` quantity`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` price_cents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` total_amount_cents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_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:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` line_items_total_amount_cents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` number`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`; `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// null for non-subscription checkouts`})]}),`\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:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"checkout.terminally_failed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`example-payload`,children:`Example Payload`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,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:`13`,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:` \"event_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ev_tDaWu5aTVa2kbvDjGe55rxZpaMEmVFWB\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"chk_9K1sgX9tUa5Lx5AgpK32xJgXDenrBbsk\"`}),_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:` \"terminally_failed_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-05-30 06:05:22 UTC\"`}),_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:`\"deposit\"`}),_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:` \"customer\"`}),_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:`\"cus_LSAPLYCWD9uohSMm2pxRPB7xW3V4esMA\"`})]}),`\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:` \"subscription\"`}),_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`,_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:`\"checkout.terminally_failed\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`terminally_failed_at`}),` is a Ruby-formatted timestamp string (`,_jsx(_components.code,{children:`\"2025-05-30 06:05:22 UTC\"`}),`), not ISO 8601. Other webhook events, such as `,_jsx(_components.code,{children:`checkout.review.created`}),`, use ISO 8601 (`,_jsx(_components.code,{children:`\"2026-04-08T14:30:00Z\"`}),`) for their timestamps. Handle both formats if you write a shared date parser across webhook events.`]})}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`terminally_failed_at`}),` timestamp indicates when the checkout session failed terminally, and the `,_jsx(_components.code,{children:`type`}),` field specifies whether it was a deposit or withdrawal attempt. Unlike temporary`,_jsx(_components.code,{children:`checkout.failed`}),` events, terminal failures indicate that the session can no longer be continued.`]})]})}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":"checkout.terminally_failed","description":"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.","href":"/api-reference/api-v1/webhooks/checkout-terminally-failed"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When Location Is Denied or Unavailable","slug":"when-location-is-denied-or-unavailable","depth":2,"children":[]},{"title":"Payload Structure","slug":"payload-structure","depth":2,"children":[]},{"title":"Example Payload","slug":"example-payload","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"soappaymentsinc","siteName":"Soap","title":"checkout.terminally_failed - Soap","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T21:56:50.121Z","originalFileLocation":"api-reference/api-v1/webhooks/checkout-terminally-failed.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=\"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Soap\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_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/soappaymentsinc/uwmep72Fim3-ANhF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"checkout.terminally_failed - Soap\">\u003cmeta data-mint-head property=\"og:description\" content=\"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Soap\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://soappaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=checkout.terminally_failed\u0026amp;description=Webhook+event+triggered+when+a+checkout+session+fails+due+to+kyc%2C+geo+or+fraud.\u0026amp;theme=8f5505fbb6d7285f5c0028dd\u0026amp;signature=2d052a9210f1b229d410f49bafbc05b04f9d3c5511c2bd1b3d3979bb8c40481d\">\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=\"checkout.terminally_failed - Soap\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://soappaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=checkout.terminally_failed\u0026amp;description=Webhook+event+triggered+when+a+checkout+session+fails+due+to+kyc%2C+geo+or+fraud.\u0026amp;theme=8f5505fbb6d7285f5c0028dd\u0026amp;signature=2d052a9210f1b229d410f49bafbc05b04f9d3c5511c2bd1b3d3979bb8c40481d\">\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/soappaymentsinc/uwmep72Fim3-ANhF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Soap\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4B9EF4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/api-v1/webhooks/checkout-terminally-failed.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paywithsoap.com/#organization\",\"name\":\"Soap\",\"url\":\"https://docs.paywithsoap.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/soappaymentsinc/xLCEKqTin27F3B_G/logo/soap-payments-light-large.png?fit=max\u0026auto=format\u0026n=xLCEKqTin27F3B_G\u0026q=85\u0026s=80edefa85946042d6b589971385d221a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paywithsoap.com#website\",\"name\":\"Soap\",\"url\":\"https://docs.paywithsoap.com\",\"publisher\":{\"@id\":\"https://docs.paywithsoap.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed#webpage\",\"url\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed\",\"name\":\"checkout.terminally_failed\",\"description\":\"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\",\"dateModified\":\"2026-11-07T21:56:50.121Z\",\"isPartOf\":{\"@id\":\"https://docs.paywithsoap.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"checkout.terminally_failed\",\"item\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed#article\",\"headline\":\"checkout.terminally_failed\",\"name\":\"checkout.terminally_failed\",\"description\":\"Webhook event triggered when a checkout session fails due to kyc, geo or fraud.\",\"url\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywithsoap.com/api-reference/api-v1/webhooks/checkout-terminally-failed#webpage\"},\"dateModified\":\"2026-11-07T21:56:50.121Z\",\"publisher\":{\"@id\":\"https://docs.paywithsoap.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paywithsoap.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Soap\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Soap\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/api-v1/webhooks/checkout-terminally-failed.md","siteName":"Soap","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/get_started/introduction"}]},{"anchor":"API Reference","icon":"rectangle-terminal","groups":[{"group":"API Documentation","pages":[{"title":"API Introduction","href":"/api-reference/introduction"},{"title":"Checkouts, Charges and Reviews","href":"/api-reference/lifecycles"},{"title":"Soap Docs MCP Server","href":"/api-reference/soap-mcp-server"}]},{"group":"API Endpoints","pages":[{"title":"Create Customer","openapi":"POST /api/v1/customers","href":"/api-reference/api-v1/customers/create"},{"title":"Update Customer","openapi":"PATCH /api/v1/customers/{id}","href":"/api-reference/api-v1/customers/update"},{"title":"Search Customers","openapi":"GET /api/v1/customers/search","href":"/api-reference/api-v1/customers/search"},{"group":"Checkouts","pages":[{"title":"Create Checkout","openapi":"POST /api/v1/checkouts","href":"/api-reference/api-v1/checkouts/create"},{"group":"Receive Payments","pages":[{"title":"DraftKings Style Deposit","href":"/api-reference/api-v1/checkouts/draftkings-deposit"},{"title":"Preset Amount Deposit","href":"/api-reference/api-v1/checkouts/preset-deposit"},{"title":"Subscription Checkout","href":"/api-reference/api-v1/checkouts/subscription-checkout"},{"title":"Digital Goods Purchase","href":"/api-reference/api-v1/checkouts/sweeps-purchase"},{"title":"Ecomm Purchase","href":"/api-reference/api-v1/checkouts/ecomm-purchase"}]},{"group":"Send Payments","pages":[{"title":"Balance Withdrawal","href":"/api-reference/api-v1/checkouts/balance-withdrawal"},{"title":"Preset Amount Withdrawal","href":"/api-reference/api-v1/checkouts/preset-withdrawal"}]}]},{"title":"Retrieve a Charge","openapi":"GET /api/v1/charges/{id}","href":"/api-reference/api-v1/charges/show"},{"title":"Refund a Charge","openapi":"POST /api/v1/charges/{id}/refund","href":"/api-reference/api-v1/charges/refund"},{"title":"Upsert KYC","openapi":"POST /api/v1/kyc/upsert","href":"/api-reference/api-v1/kyc/upsert"},{"title":"Create Device Ping","openapi":"POST /api/v1/device_pings","href":"/api-reference/api-v1/device_pings/create"},{"title":"Get Latest Geo Check","openapi":"GET /api/v1/device_pings/latest_geo_check","href":"/api-reference/api-v1/device_pings/latest_geo_check"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/api-reference/api-v1/webhooks/webhooks"},{"title":"Receiving Webhooks","href":"/api-reference/api-v1/webhooks/setup"},{"title":"checkout.succeeded","href":"/api-reference/api-v1/webhooks/checkout-succeeded"},{"title":"checkout.hold","href":"/api-reference/api-v1/webhooks/checkout-hold"},{"title":"checkout.release_hold","href":"/api-reference/api-v1/webhooks/checkout-release-hold"},{"title":"checkout.returned","href":"/api-reference/api-v1/webhooks/checkout-returned"},{"title":"checkout.failed","href":"/api-reference/api-v1/webhooks/checkout-failed"},{"title":"checkout.pending","description":"Event triggered when a deposit or withdrawal enters a pending state.","href":"/api-reference/api-v1/webhooks/checkout-pending"},{"title":"checkout.terminally_failed","href":"/api-reference/api-v1/webhooks/checkout-terminally-failed"},{"title":"checkout.expired","description":"Webhook event triggered when a checkout session expires before completion.","href":"/api-reference/api-v1/webhooks/checkout-expired"},{"title":"checkout.voided","href":"/api-reference/api-v1/webhooks/checkout-voided"},{"title":"checkout.refunded","href":"/api-reference/api-v1/webhooks/checkout-refunded"},{"title":"checkout.cancelled","href":"/api-reference/api-v1/webhooks/checkout-cancelled"},{"title":"checkout.review.created","href":"/api-reference/api-v1/webhooks/checkout-review-created"},{"title":"checkout.review.approved","href":"/api-reference/api-v1/webhooks/checkout-review-approved"},{"title":"checkout.review.declined","href":"/api-reference/api-v1/webhooks/checkout-review-declined"},{"title":"customer.kyc.created","href":"/api-reference/api-v1/webhooks/customer-kyc-created"},{"title":"customer.restricted","href":"/api-reference/api-v1/webhooks/customer-restricted"},{"title":"customer.unrestricted","href":"/api-reference/api-v1/webhooks/customer-unrestricted"}]},{"group":"Testing","pages":[{"title":"Sandbox Test Data","href":"/api-reference/api-v1/testing"}]}]},{"anchor":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"checkout.terminally_failed - Soap","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}