Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperswitch","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa","dark":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/dark.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=ba1e1063c50d5e3e6814ac1394cbe0bd"},"favicon":"https://mintcdn.com/juspay-78/lgBtlsxwQg1XCgqU/favicon.png?fit=max\u0026auto=format\u0026n=lgBtlsxwQg1XCgqU\u0026q=85\u0026s=1e2ff54d240ff03d1e663390917f2fb6","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml","decision_engine_openapi-specs.json"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://inviter.co/hyperswitch-slack","label":"Contact Us"},{"href":"https://deepwiki.com/juspay/hyperswitch","label":"Explore with Deepwiki"}],"primary":{"type":"button","label":"Self-Deploy","href":"https://docs.hyperswitch.io/self-hosting"}},"footer":{"socials":{"github":"https://github.com/juspay/hyperswitch","linkedin":"https://www.linkedin.com/company/hyperswitch"}},"integrations":{"gtm":{"tagId":"GTM-PLBNKQFQ"},"mixpanel":{"projectToken":"b00355f29d9548d1333608df71d5d53d"}},"contextual":{"options":["copy","claude","chatgpt","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"juspay-78","hasAudioNarration":false,"actualSubdomain":"juspay-78","customDomains":["api-reference.hyperswitch.io"],"gitSource":{"type":"github","owner":"juspay","repo":"hyperswitch","deployBranch":"main","contentDirectory":"api-reference","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af48600517916afd7758dc7","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentation","count":223},{"language":"default","tag":"Decision Engine API Reference","count":121},{"language":"default","tag":"Payments Core APIs","count":69},{"language":"default","tag":"API Examples (curl flows)","count":44},{"language":"default","tag":"Other APIs","count":39},{"language":"default","tag":"Payments Core APIs [BETA]","count":33},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Payments","count":27},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payment Methods","count":24}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/relay/relay--retrieve","slug":"/v1/relay/relay--retrieve","pageMetadata":{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","description":"Retrieves a relay details.","href":"/v1/relay/relay--retrieve"},"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: \"Retrieves a relay details.\"\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":{"config":{},"pageMetadata":{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","description":"Retrieves a relay details.","href":"/v1/relay/relay--retrieve"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Relay"],"summary":"Relay - Retrieve","description":"Retrieves a relay details.","operationId":"Retrieve a Relay details","parameters":["3209a46b-6ebd-47eb-a335-bf3a731b2d2c","2f3517fa-55d3-4374-b48d-e5a647c314e6","c859c493-bc53-40a1-8120-09dddf5df8fe"],"responses":{"200":"3c2653da-1ebe-4420-b84a-79c1f2867a2d","404":"a3e57d14-dfaa-4345-b318-d8b3e939a022"},"security":["3b22206d-7231-41fb-ae5a-1eca938888ab"],"method":"get","type":"path","servers":["99ae2af7-78ae-4821-95e0-d7b77c8f984f"],"path":"/relay/{relay_id}","baseUrlOptions":["https://sandbox.hyperswitch.io"],"title":"Relay - Retrieve","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3209a46b-6ebd-47eb-a335-bf3a731b2d2c":{"name":"relay_id","in":"path","description":"The unique identifier for the Relay","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier for the Relay","uniqueKey":"","typeLabel":"string"}},"2f3517fa-55d3-4374-b48d-e5a647c314e6":{"name":"X-Profile-Id","in":"header","description":"Profile ID for authentication","required":true,"schema":{"type":"string","isRequired":true,"description":"Profile ID for authentication","uniqueKey":"","typeLabel":"string"}},"c859c493-bc53-40a1-8120-09dddf5df8fe":{"name":"X-Connected-Merchant-Id","in":"header","description":"Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.","required":false,"schema":{"oneOf":[{"type":"string","description":"Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"example":"merchant_abc"}},"responses":{"3c2653da-1ebe-4420-b84a-79c1f2867a2d":{"description":"Relay Retrieved","content":{"application/json":{"schema":{"type":"object","required":["id","status","connector_resource_id","connector_id","profile_id","type"],"properties":{"id":{"type":"string","description":"The unique identifier for the Relay","example":"relay_mbabizu24mvu3mela5njyhpit4","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["created","pending","success","failure"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"connector_resource_id":{"type":"string","description":"The identifier that is associated to a resource at the connector reference to which the relay request is being made","example":"pi_3MKEivSFNglxLpam0ZaL98q9","isRequired":true,"uniqueKey":"connector_resource_id","typeLabel":"string"},"connector_id":{"type":"string","description":"Identifier of the connector ( merchant connector account ) which was chosen to make the payment","example":"mca_5apGeP94tMts6rg3U3kR","isRequired":true,"uniqueKey":"connector_id","typeLabel":"string"},"profile_id":{"type":"string","description":"The business profile that is associated with this relay request.","example":"pro_abcdefghijklmnopqrstuvwxyz","isRequired":true,"uniqueKey":"profile_id","typeLabel":"string"},"type":{"type":"string","enum":["refund","capture","incremental_authorization","void","unreferenced_refund"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The error code","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"The error message","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"},"connector_reference_id":{"oneOf":[{"type":"string","description":"The identifier that is associated to a resource at the connector to which the relay request is being made","example":"re_3QY4TnEOqOywnAIx1Mm1p7GQ","uniqueKey":"connector_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier that is associated to a resource at the connector to which the relay request is being made","example":"re_3QY4TnEOqOywnAIx1Mm1p7GQ","uniqueKey":"connector_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_reference_id","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","required":["refund"],"properties":{"refund":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","format":"int64","description":"The amount that is being refunded","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.0.refund.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"data.oneOf.0.refund.currency","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"The reason for the refund","example":"Customer returned the product","maxLength":255,"uniqueKey":"data.oneOf.0.refund.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason for the refund","example":"Customer returned the product","maxLength":255,"uniqueKey":"data.oneOf.0.refund.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refund.reason","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0.refund","typeLabel":"object"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","required":["capture"],"properties":{"capture":{"type":"object","required":["authorized_amount","amount_to_capture","currency"],"properties":{"authorized_amount":{"type":"integer","format":"int64","description":"The amount that is authorized for capture","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.1.capture.authorized_amount","typeLabel":"integer\u003cint64>"},"amount_to_capture":{"type":"integer","format":"int64","description":"The amount that is being captured","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.1.capture.amount_to_capture","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"data.oneOf.1.capture.currency","typeLabel":"enum\u003cstring>"},"capture_method":{"oneOf":[{"type":"string","description":"Specifies how the payment is captured.\n- `automatic`: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.\n- `manual`: Funds are authorized but not captured. A separate request to the `/payments/{payment_id}/capture` endpoint is required to capture the funds.","enum":["automatic","manual","manual_multiple","scheduled","sequential_automatic"],"uniqueKey":"data.oneOf.1.capture.capture_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"data.oneOf.1.capture.capture_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.capture.capture_method","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1.capture","typeLabel":"object"}},"uniqueKey":"data.oneOf.1","typeLabel":"object"},{"type":"object","required":["incremental_authorization"],"properties":{"incremental_authorization":{"type":"object","required":["total_amount","additional_amount","currency"],"properties":{"total_amount":{"type":"integer","format":"int64","description":"Original amount + additional amount of the transaction","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.2.incremental_authorization.total_amount","typeLabel":"integer\u003cint64>"},"additional_amount":{"type":"integer","format":"int64","description":"The amount by which the payment needs is incremented","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.2.incremental_authorization.additional_amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"data.oneOf.2.incremental_authorization.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.oneOf.2.incremental_authorization","typeLabel":"object"}},"uniqueKey":"data.oneOf.2","typeLabel":"object"},{"type":"object","required":["void"],"properties":{"void":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","format":"int64","description":"The amount of the transaction that is being voided","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.3.void.amount","typeLabel":"integer\u003cint64>"},"currency":{"oneOf":[{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"uniqueKey":"data.oneOf.3.void.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"data.oneOf.3.void.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.void.currency","typeLabel":"enum\u003cstring> | null"},"cancellation_reason":{"oneOf":[{"type":"string","description":"The cancellation reason for voiding the transaction","example":"Requested by merchant","uniqueKey":"data.oneOf.3.void.cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The cancellation reason for voiding the transaction","example":"Requested by merchant","uniqueKey":"data.oneOf.3.void.cancellation_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.void.cancellation_reason","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.3.void","typeLabel":"object"}},"uniqueKey":"data.oneOf.3","typeLabel":"object"},{"type":"object","required":["unreferenced_refund"],"properties":{"unreferenced_refund":{"type":"object","required":["amount","currency","customer_id","recipient_payment_method_data"],"properties":{"amount":{"type":"integer","format":"int64","example":6540,"isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.customer_id","typeLabel":"string"},"recipient_payment_method_data":{"type":"object","required":["card"],"properties":{"card":{"type":"object","required":["card_number","card_exp_month","card_exp_year"],"properties":{"card_number":{"type":"string","example":"4000000000009995","isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_number","typeLabel":"string"},"card_exp_month":{"type":"string","example":"03","isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_exp_month","typeLabel":"string"},"card_exp_year":{"type":"string","example":"30","isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_exp_year","typeLabel":"string"},"card_holder_name":{"oneOf":[{"type":"string","example":"John Doe","uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_holder_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"John Doe","uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_holder_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card.card_holder_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data.card","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund.recipient_payment_method_data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.oneOf.4.unreferenced_refund","typeLabel":"object"}},"uniqueKey":"data.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.5","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object · object · object · object · object · null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"relay_mbabizu24mvu3mela5njyhpit4","status":"created","connector_resource_id":"pi_3MKEivSFNglxLpam0ZaL98q9","connector_id":"mca_5apGeP94tMts6rg3U3kR","profile_id":"pro_abcdefghijklmnopqrstuvwxyz","type":"refund","error":{"code":"\u003cstring>","message":"\u003cstring>"},"connector_reference_id":"re_3QY4TnEOqOywnAIx1Mm1p7GQ","data":{"refund":{"amount":6540,"currency":"AED","reason":"Customer returned the product"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a3e57d14-dfaa-4345-b318-d8b3e939a022":{"description":"Relay details was not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"3b22206d-7231-41fb-ae5a-1eca938888ab":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[],"schemeName":"api_key"}}},"servers":{"99ae2af7-78ae-4821-95e0-d7b77c8f984f":{"url":"https://sandbox.hyperswitch.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[],"schemeName":"api_key"},"schema":{"title":"api-key","type":"string","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api-key"}],"title":"api_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"juspay-78","siteName":"Hyperswitch","title":"Relay - Retrieve - Hyperswitch","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/relay/relay--retrieve","matchLevel":0},"2.0.0":{"href":"/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T04:55:59.273Z","originalFileLocation":"v1/relay/relay--retrieve.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=\"Retrieves a relay details.\">\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=\"Relay - Retrieve - Hyperswitch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a relay details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperswitch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Relay\u0026amp;title=Relay+-+Retrieve\u0026amp;description=Retrieves+a+relay+details.\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=a380d139b548bda4e8ce68a6bcb5ce90f10359b7e82c79cdd34d94821b8b341d\">\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=\"Relay - Retrieve - Hyperswitch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a relay details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Relay\u0026amp;title=Relay+-+Retrieve\u0026amp;description=Retrieves+a+relay+details.\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=a380d139b548bda4e8ce68a6bcb5ce90f10359b7e82c79cdd34d94821b8b341d\">\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/v1/relay/relay--retrieve\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/relay/relay--retrieve.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/v1/relay/relay--retrieve#webpage\",\"url\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve\",\"name\":\"Relay - Retrieve\",\"description\":\"Retrieves a relay details.\",\"dateModified\":\"2026-01-28T04:55:59.273Z\",\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"},\"breadcrumb\":{\"@id\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Other APIs\",\"item\":\"https://api-reference.hyperswitch.io/v1/event/events--list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Relay\",\"item\":\"https://api-reference.hyperswitch.io/v1/relay/relay\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Relay - Retrieve\",\"item\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve#apireference\",\"headline\":\"Relay - Retrieve\",\"name\":\"Relay - Retrieve\",\"description\":\"Retrieves a relay details.\",\"url\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve\",\"mainEntityOfPage\":{\"@id\":\"https://api-reference.hyperswitch.io/v1/relay/relay--retrieve#webpage\"},\"dateModified\":\"2026-01-28T04:55:59.273Z\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperswitch\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperswitch\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v1/relay/relay--retrieve.md","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":"Telephone Order","pages":[{"openapi":"post /telephone_order/{merchant_id}/{provider}","title":"Telephone Order - Charge","href":"/v1/telephone-order/telephone-order--charge"}]},{"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"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","description":"Creates a relay request.","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"description":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","pages":[{"title":"Decision Engine API Reference","href":"/decision-engine-api-reference/introduction"}]}]},"basePath":"","title":"Relay - Retrieve - Hyperswitch","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}