Submits the request to the Atum network for settlement and resolves synchronously within the requirement’s maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.
The payer's signed credential. Its payload.paymentRequest conforms to the canonical PaymentRequest declaration and carries the PaymentRequestEnvelope (PRE) identity binding.
Full settlement receipt, which may be present once the payment is completed; also returned to the payer in PAYMENT-RESPONSE.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Atum Docs","description":"Documentation for Atum, an open payments network for tokenized-currency payments. You submit a signed payment request; Atum selects a settlement operator's price quote, the operator delivers on the destination rail, and Atum verifies delivery.","colors":{"primary":"#24450d","light":"#b3e78d","dark":"#7fcb49"},"logo":{"light":"https://mintcdn.com/atumlabs/eBwMdhd0uJ6cwbY0/images/assets/wordmark-light.svg?fit=max\u0026auto=format\u0026n=eBwMdhd0uJ6cwbY0\u0026q=85\u0026s=6ba7458a7e4528e698e48cbf8e15c375","dark":"https://mintcdn.com/atumlabs/eBwMdhd0uJ6cwbY0/images/assets/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=eBwMdhd0uJ6cwbY0\u0026q=85\u0026s=023ac107f39c390813f415746157f405"},"favicon":"https://mintcdn.com/atumlabs/eBwMdhd0uJ6cwbY0/favicon.svg?fit=max\u0026auto=format\u0026n=eBwMdhd0uJ6cwbY0\u0026q=85\u0026s=0d5cc391c59a2f5739384e8520536a1a","api":{"playground":{"display":"simple"}},"appearance":{"default":"dark"},"background":{"color":{"light":"#f1f0e9","dark":"#171d15"}},"navbar":{"primary":{"type":"button","label":"Community chat","href":"https://discord.gg/a5mbNjnDNj"}},"footer":{"socials":{"discord":"https://discord.gg/a5mbNjnDNj"},"links":[{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://atum.xyz/privacy-policy"}]}]},"fonts":{"heading":{"family":"Newsreader"},"body":{"family":"Public Sans"}},"styling":{"codeblocks":{"theme":"github-dark"},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"variables":{"paymentGatewayTestnet":"https://payment-gw.production-testnet.atum.xyz","paymentGatewayMainnet":"https://payment-gw.production-mainnet.atum.xyz","x402FacilitatorTestnet":"https://payment-gw.production-testnet.atum.xyz/x402/v1","x402FacilitatorMainnet":"https://payment-gw.production-mainnet.atum.xyz/x402/v1","veriFillTestnet":"https://veri-fill.production-testnet.atum.xyz","veriFillMainnet":"https://veri-fill.production-mainnet.atum.xyz"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"atumlabs","hasAudioNarration":false,"actualSubdomain":"atumlabs","customDomains":["docs.atum.xyz"],"gitSource":{"type":"github","owner":"atum-labs","repo":"atum-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8b017ca78e468455a2e68","collectionId":"f90bb902-a0bb-4b51-a5f6-05f506a97595","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8b017ca78e468455a2e68"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed33e649d4102da1fae20b","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Get started","count":35},{"language":"default","tag":"Overview","count":24},{"language":"default","tag":"Settle payments","count":21},{"language":"default","tag":"API Reference","count":17},{"language":"default","tag":"Core concepts","count":15},{"language":"default","tag":"Start building","count":14},{"language":"default","tag":"Payment protocols","count":13},{"language":"default","tag":"Payment Gateway","count":8},{"language":"default","tag":"Settlement Reference","count":6},{"language":"default","tag":"Configuration","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@import url(\"https://fonts.googleapis.com/css2?family=Host+Grotesk:wght@300..800\u0026display=swap\");@import url(\"https://use.typekit.net/xnt1dnq.css\");:root{--color-dark-charcoal: #2b2a28;--color-tofu: #f1f0e9;--color-tofu-light: #f1efe7;--color-young-green: #97e162;--color-young-green-deep: #7fcb49;--color-green-house: #24450d;--color-dark-teal: #2f6460;--color-pale-green: #f0fbe8;--color-full-white: #ffffff;--color-dark-charcoal-12: rgb(43 42 40 / 12%);--color-dark-charcoal-40: rgb(43 42 40 / 40%);--color-dark-charcoal-65: rgb(43 42 40 / 65%);--ink: #171d15;--ink-2: #1e261c;--ink-line: #2c342b;--ink-muted: #9aa396;--ink-dim: #6b7266;--ink-green: #b3e78d;--ink-fg: #f7f6f2;--font-display: \"hardcover-vf\", \"Newsreader\", \"Iowan Old Style\", Georgia, serif;--font-ui: \"Host Grotesk\", \"host-grotesk\", ui-sans-serif, system-ui, -apple-system, \"Segoe UI\", sans-serif;--font-prose: \"Public Sans\", \"public-sans\", var(--font-ui);--font-mono: ui-monospace, \"SF Mono\", SFMono-Regular, Menlo, Consolas, monospace;--ring: 0 0 0 3px rgb(151 225 98 / 45%);--radius-field: 6px;--fg: var(--color-dark-charcoal);--fg-2: #3a3936;--fg-3: #605f5b;--fg-muted: #83827c;--fg-dim: #b0afa8;--bg: var(--color-tofu);--bg-nav: var(--color-tofu);--hairline: var(--color-dark-charcoal-12);--surface: var(--color-full-white);--surface-line: var(--color-dark-charcoal-12);--label-fg: var(--color-dark-charcoal-65);--link-fg: var(--color-dark-teal);--link-hover: var(--color-green-house);--accent-text: var(--color-green-house);--inline-code-bg: var(--color-full-white);--ok-fg: var(--color-green-house);--ok-bg: var(--color-pale-green);--ok-line: rgb(36 69 13 / 22%);--info-fg: var(--color-dark-teal);--info-bg: #e9f0ef;--info-line: rgb(47 100 96 / 25%);--warn-fg: #7a4e00;--warn-bg: #fbf3e0;--warn-line: rgb(122 78 0 / 25%);--err-fg: #9b2c2c;--err-bg: #fbeae7;--err-line: rgb(155 44 44 / 25%);--muted-fg: var(--color-dark-charcoal-65);--muted-line: var(--color-dark-charcoal-12);--shadow-lg: 0 24px 48px rgb(43 42 40 / 18%)}html.dark{--fg: var(--ink-fg);--fg-2: #e3e4dd;--fg-3: #c9ccc2;--fg-muted: var(--ink-muted);--fg-dim: var(--ink-dim);--bg: var(--ink);--bg-nav: var(--ink-2);--hairline: var(--ink-line);--surface: var(--ink-2);--surface-line: var(--ink-line);--label-fg: var(--ink-muted);--link-fg: var(--ink-green);--link-hover: var(--color-young-green);--accent-text: var(--ink-green);--inline-code-bg: var(--ink-2);--ok-fg: var(--ink-green);--ok-bg: rgb(151 225 98 / 12%);--ok-line: rgb(151 225 98 / 35%);--info-fg: #9fd3ce;--info-bg: rgb(47 100 96 / 25%);--info-line: rgb(47 100 96 / 60%);--warn-fg: #f0c674;--warn-bg: rgb(122 78 0 / 28%);--warn-line: rgb(240 198 116 / 40%);--err-fg: #f3b7b7;--err-bg: rgb(155 44 44 / 30%);--err-line: rgb(243 183 183 / 40%);--muted-fg: var(--ink-muted);--muted-line: var(--ink-line);--shadow-lg: 0 24px 48px rgb(0 0 0 / 45%)}body{-webkit-font-smoothing:antialiased;font-family:var(--font-ui)}::selection{background:var(--color-young-green);color:var(--color-dark-charcoal)}:root{--gray-50: 247 246 242;--gray-100: 241 239 231;--gray-200: 229 228 221;--gray-300: 215 214 207;--gray-400: 176 175 168;--gray-500: 131 130 124;--gray-600: 96 95 91;--gray-700: 58 57 54;--gray-800: 43 42 40;--gray-900: 30 29 27;--gray-950: 21 20 18}html.dark{--gray-50: 247 246 242;--gray-100: 227 228 221;--gray-200: 201 204 194;--gray-300: 181 185 174;--gray-400: 154 163 150;--gray-500: 107 114 102;--gray-600: 76 84 73;--gray-700: 58 67 56;--gray-800: 44 52 43;--gray-900: 30 38 28;--gray-950: 23 29 21}#content,#content .prose,#header .prose{font-family:var(--font-prose);font-weight:400}#content a.link,#header .prose a{color:var(--link-fg);border-bottom:0;text-decoration:underline;text-decoration-thickness:1px;text-underline-offset:2px}#content a.link:hover,#header .prose a:hover{color:var(--link-hover)}#page-title,#content h1,#content h2:not([data-component-part]),#content h3:not([data-component-part]){font-family:var(--font-display);font-weight:300;letter-spacing:-0.02em;color:var(--fg)}#content h4,#content h5,#content h6{font-family:var(--font-ui);font-weight:600;letter-spacing:-0.01em;color:var(--fg)}#page-title{font-size:clamp(2rem, 4vw, 2.75rem);line-height:1.08}#page-title::before{content:\"\";display:block;width:28px;height:3px;margin-bottom:16px;background:var(--color-young-green)}#page-title code{font:500 0.68em/1 var(--font-mono);letter-spacing:0;background:transparent;border:0;padding:0;vertical-align:0.06em}#content h2:not([data-component-part]){font-size:1.75rem;margin-top:2.5rem;padding-top:1.25rem;border-top:1px solid var(--hairline)}#content h2#overview:not([data-component-part]){margin-top:0;padding-top:0;border-top:0}#content h3:not([data-component-part]){font-size:1.35rem}#content :is(h2,h3,h4)>div>a>div{background:transparent;box-shadow:none;--tw-ring-color: transparent;color:var(--label-fg)}#content :is(h2,h3,h4)>div>a>div svg{display:none}#content :is(h2,h3,h4)>div>a>div::before{content:\"¶\";font:400 0.9rem/1 var(--font-ui)}#content :is(h2,h3,h4)>div>a:hover>div::before{color:var(--color-young-green-deep)}#header .prose p{font-family:var(--font-prose);font-weight:300;color:var(--fg-3)}.eyebrow{font:600 10.5px/1.3 var(--font-mono);letter-spacing:0.08em;text-transform:uppercase;color:var(--accent-text)!important;height:auto}.sidebar-group-header,#table-of-contents h2 button,#content th{font:600 10.5px/1.3 var(--font-mono)!important;letter-spacing:0.08em;text-transform:uppercase;color:var(--label-fg)!important}#navbar>div:first-child{background:var(--bg-nav)!important;border-bottom:1px solid var(--hairline)!important;backdrop-filter:none}#navbar a:has(img.nav-logo){display:inline-flex;align-items:center;gap:12px;text-decoration:none;white-space:nowrap}#navbar img.nav-logo,#footer img.nav-logo{height:20px!important;width:auto!important;max-width:none}#navbar a:has(img.nav-logo)::after{content:\"Docs\";display:inline-block;font:600 10.5px/1 var(--font-mono);letter-spacing:0.08em;text-transform:uppercase;color:var(--label-fg);border:1px solid var(--surface-line);border-radius:999px;padding:6px 10px;white-space:nowrap}@media (max-width: 50rem){#navbar a:has(img.nav-logo)::after{display:none}}#navbar .nav-tabs-item,#navbar .navbar-link,#navbar a,#navbar button{font-family:var(--font-ui)}#navbar .nav-tabs-item{font-weight:500;text-shadow:none!important}#navbar .nav-tabs-item[class*=\"text-gray-800\"]{color:var(--fg)}#navbar .nav-tabs-item>div[class*=\"bg-primary\"],#navbar .nav-tabs-item>span[class*=\"bg-primary\"]{background:var(--color-young-green)!important}#search-bar-entry,#search-bar-entry-mobile{background:var(--surface)!important;border:1px solid var(--surface-line);border-radius:999px;color:var(--label-fg);box-shadow:none!important;--tw-ring-color: transparent !important;filter:none!important}#search-bar-entry:hover{border-color:var(--color-dark-charcoal-40)}html.dark #search-bar-entry:hover{border-color:var(--ink-dim)}#search-bar-entry kbd{background:transparent;border:1px solid var(--surface-line);font-family:var(--font-mono)}#topbar-cta-button a{font-family:var(--font-ui);font-weight:500;letter-spacing:-0.01em}#topbar-cta-button a>span[class*=\"absolute\"]{background:var(--color-young-green)!important;border-radius:999px!important;opacity:1!important}#topbar-cta-button a:hover>span[class*=\"absolute\"]{background:var(--color-young-green-deep)!important}#topbar-cta-button a span[class*=\"text-white\"],#topbar-cta-button a svg{color:var(--color-dark-charcoal)!important}#sidebar{border-inline-end:1px solid var(--hairline)}.sidebar-group-header{padding-top:0.4rem;padding-bottom:0.4rem}#sidebar-content a,#sidebar-content button{font-family:var(--font-ui);border-radius:0!important}#sidebar-content a{color:var(--fg-3)}#sidebar-content a[aria-current=\"page\"],#sidebar-content a[aria-current=\"page\"]:hover,#sidebar-content a[aria-current=\"page\"]:focus{background:transparent!important;box-shadow:inset 3px 0 0 var(--color-young-green);color:var(--fg)!important;font-weight:500;text-shadow:none!important}#sidebar-content a:hover:not([aria-current=\"page\"]){background:transparent!important;color:var(--fg);box-shadow:inset 3px 0 0 var(--hairline)}#sidebar-content [class*=\"border-l\"],#sidebar-content ul ul{border-color:var(--hairline)}#table-of-contents-layout{border-inline-start:1px solid var(--hairline)}#table-of-contents a{font-family:var(--font-ui);color:var(--fg-3);text-shadow:none!important}#table-of-contents li[data-active]>a{color:var(--fg)!important;font-weight:500}#table-of-contents h2 button svg{color:var(--label-fg)}#page-context-menu>button,#page-context-menu>div>button{background:var(--surface)!important;border-color:var(--surface-line)!important;color:var(--fg);font:500 13px/1.2 var(--font-ui);letter-spacing:-0.01em}#page-context-menu>button:first-child{border-radius:999px 0 0 999px!important}#page-context-menu>:last-child,#page-context-menu>:last-child button{border-radius:0 999px 999px 0!important}#page-context-menu button:hover{border-color:var(--color-young-green-deep)!important}.code-block,.code-block [data-component-part=\"code-block-root\"],.code-block pre.shiki,.code-group{border-radius:0!important;box-shadow:none!important}.code-block{border:1px solid var(--ink-line);background-color:var(--ink)!important;--tw-ring-color: transparent !important}.code-block [data-component-part=\"code-block-root\"],.code-block pre.shiki,.code-block pre.shiki code{background-color:var(--ink)!important;--shiki-dark-bg: var(--ink) !important;color:var(--ink-fg)}.code-block pre.shiki,.code-block pre.shiki code,.code-block .font-mono{font-family:var(--font-mono)!important;font-size:0.85rem;line-height:1.65}.code-block pre.shiki ::selection{background:rgb(151 225 98 / 30%);color:inherit}.code-block [data-component-part=\"code-block-header\"],.code-group>div:first-child{background:var(--ink-2)!important;border-bottom:1px solid var(--ink-line);border-radius:0!important;color:var(--ink-muted);font:500 0.75rem/1.4 var(--font-ui)}.code-group [role=\"tab\"][aria-selected=\"true\"]{color:var(--ink-fg)!important;box-shadow:inset 0 2px 0 var(--color-young-green)}.code-block-copy-button button,.code-block [data-floating-buttons] button{border-radius:999px!important;background:var(--ink-2)!important;border:1px solid var(--ink-line);color:#c9ccc2!important}.code-block [data-floating-buttons] button:hover{border-color:var(--color-young-green-deep)}#ask-assistant-code-block-button{border-radius:999px!important}#content code:not(pre code),#header .prose code{font-family:var(--font-mono);font-size:0.86em;font-weight:500;color:var(--fg)!important;background:var(--inline-code-bg)!important;border:1px solid var(--surface-line);border-radius:4px;padding:0.1em 0.35em}#content code:not(pre code)::before,#content code:not(pre code)::after{content:none}#content .callout{position:relative;display:grid;grid-template-columns:16px minmax(0, 1fr);column-gap:0.55rem;row-gap:0.45rem;align-items:center;margin-block:1.25rem;padding:0.9rem 1.1rem 0.9rem 1.25rem;border:1px solid var(--aside-line)!important;border-inline-start:3px solid var(--aside-rule)!important;border-radius:0!important;background:var(--aside-bg)!important;color:var(--fg)!important;--aside-rule: var(--color-dark-teal);--aside-fg: var(--info-fg);--aside-bg: var(--info-bg);--aside-line: var(--info-line);--aside-glyph: \"i\";--aside-badge-fg: #fff}#content .callout[data-callout-type=\"tip\"],#content .callout[data-callout-type=\"check\"]{--aside-rule: var(--color-young-green-deep);--aside-fg: var(--ok-fg);--aside-bg: var(--ok-bg);--aside-line: var(--ok-line);--aside-glyph: \"✓\";--aside-badge-fg: var(--color-dark-charcoal)}#content .callout[data-callout-type=\"warning\"]{--aside-rule: #d99a2b;--aside-fg: var(--warn-fg);--aside-bg: var(--warn-bg);--aside-line: var(--warn-line);--aside-glyph: \"!\"}#content .callout[data-callout-type=\"danger\"]{--aside-rule: #c94c4c;--aside-fg: var(--err-fg);--aside-bg: var(--err-bg);--aside-line: var(--err-line);--aside-glyph: \"✕\"}#content .callout>[data-component-part=\"callout-icon\"]{grid-column:1;grid-row:1;width:16px;height:16px;margin:0;border-radius:999px;background:var(--aside-rule);color:var(--aside-badge-fg);font:700 10px/16px var(--font-ui);text-align:center}#content .callout>[data-component-part=\"callout-icon\"] svg{display:none}#content .callout>[data-component-part=\"callout-icon\"]::before{content:var(--aside-glyph)}#content .callout::before{content:attr(aria-label);grid-column:2;grid-row:1;font:600 10.5px/1.3 var(--font-mono);letter-spacing:0.08em;text-transform:uppercase;color:var(--aside-fg)}#content .callout>[data-component-part=\"callout-content\"]{grid-column:1 / -1;grid-row:2;color:var(--fg)!important;font-size:0.875rem;line-height:1.6}#content .callout a{color:var(--link-fg)!important;border-color:currentColor}#content .callout a:hover{color:var(--link-hover)!important}#content .callout strong{color:var(--fg)!important}#content .callout code:not(pre code){background:var(--surface)!important}#content .card,.card{position:relative;border-radius:0!important;background:var(--surface)!important;border:1px solid var(--surface-line)!important;box-shadow:none!important;--tw-ring-color: transparent !important;transition:border-color 0.15s}.card::before{content:\"\";position:absolute;top:10px;left:10px;width:5px;height:5px;background:var(--surface-line);z-index:1}.card:hover{border-color:var(--color-young-green-deep)!important}.card h2,.card h3,.card [class*=\"font-semibold\"]{font-family:var(--font-ui);font-weight:600;letter-spacing:-0.01em;color:var(--fg)}.card [data-component-part=\"card-icon\"] svg,.card svg[style*=\"mask\"]{background-color:var(--accent-text)}details.accordion,.accordion-group{border-radius:0!important;border:1px solid var(--surface-line)!important;background:var(--surface)!important;box-shadow:none!important}.accordion-group details.accordion{border:0!important;border-top:1px solid var(--surface-line)!important}.accordion-group details.accordion:first-child{border-top:0!important}details.accordion>summary{font:500 0.875rem/1.4 var(--font-ui);color:var(--fg);background:transparent!important}details.accordion>summary:hover{color:var(--link-hover)}details.accordion>summary [data-component-part=\"accordion-title\"]{font:inherit;color:inherit}details.accordion>summary [data-component-part=\"accordion-caret-right\"]{color:var(--color-young-green-deep)}details.accordion>summary::after{content:\"show\";margin-left:auto;font:600 10.5px/1 var(--font-mono);letter-spacing:0.08em;text-transform:uppercase;color:var(--label-fg)}details.accordion[open]>summary::after{content:\"hide\"}details.accordion[open]>summary{border-bottom:1px solid var(--surface-line)}details.accordion>[data-component-part=\"accordion-content\"]{padding-top:0.9rem}.tabs [role=\"tablist\"]{border-color:var(--hairline)!important}.tabs [data-component-part=\"tab-button\"]{font-family:var(--font-ui);font-weight:500;color:var(--fg-3)}.tabs [data-component-part=\"tab-button\"][data-active=\"true\"]{color:var(--fg)!important;border-color:var(--color-young-green)!important;border-bottom-width:2px}.steps [data-component-part=\"step-indicator\"]{background:var(--surface)!important;border:1px solid var(--surface-line);color:var(--fg)!important;font:600 11px/1 var(--font-mono)}.steps [data-component-part=\"step-line\"]{background:var(--hairline)!important}.steps [data-component-part=\"step-title\"]{font-family:var(--font-ui);font-weight:600;letter-spacing:-0.01em;color:var(--fg)!important}#content table{font-family:var(--font-ui);font-size:0.875rem;border-collapse:collapse}#content th,#content td{border:0;border-bottom:1px solid var(--hairline);padding:0.6rem 1rem 0.6rem 0;vertical-align:top}#content th{white-space:nowrap}#content tr:nth-child(2n){background:transparent}#content tbody tr:hover{background:transparent}.frame,#content img,.expandable,.tile{border-radius:0!important}.frame{background:var(--surface)!important;border:1px solid var(--surface-line)!important;box-shadow:none!important}#pagination{font-family:var(--font-ui);font-weight:500}#pagination [data-component-part=\"pagination-title\"]{color:var(--fg-3)}#pagination a:hover [data-component-part=\"pagination-title\"]{color:var(--fg)!important}.feedback-toolbar button,#feedback-thumbs-up,#feedback-thumbs-down{border-radius:999px!important;border:1px solid var(--surface-line);background:var(--surface);color:var(--fg-3)}.method-pill,.method-nav-pill{font-family:var(--font-mono);letter-spacing:0.04em;border-radius:999px!important}#footer{background:var(--bg-nav);border-top:1px solid var(--hairline)!important;font-family:var(--font-ui);position:relative;z-index:25}#footer .footer-inner>.h-px,#footer .footer-inner>[class*=\"h-[1px]\"]{display:none!important}#footer .footer-inner,footer .footer-inner{max-width:none!important;width:100%;padding-top:1.25rem!important;padding-bottom:1.25rem!important;gap:0!important}#footer .footer-divider,footer .footer-divider{display:none!important}#footer .footer-mintlify,footer .footer-mintlify{display:flex!important;flex-direction:row!important;align-items:center!important;justify-content:flex-end!important;gap:0.75rem!important;flex:0 0 auto!important;width:auto!important;min-width:0!important}#footer .footer-row,footer .footer-row{display:flex!important;flex-direction:row!important;flex-wrap:wrap;align-items:center!important;justify-content:flex-start!important;gap:1rem 1.5rem!important;width:100%}#footer .footer-row>:not(.audited-by),footer .footer-row>:not(.audited-by){flex:0 0 auto!important;min-width:0!important;max-width:none!important;width:auto!important}#footer .footer-row>:nth-child(3),footer .footer-row>:nth-child(3){margin-left:auto}.audited-by{display:flex;flex-wrap:nowrap;align-items:center;justify-content:flex-start;gap:0.75rem 1rem;flex:0 0 auto;width:auto;min-width:0;padding:0}.audited-by-label{font:600 10.5px/1.3 var(--font-mono);letter-spacing:0.08em;text-transform:uppercase;color:var(--label-fg);text-decoration:none;box-shadow:none}a.audited-by-label:hover{color:var(--fg);opacity:1}.audited-by a[data-auditor]{display:inline-flex;align-items:center;line-height:0;opacity:0.9;text-decoration:none;box-shadow:none}.audited-by a[data-auditor] button,.audited-by a[data-auditor]+button,.audited-by button{display:none}.audited-by a[data-auditor]:hover{opacity:1}.audited-by-logo{width:auto;max-width:none}.audited-by a[data-auditor=\"cantina\"] .audited-by-logo{height:22px}.audited-by a[data-auditor=\"cyfrin\"] .audited-by-logo{height:28px}.audited-by .logo-dark{display:none}.dark .audited-by .logo-light,[data-theme=\"dark\"] .audited-by .logo-light{display:none}.dark .audited-by .logo-dark,[data-theme=\"dark\"] .audited-by .logo-dark{display:block}.pay-timeline{--p1: 12.5%;--p2: 37.5%;--p3: 62.5%;--p4: 87.5%;--rail: var(--fg-dim);--dot-event: var(--fg);--dot-quote: var(--warn-fg);--dot-delivery: var(--err-fg);--bar-quote: var(--ok-fg);--bar-process: var(--warn-fg);--bar-settle: var(--info-fg);margin:1.25rem 0 1.5rem;padding:1.5rem 1.25rem 1.2rem;background:var(--surface);border:1px solid var(--surface-line);border-radius:16px}.pay-timeline-title{margin:0 0 1.75rem;text-align:center;font-family:var(--font-ui);font-size:1.05rem;font-weight:600;color:var(--fg)}.pay-timeline-stage{position:relative;height:196px}.pay-timeline-label,.pay-timeline-caption{position:absolute;margin:0;transform:translateX(-50%);text-align:center;font-family:var(--font-ui);font-weight:500;line-height:1.25}.pay-timeline-label{top:0;font-size:0.78rem;color:var(--fg-2)}.pay-timeline-label--1{left:var(--p1)}.pay-timeline-label--2{left:var(--p2)}.pay-timeline-label--3{left:var(--p3)}.pay-timeline-label--4{left:var(--p4)}.pay-timeline-guide{position:absolute;top:36px;bottom:52px;width:0;border-left:1px dashed var(--fg-dim)}.pay-timeline-guide--1{left:var(--p1)}.pay-timeline-guide--2{left:var(--p2);border-left-color:var(--dot-quote)}.pay-timeline-guide--3{left:var(--p3);border-left-color:var(--dot-delivery)}.pay-timeline-guide--4{left:var(--p4)}.pay-timeline-rail{position:absolute;top:70px;left:var(--p1);width:calc(var(--p4) - var(--p1));height:3px;background:var(--rail);border-radius:2px}.pay-timeline-dot{position:absolute;top:64px;z-index:2;width:14px;height:14px;border-radius:50%;transform:translateX(-50%);background:var(--dot-event)}.pay-timeline-dot--1{left:var(--p1)}.pay-timeline-dot--2{left:var(--p2);background:var(--dot-quote)}.pay-timeline-dot--3{left:var(--p3);background:var(--dot-delivery)}.pay-timeline-dot--4{left:var(--p4)}.pay-timeline-bar{position:absolute;top:92px;height:14px;border-radius:3px}.pay-timeline-bar--quote{left:var(--p1);width:calc(var(--p2) - var(--p1));background:var(--bar-quote)}.pay-timeline-bar--process{left:var(--p2);width:calc(var(--p3) - var(--p2));background:var(--bar-process)}.pay-timeline-bar--settle{left:var(--p3);width:calc(var(--p4) - var(--p3));background:var(--bar-settle)}.pay-timeline-caption{top:114px;font-size:0.75rem;color:var(--fg-3)}.pay-timeline-caption--quote{left:calc((var(--p1) + var(--p2)) / 2)}.pay-timeline-caption--process{left:calc((var(--p2) + var(--p3)) / 2)}.pay-timeline-caption--settle{left:calc((var(--p3) + var(--p4)) / 2)}.pay-timeline-note{margin:0.5rem 0 0;text-align:left;font-family:var(--font-ui);font-size:0.86rem;line-height:1.45;color:var(--fg-3)}.pay-timeline-note p{margin:0}.pay-timeline-note ul{margin:0.4rem 0 0;padding-left:1.15rem}.pay-timeline-note li{margin:0.35rem 0 0}.pay-timeline-note li:first-child{margin-top:0}.changelog-toc{margin:0.25rem 0 0.5rem 1.75rem;padding-left:0.75rem;border-left:1px solid var(--surface-line);list-style:none}.changelog-toc-date{margin:0.6rem 0 0.2rem;font-family:var(--font-ui);font-size:0.72rem;letter-spacing:0.04em;color:var(--fg-muted)}.changelog-toc-date:first-child{margin-top:0.2rem}.changelog-toc a{display:block;padding:0.2rem 0;font-size:0.82rem;line-height:1.35;color:var(--fg-2)}.changelog-toc a:hover{color:var(--accent-text)}.update-container [data-component-part=\"update-tag\"]{padding:0.1rem 0.55rem;border:1px solid var(--surface-line);border-radius:999px;font-family:var(--font-ui);font-size:0.78rem;white-space:nowrap;color:var(--fg-2);cursor:pointer;transition:border-color 120ms ease, color 120ms ease}.update-container [data-component-part=\"update-tag\"]:hover{border-color:var(--accent-text);color:var(--accent-text)}.update-container [data-component-part=\"update-tag\"][aria-pressed=\"true\"]{border-color:rgb(var(--primary));background:rgb(var(--primary));color:rgb(255 255 255 / 0.9)}.update-container [data-component-part=\"update-tag\"]:focus-visible{outline:none;box-shadow:var(--ring)}@media (min-width: 1280px){[class*=\"max-w-8xl\"]{max-width:1600px!important}body:has(#table-of-contents,#changelog-filters) #content-area{width:calc(100% - 20rem)!important;max-width:none!important}}#header :is(h1,p),#content :is(p,ul,ol,blockquote,h1,h2,h3,h4,h5,h6):not(td *,th *,li *){max-width:38em}@media (min-width: 1024px){.update-container>div:first-child{width:150px!important}}.update-container .prose-sm{font-size:1rem;line-height:1.75}"}],"page":{"pagePath":"api-reference/x402/settle","slug":"/api-reference/x402/settle","pageMetadata":{"title":"Settle payment","openapi":"POST /settle","description":"Submits the request to the Atum network for settlement and resolves synchronously within the requirement's maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\n","href":"/api-reference/x402/settle"},"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: \"Submits the request to the Atum network for settlement and resolves synchronously within the requirement’s maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":"github-dark"},"config":{},"pageMetadata":{"title":"Settle payment","openapi":"POST /settle","description":"Submits the request to the Atum network for settlement and resolves synchronously within the requirement's maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\n","href":"/api-reference/x402/settle"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/atumlabs/ea8598561a186193/audited-by.js","/_mintlify/custom/atumlabs/946086a3f73c7db3/webmcp.js","/_mintlify/custom/atumlabs/28a7e63cae1e14fd/changelog-tags.js","/_mintlify/custom/atumlabs/f97675e153f577c9/changelog-toc.js"],"openApiReferenceData":{"operation":{"operationId":"settle","summary":"Submit a validated payment for settlement.","description":"Submits the request to the Atum network for settlement and resolves synchronously within the requirement's maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\n","requestBody":"ef57581f-7a7d-4473-8a37-4836d37794bf","responses":{"200":"6671dd8a-59a1-4d29-a41c-729a729ce273"},"method":"post","type":"path","servers":["54e65463-5013-4d52-a7ca-69f105dfa616","ae093d88-3cba-4a77-8678-5e3f5ff8e60d"],"security":[],"path":"/settle","baseUrlOptions":["https://payment-gw.production-mainnet.atum.xyz/x402/v1","https://payment-gw.production-testnet.atum.xyz/x402/v1"],"title":"Submit a validated payment for settlement.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The shared request body for /verify and /settle.","required":["x402Version","paymentPayload","paymentRequirements"],"properties":{"x402Version":{"type":"integer","const":2,"isRequired":true,"uniqueKey":"x402Version","typeLabel":"integer"},"paymentPayload":{"title":"AtumEscrowPayload","description":"The payer's signed credential. Its payload.paymentRequest conforms to the canonical PaymentRequest declaration and carries the PaymentRequestEnvelope (PRE) identity binding.\n","type":"object","additionalProperties":true,"required":["x402Version","accepted","payload"],"properties":{"x402Version":{"const":2,"description":"x402 protocol version; always 2.","isRequired":true,"uniqueKey":"paymentPayload.x402Version","typeLabel":"any"},"accepted":{"type":"object","additionalProperties":true,"description":"Echo of the selected 402 requirement, checked for equality against the separately-supplied requirement at verify time.","required":["scheme","network","asset","payTo","amount","maxTimeoutSeconds","extra"],"properties":{"scheme":{"const":"atum-escrow","isRequired":true,"uniqueKey":"paymentPayload.accepted.scheme","typeLabel":"any"},"network":{"type":"string","pattern":"^[-a-z0-9]+:.+$","isRequired":true,"uniqueKey":"paymentPayload.accepted.network","typeLabel":"string"},"asset":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","isRequired":true,"uniqueKey":"paymentPayload.accepted.asset","typeLabel":"string"},"payTo":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","isRequired":true,"uniqueKey":"paymentPayload.accepted.payTo","typeLabel":"string"},"amount":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"paymentPayload.accepted.amount","typeLabel":"string"},"maxTimeoutSeconds":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"paymentPayload.accepted.maxTimeoutSeconds","typeLabel":"integer"},"extra":{"type":"object","required":["atum"],"properties":{"atum":{"type":"object","isRequired":true,"uniqueKey":"paymentPayload.accepted.extra.atum","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentPayload.accepted.extra","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentPayload.accepted","typeLabel":"object"},"payload":{"type":"object","additionalProperties":false,"required":["paymentRequest"],"properties":{"paymentRequest":{"type":"object","additionalProperties":true,"description":"The signed payment request; conforms to the canonical PaymentRequest declaration (declarations/PaymentRequest/v1). Only the scheme-critical fields the facilitator checks are required here, the rest is permitted.","required":["version","request_id","source","destination","fulfillment_amount","max_source_amount","quote_deadline","fulfillment_deadline","sender_auth"],"properties":{"version":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.version","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.request_id","typeLabel":"string"},"source":{"type":"object","additionalProperties":true,"required":["asset_identifier","account"],"properties":{"asset_identifier":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.source.asset_identifier","typeLabel":"string"},"account":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.source.account","typeLabel":"string"}},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.source","typeLabel":"object"},"destination":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["asset_identifier","account"],"properties":{"asset_identifier":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.destination.items.[INDEX].asset_identifier","typeLabel":"string"},"account":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.destination.items.[INDEX].account","typeLabel":"string"}},"uniqueKey":"paymentPayload.payload.paymentRequest.destination.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.destination","typeLabel":"object[]"},"fulfillment_amount":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.fulfillment_amount","typeLabel":"string"},"max_source_amount":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.max_source_amount","typeLabel":"string"},"quote_deadline":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.quote_deadline","typeLabel":"string\u003cdate-time>"},"fulfillment_deadline":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.fulfillment_deadline","typeLabel":"string\u003cdate-time>"},"sender_auth":{"type":"object","additionalProperties":true,"required":["message_scheme","signed_messages"],"properties":{"message_scheme":{"enum":["EVM_PERMIT2","EVM_PERMIT2_ESCROW","SOLANA","TRON"],"description":"Sender-auth signature scheme. Wire-valid values mirror the canonical PaymentRequest SenderAuthMessageScheme; which of them a given facilitator actually verifies is a capability the facilitator enforces, not a schema constraint.","type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.message_scheme","typeLabel":"enum\u003cstring>"},"signed_messages":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["message","signature"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.signed_messages.items.[INDEX].message","typeLabel":"string"},"signature":{"type":"string","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.signed_messages.items.[INDEX].signature","typeLabel":"string"},"message_prehash":{"oneOf":[{}],"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.signed_messages.items.[INDEX].message_prehash","typeLabel":"any"}},"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.signed_messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth.signed_messages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.sender_auth","typeLabel":"object"},"presentation":{"type":"object","additionalProperties":true,"description":"Identity binding — a holder-signed W3C VerifiablePresentation (PaymentRequestEnvelope; conforms to declarations/PaymentRequestEnvelope/v1) that binds this request to the payer. REQUIRED for atum-escrow conformance; optional at the schema level so a request may be validated before the envelope is attached. Only the binding-critical fields are constrained here; the full envelope validates against the canonical declaration. The facilitator re-verifies it: proofPurpose 'authentication', proof.challenge equals the request's request_hash (content hash of the request), proof.domain the network-wide verifier id, and holder equal to source.account.","required":["type","holder","verifiableCredential","proof"],"properties":{"type":{"type":"array","description":"MUST contain 'VerifiablePresentation' per W3C VC Data Model v1.1.","contains":{"const":"VerifiablePresentation"},"items":{"type":"string","uniqueKey":"paymentPayload.payload.paymentRequest.presentation.type.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.type","typeLabel":"string[]"},"holder":{"type":"string","pattern":"^did:pkh:[a-z][a-z0-9]*:[a-zA-Z0-9._:%-]+$","description":"did:pkh of the payer; MUST equal source.account.","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.holder","typeLabel":"string"},"verifiableCredential":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.verifiableCredential.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.verifiableCredential","typeLabel":"object[]"},"proof":{"type":"object","additionalProperties":true,"required":["proofPurpose","challenge","domain"],"properties":{"proofPurpose":{"const":"authentication","description":"Always 'authentication' for a VerifiablePresentation proof.","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.proof.proofPurpose","typeLabel":"any"},"challenge":{"type":"string","minLength":1,"description":"Equals the request's request_hash (content hash of the request).","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.proof.challenge","typeLabel":"string"},"domain":{"type":"string","minLength":1,"description":"Network-wide verifier identifier, did:web:\u003cenv>.atum.xyz.","isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.proof.domain","typeLabel":"string"}},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest.presentation.proof","typeLabel":"object"}},"uniqueKey":"paymentPayload.payload.paymentRequest.presentation","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentPayload.payload.paymentRequest","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentPayload.payload","typeLabel":"object"},"extensions":{"type":"object","additionalProperties":true,"description":"x402 extension data, echoed from the `extensions` map the resource server advertised in its 402 response with the payer's own values added. Per the x402 specification a client must include at least the information it received and may append to it, but may not remove or overwrite it. Kept open so that extensions unrelated to this scheme pass through untouched.\n\nThe `atum-escrow` scheme uses the standard `payment-identifier` extension as the payment's idempotency key. It is REQUIRED for atum-escrow conformance but optional at the schema level, so that a payload can be validated before its extensions are attached; the facilitator enforces its presence and re-derives `request_id` from it.","properties":{"payment-identifier":{"type":"object","additionalProperties":true,"description":"The payment's idempotency key, as defined by the x402 payment-identifier extension.","properties":{"info":{"type":"object","$comment":"additionalProperties is deliberately left IMPLICIT here rather than stated as `true`, even though the surrounding objects state it. Both mean the same thing to a validator, but go-jsonschema emits an UnmarshalJSON for an open object that also carries a constrained property which references an undeclared `raw` variable, so the generated Go package does not compile. It only declares `raw` for an object with required properties, and this one has none. `id`'s length and pattern constraints are worth more than the generated AdditionalProperties convenience field, so the constraints stay and the keyword goes.","description":"The extension's data. The resource server advertises `required`; the payer adds `id`.","properties":{"required":{"type":"boolean","description":"Whether the resource server requires payers to supply an identifier. Always true for atum-escrow, which cannot make a payment retry-safe without one.","uniqueKey":"paymentPayload.extensions.payment-identifier.info.required","typeLabel":"boolean"},"id":{"type":"string","minLength":16,"maxLength":128,"pattern":"^[a-zA-Z0-9_-]+$","description":"The payer's identifier for the purchase being paid for: one value per purchase, the same value on every re-attempt of that purchase, and never shared between two purchases. `request_id` is derived from this value together with the source account, and the network de-duplicates on `request_id` — so reusing it on a re-attempt resolves to the original payment instead of taking a second one, while a fresh value starts a new payment.","uniqueKey":"paymentPayload.extensions.payment-identifier.info.id","typeLabel":"string"}},"uniqueKey":"paymentPayload.extensions.payment-identifier.info","typeLabel":"object"}},"uniqueKey":"paymentPayload.extensions.payment-identifier","typeLabel":"object"}},"uniqueKey":"paymentPayload.extensions","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentPayload","typeLabel":"AtumEscrowPayload · object"},"paymentRequirements":{"type":"object","description":"The single requirement the payer selected from the 402.","required":["scheme","network","asset","payTo","amount","maxTimeoutSeconds","extra"],"properties":{"scheme":{"type":"string","const":"atum-escrow","isRequired":true,"uniqueKey":"paymentRequirements.scheme","typeLabel":"string"},"network":{"type":"string","description":"CAIP-2 source chain id.","isRequired":true,"uniqueKey":"paymentRequirements.network","typeLabel":"string"},"asset":{"type":"string","description":"Source token contract address.","isRequired":true,"uniqueKey":"paymentRequirements.asset","typeLabel":"string"},"payTo":{"type":"string","description":"Source-chain escrow contract address.","isRequired":true,"uniqueKey":"paymentRequirements.payTo","typeLabel":"string"},"amount":{"type":"string","description":"Advisory source spend cap in atomic units.","isRequired":true,"uniqueKey":"paymentRequirements.amount","typeLabel":"string"},"maxTimeoutSeconds":{"type":"integer","minimum":1,"description":"Relative bound on the synchronous settlement hold.","isRequired":true,"uniqueKey":"paymentRequirements.maxTimeoutSeconds","typeLabel":"integer"},"extra":{"type":"object","required":["atum"],"properties":{"atum":{"title":"AtumEscrowExtra","description":"The `extra.atum` object carried inside an atum-escrow x402 PaymentRequirements entry (accepts[]): the merchant's receive-side plus the contract/role addresses and deadline budgets. Scheme-specific data the standard x402 `extra` bag treats as opaque, so it is owned here and shared by all role mechanisms. Addresses are chain-general: an EVM `0x`-hex address (20 bytes) or a base58-encoded address (Solana/Tron), per the field's CAIP-2 chain.","type":"object","additionalProperties":false,"required":["destination","fulfillmentAmount","escrow","fulfillmentProxy","reserver","releaser","fulfillmentVerifierEndpoint","quoteDeadlineSeconds","fulfillmentDeadlineSeconds"],"properties":{"destination":{"type":"object","additionalProperties":false,"description":"Where the merchant receives (CAIP-2 chain, token, address).","required":["network","asset","address"],"properties":{"network":{"type":"string","pattern":"^[-a-z0-9]+:.+$","description":"CAIP-2 destination chain id (e.g. eip155:42161).","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.destination.network","typeLabel":"string"},"asset":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Destination token contract address (EVM hex or base58, per the destination chain).","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.destination.asset","typeLabel":"string"},"address":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Merchant receive address (EVM hex or base58, per the destination chain).","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.destination.address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.destination","typeLabel":"object"},"fulfillmentAmount":{"type":"string","pattern":"^[0-9]+$","description":"Exact amount the merchant receives, in atomic token units.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.fulfillmentAmount","typeLabel":"string"},"escrow":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Source-chain escrow contract (the x402 payTo); EVM hex or base58, per the source chain.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.escrow","typeLabel":"string"},"fulfillmentProxy":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Destination-chain fulfillment proxy contract (EVM hex or base58, per the destination chain).","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.fulfillmentProxy","typeLabel":"string"},"reserver":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Atum reserver role address (escrow deposit witness); EVM hex or base58, per the source chain.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.reserver","typeLabel":"string"},"releaser":{"type":"string","pattern":"^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$","description":"Atum releaser role address (escrow deposit witness); EVM hex or base58, per the source chain.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.releaser","typeLabel":"string"},"fulfillmentVerifierEndpoint":{"type":"string","format":"uri","description":"Source-chain fulfillment-verifier endpoint the payment request carries. The verifier account and the quote_selector are the releaser and reserver respectively (the network derives the deposit witness roles from them), so only the endpoint is not otherwise present in this object.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.fulfillmentVerifierEndpoint","typeLabel":"string\u003curi>"},"quoteDeadlineSeconds":{"type":"integer","minimum":1,"description":"Recommended quote-deadline budget in seconds, relative to signing time.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.quoteDeadlineSeconds","typeLabel":"integer"},"fulfillmentDeadlineSeconds":{"type":"integer","minimum":1,"description":"Recommended fulfillment-deadline budget in seconds, relative to signing time.","isRequired":true,"uniqueKey":"paymentRequirements.extra.atum.fulfillmentDeadlineSeconds","typeLabel":"integer"},"svmSignatureClusterId":{"type":"string","description":"Solana source only: cluster name used to build the 32-byte cluster_id in the V3 escrow signature domain. Optional; the facilitator requires it for a Solana source.","uniqueKey":"paymentRequirements.extra.atum.svmSignatureClusterId","typeLabel":"string"},"svmSignatureDomainVersion":{"type":"integer","minimum":1,"maximum":255,"description":"Solana source only: escrow signature-domain version (V3 domain separation). Optional; required for a Solana source.","uniqueKey":"paymentRequirements.extra.atum.svmSignatureDomainVersion","typeLabel":"integer"},"depositRequestHashVersions":{"type":"array","items":{"type":"integer","minimum":1,"uniqueKey":"paymentRequirements.extra.atum.depositRequestHashVersions.items.[INDEX]","typeLabel":"integer"},"minItems":1,"uniqueItems":true,"description":"The depositRequestHash versions the payer may sign for this source: 1 is keccak256 of the request_id, 2 is the hash of the payment terms. Absent means [1]. A client signs 2 when the list contains it and 1 otherwise. A client or facilitator that predates this field refuses a requirement carrying it, even [1], so a resource server publishes it only once its payers and its facilitator run a release that knows it, and lists 2 only once the payment gateway's GET /v1/defaults returns deposit_request_hash_version 2 for the source chain, the network-wide signal that every reader of the deposit reads version 2.","uniqueKey":"paymentRequirements.extra.atum.depositRequestHashVersions","typeLabel":"integer[]"}},"isRequired":true,"uniqueKey":"paymentRequirements.extra.atum","typeLabel":"AtumEscrowExtra · object"}},"isRequired":true,"uniqueKey":"paymentRequirements.extra","typeLabel":"object"}},"isRequired":true,"uniqueKey":"paymentRequirements","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"x402Version":2,"paymentPayload":{"x402Version":2,"accepted":{"scheme":"atum-escrow","network":"\u003cstring>","asset":"\u003cstring>","payTo":"\u003cstring>","amount":"\u003cstring>","maxTimeoutSeconds":2,"extra":{"atum":{}}},"payload":{"paymentRequest":{"version":"\u003cstring>","request_id":"\u003cstring>","source":{"asset_identifier":"\u003cstring>","account":"\u003cstring>"},"destination":[{"asset_identifier":"\u003cstring>","account":"\u003cstring>"}],"fulfillment_amount":"\u003cstring>","max_source_amount":"\u003cstring>","quote_deadline":"2023-11-07T05:31:56Z","fulfillment_deadline":"2023-11-07T05:31:56Z","sender_auth":{"signed_messages":[{"message":"\u003cstring>","signature":"\u003cstring>","message_prehash":"\u003cunknown>"}]}}},"extensions":{"payment-identifier":{"info":{"required":true,"id":"\u003cstring>"}}}},"paymentRequirements":{"scheme":"atum-escrow","network":"\u003cstring>","asset":"\u003cstring>","payTo":"\u003cstring>","amount":"\u003cstring>","maxTimeoutSeconds":2,"extra":{"atum":{"destination":{"network":"\u003cstring>","asset":"\u003cstring>","address":"\u003cstring>"},"fulfillmentAmount":"\u003cstring>","escrow":"\u003cstring>","fulfillmentProxy":"\u003cstring>","reserver":"\u003cstring>","releaser":"\u003cstring>","fulfillmentVerifierEndpoint":"\u003cstring>","quoteDeadlineSeconds":2,"fulfillmentDeadlineSeconds":2,"svmSignatureClusterId":"\u003cstring>","svmSignatureDomainVersion":128,"depositRequestHashVersions":[2]}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6671dd8a-59a1-4d29-a41c-729a729ce273":{"description":"The synchronous settlement result.","content":{"application/json":{"schema":{"type":"object","description":"The synchronous settlement result — the standard x402 SettleResponse fields plus the Atum settlement receipt.\n","required":["success","transaction","network"],"properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"transaction":{"type":"string","description":"Destination settlement transaction hash.","isRequired":true,"uniqueKey":"transaction","typeLabel":"string"},"network":{"type":"string","description":"CAIP-2 destination chain id.","isRequired":true,"uniqueKey":"network","typeLabel":"string"},"payer":{"type":"string","uniqueKey":"payer","typeLabel":"string"},"errorReason":{"type":"string","description":"Present when success is false.","uniqueKey":"errorReason","typeLabel":"string"},"extensions":{"type":"object","description":"Facilitator-specific members. See AtumExtension for the atum one.","properties":{"atum":{"type":"object","description":"What this facilitator has to say beyond the standard members. It rides under `extensions.atum` rather than beside `errorReason` because the x402 response shape is fixed by the specification and `extensions` is what it provides for a facilitator with something of its own to add. A client that does not know the member ignores it.\n","properties":{"paymentId":{"type":"string","description":"The Atum payment this answer is about. Present only once the network has named one, because a merchant correlates its fulfilment against it and an id-shaped blank correlates against nothing.\n","uniqueKey":"extensions.atum.paymentId","typeLabel":"string"},"state":{"type":"string","description":"The payment's state as the network last reported it.","uniqueKey":"extensions.atum.state","typeLabel":"string"},"statusUrl":{"type":"string","description":"Where to poll the payment, when a public origin is configured.","uniqueKey":"extensions.atum.statusUrl","typeLabel":"string"},"retryClassification":{"type":"string","description":"What the merchant should do about the reason alongside it, drawn from the same closed set Atum's own error responses use. Without it a merchant reading `errorReason` or `invalidReason` has a label and no instruction.\n\nPresent on every answer that is not a success, including the refusals that name no payment. Absent on a success: there is nothing to retry.\n\nA pattern-constrained string rather than an enum, so a client whose generated model closes the set does not reject the whole response on a value added later.\n","pattern":"^[A-Z][A-Z0-9_]*$","example":"NOT_RETRYABLE_FIX_REQUEST","uniqueKey":"extensions.atum.retryClassification","typeLabel":"string"}},"uniqueKey":"extensions.atum","typeLabel":"object"}},"uniqueKey":"extensions","typeLabel":"object"},"fulfillmentConfirmation":{"type":"object","additionalProperties":true,"description":"Full settlement receipt, which may be present once the payment is completed; also returned to the payer in PAYMENT-RESPONSE.","uniqueKey":"fulfillmentConfirmation","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"transaction":"\u003cstring>","network":"\u003cstring>","payer":"\u003cstring>","errorReason":"\u003cstring>","extensions":{"atum":{"paymentId":"\u003cstring>","state":"\u003cstring>","statusUrl":"\u003cstring>","retryClassification":"NOT_RETRYABLE_FIX_REQUEST"}},"fulfillmentConfirmation":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"54e65463-5013-4d52-a7ca-69f105dfa616":{"url":"https://payment-gw.production-mainnet.atum.xyz/x402/v1","description":"Mainnet"},"ae093d88-3cba-4a77-8678-5e3f5ff8e60d":{"url":"https://payment-gw.production-testnet.atum.xyz/x402/v1","description":"Testnet"}}},"originalFileLocation":"api-reference/x402/openapi.yaml"},"subdomain":"atumlabs","siteName":"Atum Docs","title":"Settle payment - Atum Docs","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T14:09:23.901Z","originalFileLocation":"api-reference/x402/settle.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=\"dark\"}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=\"Submits the request to the Atum network for settlement and resolves synchronously within the requirement\u0026#x27;s maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Atum Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_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/atumlabs/Pqh0GSDdyRfy-YKa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Settle payment - Atum Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits the request to the Atum network for settlement and resolves synchronously within the requirement\u0026#x27;s maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Atum Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.atum.xyz/api-reference/x402/settle\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://atumlabs.mintlify.site/_mintlify/api/og/v2?division=x402+Facilitator\u0026amp;title=Settle+payment\u0026amp;description=Submits+the+request+to+the+Atum+network+for+settlement+and+resolves+synchronously+within+the+requirement%27s+maxTimeoutSeconds%3A+once+the+payout+to+the+recipient+i\u0026amp;theme=2455e481a76f39e16fb336fe\u0026amp;signature=a1c09213e22c965370b3b0e4215b7bd15f75f4c0cbda11b2e0e657ee1e0d8037\">\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=\"Settle payment - Atum Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits the request to the Atum network for settlement and resolves synchronously within the requirement\u0026#x27;s maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://atumlabs.mintlify.site/_mintlify/api/og/v2?division=x402+Facilitator\u0026amp;title=Settle+payment\u0026amp;description=Submits+the+request+to+the+Atum+network+for+settlement+and+resolves+synchronously+within+the+requirement%27s+maxTimeoutSeconds%3A+once+the+payout+to+the+recipient+i\u0026amp;theme=2455e481a76f39e16fb336fe\u0026amp;signature=a1c09213e22c965370b3b0e4215b7bd15f75f4c0cbda11b2e0e657ee1e0d8037\">\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/atumlabs/Pqh0GSDdyRfy-YKa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Atum Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#24450d\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.atum.xyz/api-reference/x402/settle\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/x402/settle.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.atum.xyz/#organization\",\"name\":\"Atum Docs\",\"url\":\"https://docs.atum.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/atumlabs/eBwMdhd0uJ6cwbY0/images/assets/wordmark-light.svg?fit=max\u0026auto=format\u0026n=eBwMdhd0uJ6cwbY0\u0026q=85\u0026s=6ba7458a7e4528e698e48cbf8e15c375\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.atum.xyz#website\",\"name\":\"Atum Docs\",\"url\":\"https://docs.atum.xyz\",\"publisher\":{\"@id\":\"https://docs.atum.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.atum.xyz/api-reference/x402/settle#webpage\",\"url\":\"https://docs.atum.xyz/api-reference/x402/settle\",\"name\":\"Settle payment\",\"description\":\"Submits the request to the Atum network for settlement and resolves synchronously within the requirement's maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\",\"dateModified\":\"2026-10-23T14:09:23.901Z\",\"isPartOf\":{\"@id\":\"https://docs.atum.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.atum.xyz/api-reference/x402/settle#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.atum.xyz/api-reference/x402/settle#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"x402 Facilitator\",\"item\":\"https://docs.atum.xyz/api-reference/x402/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Settle payment\",\"item\":\"https://docs.atum.xyz/api-reference/x402/settle\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.atum.xyz/api-reference/x402/settle#apireference\",\"headline\":\"Settle payment\",\"name\":\"Settle payment\",\"description\":\"Submits the request to the Atum network for settlement and resolves synchronously within the requirement's maxTimeoutSeconds: once the payout to the recipient is on chain, or once it is final when the facilitator is configured to wait for that. Returns the settlement transaction and network; extensions.atum.state says whether the payment is finalizing (on chain, not yet final) or completed. Asynchronous settlement beyond the synchronous window is a deferred extension.\",\"url\":\"https://docs.atum.xyz/api-reference/x402/settle\",\"mainEntityOfPage\":{\"@id\":\"https://docs.atum.xyz/api-reference/x402/settle#webpage\"},\"dateModified\":\"2026-10-23T14:09:23.901Z\",\"publisher\":{\"@id\":\"https://docs.atum.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.atum.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Atum Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Atum Docs","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":"/get-started/overview/what-is-atum"}]},{"tab":"Payment protocols","icon":"route","pages":[{"title":"Payment protocols","href":"/payment-protocols/overview"}]},{"tab":"Settle payments","icon":"handshake","pages":[{"title":"Settle payments","href":"/settle-payments/what-is-an-atum-settlement"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Introduction","pages":[{"title":"API Reference","sidebarTitle":"Overview","icon":"code","href":"/api-reference/overview"},{"title":"auth.md","sidebarTitle":"How agents authenticate","hidden":true,"href":"/auth"},{"title":"Idempotency","sidebarTitle":"Idempotency","icon":"arrows-rotate","href":"/api-reference/idempotency"}]},{"group":"Error handling","icon":"circle-exclamation","pages":[{"title":"Error codes","icon":"circle-exclamation","href":"/errors"},{"title":"Decline reasons","icon":"hand","href":"/decline-reasons"}]},{"group":"Payment Gateway","pages":[{"title":"Overview","href":"/api-reference/payment-gateway/introduction"},{"title":"Submit payment request","openapi":"POST /v1/payments","href":"/api-reference/payment-gateway/submit-payment"},{"title":"Get payment status","openapi":"GET /v1/payments/{paymentId}/status","href":"/api-reference/payment-gateway/get-payment-status"},{"title":"Resolve a payment request","openapi":"GET /v1/payments/resolve","href":"/api-reference/payment-gateway/resolve-payment"},{"title":"Get payment timeline","openapi":"GET /v1/payments/{paymentId}/timeline","href":"/api-reference/payment-gateway/payment-timeline"},{"title":"Create a quote-request","openapi":"POST /v1/payments/quote-requests","href":"/api-reference/payment-gateway/create-quote-request"},{"title":"Get quote-request status","openapi":"GET /v1/payments/quote-requests/{quoteRequestId}","href":"/api-reference/payment-gateway/quote-request-status"},{"title":"Get chain defaults","openapi":"GET /v1/defaults","href":"/api-reference/payment-gateway/chain-defaults"}]},{"group":"x402 Facilitator","pages":[{"title":"Overview","href":"/api-reference/x402/introduction"},{"title":"Verify payment","openapi":"POST /verify","description":"Checks the credential against the selected requirement: the PaymentRequestEnvelope identity binding (a holder-signed verifiable presentation whose proofPurpose is 'authentication', whose proof.challenge equals the request's request_hash, whose proof.domain is the network-wide verifier id, and whose holder equals source.account), the Permit2 sender authorization, escrow terms, that destination and fulfillment amount equal the requirement's, and that the signed source cap does not exceed the advertised amount. Does not move funds.\n","href":"/api-reference/x402/verify"},{"title":"Settle payment","openapi":"POST /settle","href":"/api-reference/x402/settle"},{"title":"Supported kinds","openapi":"GET /supported","description":null,"href":"/api-reference/x402/supported"}]},{"group":"Veri-Fill","pages":[{"title":"Veri-Fill API","sidebarTitle":"Overview","href":"/api-reference/veri-fill/introduction"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Settle payment - Atum Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}