Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.
Protected. Send either Authorization: Bearer <jwt_token> or x-api-key: <api_key>. In sandbox, also send x-feature: decision-engine.For local development, start with:
Body: JSON body with merchantId, paymentId, gateway and status, plus optional gatewayReferenceId, enforceDynamicRoutingFailure, txnLatency, errorInfo and isSmartRetry.
status must be a transaction status value - CHARGED, AUTHORIZATION_FAILED,
AUTHENTICATION_FAILED, JUSPAY_DECLINED, FAILURE, and so on. Lowercase values such as
success are rejected with a 400.Payment attributes (amount, currency, payment method, auth type) are not part of this
payload - the engine already has them from the /decide-gateway call for this paymentId.
Any unrecognised field is silently ignored, so a misspelled key fails quietly rather than
erroring. Note in particular that latency goes in txnLatency.gatewayLatency, not latency.
When errorInfo is supplied in the request and matches a gateway status map rule, the response
also carries a gsm_info object describing the lookup result.
Gateway error details for the GSM-based scoring filter. When present and the merchant flag is on, user/issuer-originated failures are skipped so the gateway is not penalised.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperswitch","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa","dark":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/dark.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=ba1e1063c50d5e3e6814ac1394cbe0bd"},"favicon":"https://mintcdn.com/juspay-78/lgBtlsxwQg1XCgqU/favicon.png?fit=max\u0026auto=format\u0026n=lgBtlsxwQg1XCgqU\u0026q=85\u0026s=1e2ff54d240ff03d1e663390917f2fb6","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml","decision_engine_openapi-specs.json"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://inviter.co/hyperswitch-slack","label":"Contact Us"},{"href":"https://deepwiki.com/juspay/hyperswitch","label":"Explore with Deepwiki"}],"primary":{"type":"button","label":"Self-Deploy","href":"https://docs.hyperswitch.io/self-hosting"}},"footer":{"socials":{"github":"https://github.com/juspay/hyperswitch","linkedin":"https://www.linkedin.com/company/hyperswitch"}},"integrations":{"gtm":{"tagId":"GTM-PLBNKQFQ"},"mixpanel":{"projectToken":"b00355f29d9548d1333608df71d5d53d"}},"contextual":{"options":["copy","claude","chatgpt","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"juspay-78","hasAudioNarration":false,"actualSubdomain":"juspay-78","customDomains":["api-reference.hyperswitch.io"],"gitSource":{"type":"github","owner":"juspay","repo":"hyperswitch","deployBranch":"main","contentDirectory":"api-reference","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb46dcba699f216aba4c6c","collectionId":"51fce505-0507-4821-9223-e2a5a328dfeb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb46dcba699f216aba4c6c"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb46dcba699f216aba4c6c","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":225},{"language":"default","tag":"Decision Engine API Reference","count":119},{"language":"default","tag":"Payments Core APIs","count":68},{"language":"default","tag":"API Examples (curl flows)","count":43},{"language":"default","tag":"Other APIs","count":42},{"language":"default","tag":"Payments Core APIs [BETA]","count":33},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Payments","count":27},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payment Methods","count":24}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore","slug":"/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore","pageMetadata":{"title":"Update Gateway Score","description":"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.","openapi":"decision_engine_openapi-specs.json POST /update-gateway-score","href":"/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore"},"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: \"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`update-gateway-score`,children:`Update Gateway Score`}),`\n`,_jsx(Heading,{level:`2`,id:`use-case`,children:`Use case`}),`\n`,_jsx(_components.p,{children:`Records the observed transaction outcome for a previously selected gateway so auth-rate analytics can learn from real payment results.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Protected. Send either `,_jsx(_components.code,{children:`Authorization: Bearer \u003cjwt_token>`}),` or `,_jsx(_components.code,{children:`x-api-key: \u003capi_key>`}),`. In sandbox, also send `,_jsx(_components.code,{children:`x-feature: decision-engine`}),`.`]}),`\n`,_jsx(_components.p,{children:`For local development, start with:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` BASE_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`http`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`://`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`localhost`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`8080`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` AUTH_HEADER`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer \u003cjwt_token>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Sandbox only:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# export BASE_URL=https://sandbox.hyperswitch.io`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# export FEATURE_HEADER=\"x-feature: decision-engine\"`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Method and path: `,_jsx(_components.code,{children:`POST /update-gateway-score`})]}),`\n`,_jsx(_components.li,{children:`Parameters: none.`}),`\n`,_jsxs(_components.li,{children:[`Body: JSON body with `,_jsx(_components.code,{children:`merchantId`}),`, `,_jsx(_components.code,{children:`paymentId`}),`, `,_jsx(_components.code,{children:`gateway`}),` and `,_jsx(_components.code,{children:`status`}),`, plus optional `,_jsx(_components.code,{children:`gatewayReferenceId`}),`, `,_jsx(_components.code,{children:`enforceDynamicRoutingFailure`}),`, `,_jsx(_components.code,{children:`txnLatency`}),`, `,_jsx(_components.code,{children:`errorInfo`}),` and `,_jsx(_components.code,{children:`isSmartRetry`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(Heading,{level:`3`,id:`update-gateway-score-2`,children:`Update gateway score`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --location`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$BASE_URL`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/update-gateway-score\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$AUTH_HEADER`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"merchantId\": \"merchant_demo\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"paymentId\": \"pay_sr_001\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"gateway\": \"stripe\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\": \"CHARGED\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"gatewayReferenceId\": \"stripe_ref_001\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"enforceDynamicRoutingFailure\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"txnLatency\": { \"gatewayLatency\": 120.5 }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`status`}),` must be a transaction status value - `,_jsx(_components.code,{children:`CHARGED`}),`, `,_jsx(_components.code,{children:`AUTHORIZATION_FAILED`}),`,\n`,_jsx(_components.code,{children:`AUTHENTICATION_FAILED`}),`, `,_jsx(_components.code,{children:`JUSPAY_DECLINED`}),`, `,_jsx(_components.code,{children:`FAILURE`}),`, and so on. Lowercase values such as\n`,_jsx(_components.code,{children:`success`}),` are rejected with a 400.`]}),`\n`,_jsxs(_components.p,{children:[`Payment attributes (amount, currency, payment method, auth type) are `,_jsx(_components.strong,{children:`not`}),` part of this\npayload - the engine already has them from the `,_jsx(_components.code,{children:`/decide-gateway`}),` call for this `,_jsx(_components.code,{children:`paymentId`}),`.\nAny unrecognised field is silently ignored, so a misspelled key fails quietly rather than\nerroring. Note in particular that latency goes in `,_jsx(_components.code,{children:`txnLatency.gatewayLatency`}),`, not `,_jsx(_components.code,{children:`latency`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,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:`6`,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:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Gateway score updated successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"merchant_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"merchant_demo\"`}),_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:` \"gateway\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"stripe\"`}),_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:` \"payment_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pay_sr_001\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`errorInfo`}),` is supplied in the request and matches a gateway status map rule, the response\nalso carries a `,_jsx(_components.code,{children:`gsm_info`}),` object describing the lookup result.`]}),`\n`,_jsx(Heading,{level:`2`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Do not call this after `,_jsx(_components.code,{children:`NTW_BASED_ROUTING`}),` just to record the selected debit network; debit audit comes from `,_jsx(_components.code,{children:`/decide-gateway`}),` analytics.`]}),`\n`,_jsx(_components.li,{children:`Call it after payment authorization completes, not before.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/decision-engine-api-reference/api-reference/endpoint/gateway-decision/decideGateway`,children:`Decide Gateway`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsGatewayScores`,children:`Analytics Gateway Scores`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/decision-engine-api-reference/api-reference/guides/feedback-scoring/update-gateway-score`,children:`Update Gateway Score`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Gateway Score","description":"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.","openapi":"decision_engine_openapi-specs.json POST /update-gateway-score","href":"/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Update Gateway Score","slug":"update-gateway-score","depth":1,"children":[]},{"title":"Use case","slug":"use-case","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[{"title":"Update gateway score","slug":"update-gateway-score-2","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateGatewayScore","tags":["Score Feedback"],"summary":"Update gateway score","description":"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.","requestBody":"b8fbe2d1-ce52-4b08-9bc2-26b60f6cc5c9","responses":{"200":"a28cec1d-7e7c-4fcb-8568-0bc609c87360"},"security":["bff5908e-335a-4997-afb8-d909a3433355","a353e52d-9278-4d05-b493-e775e2b0baf3"],"method":"post","type":"path","servers":["958976f9-266c-4eef-b3a4-218e53a06eaf","b60a9067-d7d9-417a-b1fa-0d8efe214a37"],"path":"/update-gateway-score","baseUrlOptions":["http://localhost:8080","https://sandbox.hyperswitch.io"],"title":"Update gateway score","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["merchantId","gateway","paymentId","status"],"properties":{"merchantId":{"type":"string","example":"test_merchant","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"gateway":{"type":"string","example":"stripe","isRequired":true,"uniqueKey":"gateway","typeLabel":"string"},"paymentId":{"type":"string","example":"pay_001","isRequired":true,"uniqueKey":"paymentId","typeLabel":"string"},"status":{"type":"string","enum":["STARTED","AUTHENTICATION_FAILED","JUSPAY_DECLINED","PENDING_VBV","VBV_SUCCESSFUL","AUTHORIZED","AUTHORIZATION_FAILED","CHARGED","AUTHORIZING","COD_INITIATED","VOIDED","VOID_INITIATED","NOP","CAPTURE_INITIATED","CAPTURE_FAILED","VOID_FAILED","AUTO_REFUNDED","PARTIAL_CHARGED","TO_BE_CHARGED","PENDING","FAILURE","DECLINED"],"example":"CHARGED","description":"Transaction status. Must be a TxnStatus value - lowercase values such as `success` are rejected with a 400.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"gatewayReferenceId":{"type":"string","example":"stripe_ref_001","uniqueKey":"gatewayReferenceId","typeLabel":"string"},"enforceDynamicRoutingFailure":{"type":"boolean","default":false,"uniqueKey":"enforceDynamicRoutingFailure","typeLabel":"boolean"},"txnLatency":{"oneOf":[{"type":"object","properties":{"gatewayLatency":{"oneOf":[{"type":"number","format":"double","example":120.5,"uniqueKey":"txnLatency.oneOf.0.gatewayLatency.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":120.5,"uniqueKey":"txnLatency.oneOf.0.gatewayLatency.oneOf.1","typeLabel":"null"}],"uniqueKey":"txnLatency.oneOf.0.gatewayLatency","typeLabel":"number\u003cdouble> | null"}},"description":"Observed gateway latency, in milliseconds.","uniqueKey":"txnLatency.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"gatewayLatency":{"oneOf":[{"type":"number","format":"double","example":120.5},{"type":"null","format":"double","example":120.5}]}},"description":"Observed gateway latency, in milliseconds.","uniqueKey":"txnLatency.oneOf.1","typeLabel":"null"}],"uniqueKey":"txnLatency","typeLabel":"object | null"},"errorInfo":{"oneOf":[{"type":"object","description":"Gateway error details for the GSM-based scoring filter. When present and the merchant flag is on, user/issuer-originated failures are skipped so the gateway is not penalised.","uniqueKey":"errorInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Gateway error details for the GSM-based scoring filter. When present and the merchant flag is on, user/issuer-originated failures are skipped so the gateway is not penalised.","uniqueKey":"errorInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorInfo","typeLabel":"object | null"},"isSmartRetry":{"oneOf":[{"type":"boolean","description":"Set by the orchestrator when this call is a smart-retry attempt.","uniqueKey":"isSmartRetry.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Set by the orchestrator when this call is a smart-retry attempt.","uniqueKey":"isSmartRetry.oneOf.1","typeLabel":"null"}],"uniqueKey":"isSmartRetry","typeLabel":"boolean | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"merchantId":"test_merchant","gateway":"stripe","paymentId":"pay_001","status":"CHARGED","gatewayReferenceId":"stripe_ref_001","enforceDynamicRoutingFailure":false},"examples":{"Example":{"title":"Example","value":{"merchantId":"test_merchant","gateway":"stripe","paymentId":"pay_001","status":"CHARGED","gatewayReferenceId":"stripe_ref_001","enforceDynamicRoutingFailure":false}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"a28cec1d-7e7c-4fcb-8568-0bc609c87360":{"description":"Score updated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"merchant_id":{"type":"string","uniqueKey":"merchant_id","typeLabel":"string"},"gateway":{"type":"string","uniqueKey":"gateway","typeLabel":"string"},"payment_id":{"type":"string","uniqueKey":"payment_id","typeLabel":"string"},"gsm_info":{"oneOf":[{"type":"object","description":"GSM lookup result. Present only when `errorInfo` was supplied and a matching rule was found.","uniqueKey":"gsm_info.oneOf.0","typeLabel":"object"},{"type":"null","description":"GSM lookup result. Present only when `errorInfo` was supplied and a matching rule was found.","uniqueKey":"gsm_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"gsm_info","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Score updated","merchant_id":"test_merchant","gateway":"stripe","payment_id":"pay_001"},"examples":{"Example":{"title":"Example","value":{"message":"Score updated","merchant_id":"test_merchant","gateway":"stripe","payment_id":"pay_001"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"bff5908e-335a-4997-afb8-d909a3433355":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /auth/login","scopes":[]}},"a353e52d-9278-4d05-b493-e775e2b0baf3":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key created via /api-key/create","scopes":[]}}},"servers":{"958976f9-266c-4eef-b3a4-218e53a06eaf":{"url":"http://localhost:8080","description":"Local development"},"b60a9067-d7d9-417a-b1fa-0d8efe214a37":{"url":"https://sandbox.hyperswitch.io","description":"Hyperswitch sandbox with x-feature: decision-engine"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from /auth/login","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT token obtained from /auth/login","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key created via /api-key/create","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key created via /api-key/create","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"decision_engine_openapi-specs.json"},"subdomain":"juspay-78","siteName":"Hyperswitch","title":"Update Gateway Score - Hyperswitch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-05T09:54:32.912Z","originalFileLocation":"decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore.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=\"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Gateway Score - Hyperswitch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperswitch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://juspay-78.mintlify.app/_mintlify/api/og/v2?division=OpenAPI%3A+Score+Feedback\u0026amp;title=Update+Gateway+Score\u0026amp;description=Feed+a+transaction+outcome+back+into+the+success-rate+model.+Call+this+after+every+transaction+so+the+engine+has+accurate+SR+data+for+future+routing+decisions.\u0026amp;theme=761239e0f8c498f13b94e025\u0026amp;signature=36a06b2b821543783417e64e28c5a7c55fe67466d308144946e02c2d7466130b\">\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=\"Update Gateway Score - Hyperswitch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://juspay-78.mintlify.app/_mintlify/api/og/v2?division=OpenAPI%3A+Score+Feedback\u0026amp;title=Update+Gateway+Score\u0026amp;description=Feed+a+transaction+outcome+back+into+the+success-rate+model.+Call+this+after+every+transaction+so+the+engine+has+accurate+SR+data+for+future+routing+decisions.\u0026amp;theme=761239e0f8c498f13b94e025\u0026amp;signature=36a06b2b821543783417e64e28c5a7c55fe67466d308144946e02c2d7466130b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-reference.hyperswitch.io/#organization\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-reference.hyperswitch.io#website\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore#webpage\",\"url\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore\",\"name\":\"Update Gateway Score\",\"description\":\"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\",\"dateModified\":\"2026-08-05T09:54:32.912Z\",\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"},\"breadcrumb\":{\"@id\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hyperswitch\",\"item\":\"https://api-reference.hyperswitch.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Gateway Score\",\"item\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore#apireference\",\"headline\":\"Update Gateway Score\",\"name\":\"Update Gateway Score\",\"description\":\"Feed a transaction outcome back into the success-rate model. Call this after every transaction so the engine has accurate SR data for future routing decisions.\",\"url\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore\",\"mainEntityOfPage\":{\"@id\":\"https://api-reference.hyperswitch.io/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore#webpage\"},\"dateModified\":\"2026-08-05T09:54:32.912Z\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperswitch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hyperswitch","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to Hyperswitch API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction"}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"get /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture Retrieve","href":"/v1/payments/payments--cancel-post-capture-retrieve"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /v1/payment-methods","title":"Payment Method - Create","href":"/v2/payment-methods/payment-method--create-v1"},{"openapi":"get /v1/payment-methods/{id}","title":null,"href":"/v2/payment-methods/payment-method--retrieve-v1"},{"openapi":"put /v1/payment-methods/{id}/update-saved-payment-method","title":"Payment Method - Update","href":"/v2/payment-methods/payment-method--update-v1"},{"openapi":"delete /v1/payment-methods/{id}","title":"Payment Method - Delete","href":"/v2/payment-methods/payment-method--delete-v1"},{"openapi":"get /v1/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods-v1"},{"openapi":"get /v1/payment-methods/token/{payment_method_temporary_token}/details","title":"Payment Method - Get Payment Method Token Data","href":"/v2/payment-methods/payment-method--payment-method-token-to-payment-method-id-v1"},{"openapi":"post /v1/{customer_id}/payment-methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v2/payment-methods/payment-method--set-default-payment-method-for-customer-v1"},{"openapi":"get /payments/{payment_id}/client","title":"List payment methods for a Payment","href":"/v1/payment-methods/list-payment-methods-for-a-payment-via-client-sdk"}]},{"group":"Customers","pages":[{"openapi":"post /v1/customers","title":"Customers - Create","href":"/v2/customers/customers--create-v1"},{"openapi":"get /v1/customers/{id}","title":"Customers - Retrieve","href":"/v2/customers/customers--retrieve-v1"},{"openapi":"get /v1/customers/reference/{merchant_reference_id}","title":"Customers - Retrieve using Merchant Reference ID","href":"/v1/customers/customers--retrieve-by-merchant-reference-id"},{"openapi":"put /v1/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update-v1"},{"openapi":"delete /v1/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete-v1"},{"openapi":"get /v1/customers/list","title":"Customers - List","href":"/v2/customers/customers--list-v1"}]},{"group":"Proxy","pages":[{"openapi":"post /v1/proxy","title":"Proxy","href":"/v2/proxy/proxy-v1"}]},{"group":"Payment Method Session","pages":[{"openapi":"post /v1/payment-method-sessions","title":"Payment Method Session - Create","href":"/v2/payment-method-session/payment-method-session--create-v1"},{"openapi":"get /v1/payment-method-sessions/{id}","title":"Payment Method Session - Retrieve","href":"/v2/payment-method-session/payment-method-session--retrieve-v1"},{"openapi":"get /v1/payment-method-sessions/{id}/list-payment-methods","title":"Payment Method Session - List Payment Methods","href":"/v2/payment-method-session/payment-method-session--list-payment-methods-v1"},{"openapi":"put /v1/payment-method-sessions/{id}/update-saved-payment-method","title":"Payment Method Session - Update a saved payment method","href":"/v2/payment-method-session/payment-method-session--update-a-saved-payment-method-v1"},{"openapi":"post /v1/payment-method-sessions/{id}/confirm","title":"Payment Method Session - Confirm a payment method session","href":"/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session-v1"},{"openapi":"delete /v1/payment-method-sessions/{id}","title":"Payment Method Session - Delete a saved payment method","href":"/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method-v1"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"},{"openapi":"get /disputes/profile/list","title":"Disputes - List Disputes for The Given Profiles","href":"/v1/disputes/disputes--list-profiles"},{"openapi":"post /disputes/accept/{dispute_id}","title":"Disputes - Accept Dispute","href":"/v1/disputes/disputes--accept"},{"openapi":"post /disputes/evidence","title":"Disputes - Uploads Dispute Evidence","href":"/v1/disputes/disputes--submit-evidence"},{"openapi":"put /disputes/evidence","title":"Disputes - Attach Evidence to Dispute","href":"/v1/disputes/disputes--attach-evidence"},{"openapi":"get /disputes/evidence/{dispute_id}","title":"Disputes - Retrieve Dispute Evidence","href":"/v1/disputes/disputes--retrieve-evidence"},{"openapi":"delete /disputes/evidence","title":"Disputes - Delete Evidence attached to a Dispute","href":"/v1/disputes/disputes--delete-evidence"},{"openapi":"get /disputes/aggregate","title":"Disputes - Get Disputes Aggregate","href":"/v1/disputes/disputes--get-aggregate"},{"openapi":"get /disputes/profile/aggregate","title":"Disputes - Get Disputes Aggregate for Profiles","href":"/v1/disputes/disputes--get-aggregate-profiles"},{"openapi":"get /disputes/filter","title":"Disputes - Disputes Filters","href":"/v1/disputes/disputes--get-filters"},{"openapi":"get /disputes/profile/filter","title":"Disputes - Disputes Filters Profile","href":"/v1/disputes/disputes--get-filters-profiles"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Deprecated APIs","pages":[{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"},{"openapi":"get /blocklist/count","title":null,"href":"/v1/blocklist/blocklist--count"},{"openapi":"get /blocklist/lookup","title":null,"href":"/v1/blocklist/blocklist--lookup"},{"openapi":"post /blocklist/batch","title":null,"href":"/v1/blocklist/blocklist--batch-upload"},{"openapi":"get /blocklist/batch","title":null,"href":"/v1/blocklist/blocklist--batch-list"},{"openapi":"get /blocklist/batch/{job_id}","title":null,"href":"/v1/blocklist/blocklist--batch-status"},{"openapi":"post /blocklist/export","title":null,"href":"/v1/blocklist/blocklist--export-create"},{"openapi":"post /blocklist/clone","title":"Blocklist - Clone Entries","href":"/v1/blocklist/blocklist--clone"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0","pages":[{"title":"2.0.0","href":"/introduction"}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Decision Engine API Reference","groups":[{"group":"Overview","pages":[{"title":"Decision Engine","href":"/decision-engine-api-reference/introduction"},{"group":"Installation","pages":[{"title":"Installation","href":"/decision-engine-api-reference/installation"},{"title":"Local Setup","href":"/decision-engine-api-reference/local-setup"},{"title":"PostgreSQL Setup","href":"/decision-engine-api-reference/setup-guide-postgres"},{"title":"MySQL Setup","href":"/decision-engine-api-reference/setup-guide-mysql"},{"title":"Configuration","href":"/decision-engine-api-reference/configuration"},{"title":"Dashboard","href":"/decision-engine-api-reference/dashboard-guide"}]},{"title":"API Guide","href":"/decision-engine-api-reference/api-reference/guides/api-ref"},{"title":"Analytics","href":"/decision-engine-api-reference/analytics"},{"title":"Payment Audit","href":"/decision-engine-api-reference/payment-audit"},{"title":"ClickHouse Analytics","href":"/decision-engine-api-reference/clickhouse-analytics"},{"title":"Performance Benchmarks","href":"/decision-engine-api-reference/benchmarks"}]},{"group":"OpenAPI: Health","pages":[{"title":"Health Check","openapi":"decision_engine_openapi-specs.json GET /health","href":"/decision-engine-api-reference/api-reference/endpoint/health/healthCheck"},{"title":"Health Ready","openapi":"decision_engine_openapi-specs.json GET /health/ready","href":"/decision-engine-api-reference/api-reference/endpoint/health/healthReady"},{"title":"Health Diagnostics","openapi":"decision_engine_openapi-specs.json GET /health/diagnostics","href":"/decision-engine-api-reference/api-reference/endpoint/health/healthDiagnostics"}]},{"group":"OpenAPI: Gateway Decision","pages":[{"title":"Decide Gateway","description":"Core routing decision API. Given a payment context and a list of eligible gateways, returns the optimal gateway to route to.","openapi":"decision_engine_openapi-specs.json POST /decide-gateway","href":"/decision-engine-api-reference/api-reference/endpoint/gateway-decision/decideGateway"}]},{"group":"OpenAPI: Score Feedback","pages":[{"title":"Update Gateway Score","openapi":"decision_engine_openapi-specs.json POST /update-gateway-score","href":"/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore"}]},{"group":"OpenAPI: Merchant Account","pages":[{"title":"Create Merchant","description":"Register a new merchant account. The merchant ID is the primary identifier used in all subsequent routing and scoring calls.","openapi":"decision_engine_openapi-specs.json POST /merchant-account/create","href":"/decision-engine-api-reference/api-reference/endpoint/merchant-account/createMerchant"},{"title":"Get Merchant","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}","href":"/decision-engine-api-reference/api-reference/endpoint/merchant-account/getMerchant"},{"title":"Delete Merchant","openapi":"decision_engine_openapi-specs.json DELETE /merchant-account/{merchant_id}","href":"/decision-engine-api-reference/api-reference/endpoint/merchant-account/deleteMerchant"},{"title":"Get Merchant Debit Routing","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/debit-routing","href":"/decision-engine-api-reference/api-reference/endpoint/merchant-account/getMerchantDebitRouting"},{"title":"Update Merchant Debit Routing","openapi":"decision_engine_openapi-specs.json POST /merchant-account/{merchant_id}/debit-routing","href":"/decision-engine-api-reference/api-reference/endpoint/merchant-account/updateMerchantDebitRouting"}]},{"group":"OpenAPI: Routing Rules","pages":[{"title":"Create Routing Rule","openapi":"decision_engine_openapi-specs.json POST /routing/create","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/createRoutingRule"},{"title":"Activate Routing Rule","openapi":"decision_engine_openapi-specs.json POST /routing/activate","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/activateRoutingRule"},{"title":"Deactivate Routing Rule","openapi":"decision_engine_openapi-specs.json POST /routing/deactivate","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/deactivateRoutingRule"},{"title":"List Routing Rules","openapi":"decision_engine_openapi-specs.json POST /routing/list/{created_by}","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/listRoutingRules"},{"title":"Get Active Routing Rule","openapi":"decision_engine_openapi-specs.json POST /routing/list/active/{created_by}","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/getActiveRoutingRule"},{"title":"Evaluate Routing Rule","openapi":"decision_engine_openapi-specs.json POST /routing/evaluate","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/evaluateRoutingRule"},{"title":"Hybrid Routing","openapi":"decision_engine_openapi-specs.json POST /routing/hybrid","href":"/decision-engine-api-reference/api-reference/endpoint/routing-rules/hybridRouting"}]},{"group":"OpenAPI: Rule Configuration","pages":[{"title":"Create Rule Config","openapi":"decision_engine_openapi-specs.json POST /rule/create","href":"/decision-engine-api-reference/api-reference/endpoint/rule-configuration/createRuleConfig"},{"title":"Get Rule Config","openapi":"decision_engine_openapi-specs.json POST /rule/get","href":"/decision-engine-api-reference/api-reference/endpoint/rule-configuration/getRuleConfig"},{"title":"Update Rule Config","openapi":"decision_engine_openapi-specs.json POST /rule/update","href":"/decision-engine-api-reference/api-reference/endpoint/rule-configuration/updateRuleConfig"},{"title":"Delete Rule Config","openapi":"decision_engine_openapi-specs.json POST /rule/delete","href":"/decision-engine-api-reference/api-reference/endpoint/rule-configuration/deleteRuleConfig"}]},{"group":"OpenAPI: Auth And API Keys","pages":[{"title":"Signup","openapi":"decision_engine_openapi-specs.json POST /auth/signup","href":"/decision-engine-api-reference/api-reference/endpoint/auth/signup"},{"title":"Login","openapi":"decision_engine_openapi-specs.json POST /auth/login","href":"/decision-engine-api-reference/api-reference/endpoint/auth/login"},{"title":"Logout","openapi":"decision_engine_openapi-specs.json POST /auth/logout","href":"/decision-engine-api-reference/api-reference/endpoint/auth/logout"},{"title":"Current User","openapi":"decision_engine_openapi-specs.json GET /auth/me","href":"/decision-engine-api-reference/api-reference/endpoint/auth/me"},{"title":"List User Merchants","openapi":"decision_engine_openapi-specs.json GET /auth/merchants","href":"/decision-engine-api-reference/api-reference/endpoint/auth/listUserMerchants"},{"title":"Switch Merchant","openapi":"decision_engine_openapi-specs.json POST /auth/switch-merchant","href":"/decision-engine-api-reference/api-reference/endpoint/auth/switchMerchant"},{"title":"Onboard Merchant","openapi":"decision_engine_openapi-specs.json POST /onboarding/merchant","href":"/decision-engine-api-reference/api-reference/endpoint/auth/onboardMerchant"},{"title":"Create API Key","openapi":"decision_engine_openapi-specs.json POST /api-key/create","href":"/decision-engine-api-reference/api-reference/endpoint/auth/createApiKey"},{"title":"List API Keys","openapi":"decision_engine_openapi-specs.json GET /api-key/list/{merchant_id}","href":"/decision-engine-api-reference/api-reference/endpoint/auth/listApiKeys"},{"title":"Revoke API Key","openapi":"decision_engine_openapi-specs.json DELETE /api-key/{key_id}","href":"/decision-engine-api-reference/api-reference/endpoint/auth/revokeApiKey"}]},{"group":"OpenAPI: Analytics","pages":[{"title":"Analytics Overview","openapi":"decision_engine_openapi-specs.json GET /analytics/overview","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsOverview"},{"title":"Analytics Gateway Scores","openapi":"decision_engine_openapi-specs.json GET /analytics/gateway-scores","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsGatewayScores"},{"title":"Analytics Decisions","openapi":"decision_engine_openapi-specs.json GET /analytics/decisions","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsDecisions"},{"title":"Analytics Routing Stats","openapi":"decision_engine_openapi-specs.json GET /analytics/routing-stats","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsRoutingStats"},{"title":"Analytics Log Summaries","openapi":"decision_engine_openapi-specs.json GET /analytics/log-summaries","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsLogSummaries"},{"title":"Payment Audit","openapi":"decision_engine_openapi-specs.json GET /analytics/payment-audit","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsPaymentAudit"},{"title":"Preview Trace","openapi":"decision_engine_openapi-specs.json GET /analytics/preview-trace","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsPreviewTrace"},{"title":"Cost Savings","openapi":"decision_engine_openapi-specs.json GET /analytics/cost-savings","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsCostSavings"},{"title":"Routing Events","openapi":"decision_engine_openapi-specs.json GET /analytics/routing-events","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsRoutingEvents"},{"title":"A/B Test Experiment Results","openapi":"decision_engine_openapi-specs.json GET /analytics/experiment/{experiment_id}/results","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsExperimentResults"},{"title":"A/B Test Experiment Transactions","openapi":"decision_engine_openapi-specs.json GET /analytics/experiment/{experiment_id}/transactions","href":"/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsExperimentTransactions"}]},{"group":"OpenAPI: Compatibility And Config","pages":[{"title":"Legacy Decision Gateway","openapi":"decision_engine_openapi-specs.json POST /decision_gateway","href":"/decision-engine-api-reference/api-reference/endpoint/compatibility/legacyDecisionGateway"},{"title":"Legacy Update Score","openapi":"decision_engine_openapi-specs.json POST /update-score","href":"/decision-engine-api-reference/api-reference/endpoint/compatibility/legacyUpdateScore"},{"title":"Get Routing Config","openapi":"decision_engine_openapi-specs.json GET /config/routing-keys","href":"/decision-engine-api-reference/api-reference/endpoint/compatibility/getRoutingConfig"},{"title":"Configure SR Dimensions","openapi":"decision_engine_openapi-specs.json POST /config-sr-dimension","href":"/decision-engine-api-reference/api-reference/endpoint/compatibility/configSrDimension"},{"title":"Get SR Dimensions","openapi":"decision_engine_openapi-specs.json GET /config-sr-dimension/{merchant_id}","href":"/decision-engine-api-reference/api-reference/endpoint/compatibility/getSrDimensions"}]},{"group":"OpenAPI: Connector Costs \u0026 Ingestion","pages":[{"title":"List Connector Credentials","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/connectors","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listConnectorCredentials"},{"title":"Set Connector Credentials","openapi":"decision_engine_openapi-specs.json POST /merchant-account/{merchant_id}/connectors/{connector}/credentials","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/setConnectorCredentials"},{"title":"Delete Connector Credentials","openapi":"decision_engine_openapi-specs.json DELETE /merchant-account/{merchant_id}/connectors/{connector}/credentials/{account}","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/deleteConnectorCredentials"},{"title":"List Connector Fees","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/connector-fees","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listConnectorFees"},{"title":"Set Connector Fee Override","openapi":"decision_engine_openapi-specs.json PUT /merchant-account/{merchant_id}/connectors/{connector}/fee-override","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/setFeeOverride"},{"title":"List Cost Clusters","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/cost-clusters","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listCostClusters"},{"title":"Set Cost Cluster Override","openapi":"decision_engine_openapi-specs.json PUT /merchant-account/{merchant_id}/cost-clusters/{cluster_key}/fee-override","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/setClusterOverride"},{"title":"Get Cost Coverage","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/cost-coverage","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/getCostCoverage"},{"title":"List Cost Ingestions","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/cost-ingestions","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listCostIngestions"},{"title":"Delete Cost Ingestion","openapi":"decision_engine_openapi-specs.json DELETE /merchant-account/{merchant_id}/cost-ingestions/{ingestion_id}","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/deleteCostIngestion"},{"title":"List Cost Price Changes","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/cost-price-changes","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listCostPriceChanges"},{"title":"List Invoice Add-ons","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/invoice-addons","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/listInvoiceAddons"},{"title":"Delete Invoice Add-on","openapi":"decision_engine_openapi-specs.json DELETE /merchant-account/{merchant_id}/connectors/{connector}/invoice-addon","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/deleteInvoiceAddon"},{"title":"Get Invoice Reconciliation","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/invoice-reconciliation","href":"/decision-engine-api-reference/api-reference/endpoint/connector-costs/getInvoiceReconciliation"}]},{"group":"OpenAPI: Feature Flags \u0026 Autopilot","pages":[{"title":"Get Merchant Features","openapi":"decision_engine_openapi-specs.json GET /merchant-account/{merchant_id}/features","href":"/decision-engine-api-reference/api-reference/endpoint/features/getMerchantFeatures"},{"title":"Update Merchant Feature","openapi":"decision_engine_openapi-specs.json POST /merchant-account/{merchant_id}/features/{feature}","href":"/decision-engine-api-reference/api-reference/endpoint/features/updateMerchantFeature"},{"title":"Reset Gateway Scores","openapi":"decision_engine_openapi-specs.json POST /gateway-score/reset","href":"/decision-engine-api-reference/api-reference/endpoint/features/resetGatewayScores"}]},{"group":"API Examples (curl flows)","pages":[{"group":"Health \u0026 Status","pages":[{"title":"Health Checks","href":"/decision-engine-api-reference/api-reference/guides/health-status/health-check"}]},{"group":"Authentication \u0026 Onboarding","pages":[{"title":"Auth And Onboarding","href":"/decision-engine-api-reference/api-reference/guides/auth-onboarding/auth-and-onboarding"},{"title":"API Keys","href":"/decision-engine-api-reference/api-reference/guides/auth-onboarding/api-keys"}]},{"group":"Merchant Accounts","pages":[{"title":"Create Merchant Account","href":"/decision-engine-api-reference/api-reference/guides/merchant-accounts/merchant-account-create"},{"title":"Get Merchant Account","href":"/decision-engine-api-reference/api-reference/guides/merchant-accounts/merchant-account-get"},{"title":"Delete Merchant Account","href":"/decision-engine-api-reference/api-reference/guides/merchant-accounts/merchant-account-delete"},{"title":"Merchant Debit Routing Flag","href":"/decision-engine-api-reference/api-reference/guides/merchant-accounts/merchant-debit-routing"}]},{"group":"Configure Routing","pages":[{"title":"Create Routing Algorithm","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-create"},{"title":"Single Connector Example","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-single-connector-example"},{"title":"Priority Routing Example","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-priority-example"},{"title":"Volume Split Example","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-volume-split-example"},{"title":"Advanced Routing Example","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-advanced-example"},{"title":"Activate Routing Algorithm","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-activate"},{"title":"Deactivate Routing Algorithm","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-deactivate"},{"title":"Update \u0026 Delete Routing Algorithm","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-update-delete"},{"title":"List Routing Algorithms","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-list"},{"title":"List Active Routing Algorithms","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-list-active"},{"title":"Evaluate Routing Algorithm","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-algorithm-evaluate"},{"title":"Hybrid Routing Evaluation","href":"/decision-engine-api-reference/api-reference/guides/configure-routing/routing-hybrid"}]},{"group":"Scoring Configuration","pages":[{"title":"Create Success Rate Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/success-rate-config-create"},{"title":"Get Success Rate Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/success-rate-config-get"},{"title":"Update Success Rate Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/success-rate-config-update"},{"title":"Delete Success Rate Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/success-rate-config-delete"},{"title":"Create Elimination Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/elimination-config-create"},{"title":"Get Elimination Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/elimination-config-get"},{"title":"Update Elimination Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/elimination-config-update"},{"title":"Delete Elimination Config","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/elimination-config-delete"},{"title":"Routing Config Endpoints","href":"/decision-engine-api-reference/api-reference/guides/scoring-config/config-endpoints"}]},{"group":"Cost Data Ingestion","pages":[{"title":"Cost Ingestion: Connector Setup","href":"/decision-engine-api-reference/api-reference/guides/cost-ingestion/cost-ingestion-setup"},{"title":"Cost Ingestion: Uploads","href":"/decision-engine-api-reference/api-reference/guides/cost-ingestion/cost-ingestion-uploads"},{"title":"Cost Ingestion: Fees \u0026 Coverage","href":"/decision-engine-api-reference/api-reference/guides/cost-ingestion/cost-ingestion-fees"}]},{"group":"A/B Testing","pages":[{"title":"A/B Testing: Create An Experiment","href":"/decision-engine-api-reference/api-reference/guides/ab-testing/ab-testing-create"},{"title":"A/B Testing: Results","href":"/decision-engine-api-reference/api-reference/guides/ab-testing/ab-testing-results"}]},{"group":"Autopilot \u0026 Feature Flags","pages":[{"title":"Merchant Features: Autopilot \u0026 Feature Flags","href":"/decision-engine-api-reference/api-reference/guides/autopilot/merchant-features"}]},{"group":"Run Transactions","pages":[{"title":"Decide Gateway: SR Based Routing","href":"/decision-engine-api-reference/api-reference/guides/run-transactions/decide-gateway-sr-based"},{"title":"Decide Gateway: Priority List Based","href":"/decision-engine-api-reference/api-reference/guides/run-transactions/decide-gateway-pl-based"},{"title":"Decide Gateway: Debit Routing","href":"/decision-engine-api-reference/api-reference/guides/run-transactions/decide-gateway-debit-routing"},{"title":"Decide Gateway: Network + SR Hybrid","href":"/decision-engine-api-reference/api-reference/guides/run-transactions/decide-gateway-hybrid-routing"},{"title":"Decide Gateway: Multi-Objective Routing","href":"/decision-engine-api-reference/api-reference/guides/run-transactions/decide-gateway-multi-objective"}]},{"group":"Feedback \u0026 Scoring","pages":[{"title":"Update Gateway Score","href":"/decision-engine-api-reference/api-reference/guides/feedback-scoring/update-gateway-score"}]},{"group":"Analytics \u0026 Audit","pages":[{"title":"Analytics Endpoints","href":"/decision-engine-api-reference/api-reference/guides/analytics-audit/analytics-endpoints"}]},{"group":"Legacy \u0026 Compatibility","pages":[{"title":"Legacy Decision Gateway","href":"/decision-engine-api-reference/api-reference/guides/legacy/decision-gateway-legacy"},{"title":"Legacy Update Score","href":"/decision-engine-api-reference/api-reference/guides/legacy/update-score-legacy"}]}]}]}]},"title":"Update Gateway Score - Hyperswitch","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}