What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.
What this payment can still be refunded for. refundable_amount is authoritative: it already reserves in-flight refunds, so a refund up to that amount is the one guaranteed not to be rejected on balance.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Orqex Orchestrate","description":"Orqex Orchestrate — developer documentation.","colors":{"primary":"#144419","light":"#cdf546","dark":"#144419"},"logo":{"light":"https://mintcdn.com/orqexorchestrate-88/06_-n2_BOcv6tYvd/images/orqex-logo-light.svg?fit=max\u0026auto=format\u0026n=06_-n2_BOcv6tYvd\u0026q=85\u0026s=edc1d7ebd6ade98d993366c147ddd404","dark":"https://mintcdn.com/orqexorchestrate-88/06_-n2_BOcv6tYvd/images/orqex-logo-dark.svg?fit=max\u0026auto=format\u0026n=06_-n2_BOcv6tYvd\u0026q=85\u0026s=303bdad5a590e013f5c7fec3064f0ef5"},"favicon":{"light":"https://mintcdn.com/orqexorchestrate-88/06_-n2_BOcv6tYvd/images/orqex-icon-light.svg?fit=max\u0026auto=format\u0026n=06_-n2_BOcv6tYvd\u0026q=85\u0026s=7308e713661d20063f326084474c7920","dark":"https://mintcdn.com/orqexorchestrate-88/06_-n2_BOcv6tYvd/images/orqex-icon-dark.svg?fit=max\u0026auto=format\u0026n=06_-n2_BOcv6tYvd\u0026q=85\u0026s=5169bf31271c0b01a06d87bfcdb80612"},"api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://api.orqex.com/v1"}},"navbar":{"links":[{"href":"https://github.com/orqex/orchestrate-php","label":"PHP SDK"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.orqex.com"}},"footer":{"socials":{"website":"https://orqex.com","github":"https://github.com/orqex"}},"seo":{"metatags":{"og:site_name":"Orqex Orchestrate Developers","og:type":"website","twitter:card":"summary_large_image"},"indexing":"all"},"fonts":{"heading":{"family":"Sang Bleu Republic","weight":400,"source":"https://fonts.axazara.com/sangbleu/SangBleuRepublic-Regular-WebS.woff2","format":"woff2"},"body":{"family":"Euclid Circular B","weight":400,"source":"https://fonts.axazara.com/euclid/EuclidCircularB-Regular-WebS.woff2","format":"woff2"}},"integrations":{"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orqexorchestrate-88","hasAudioNarration":false,"actualSubdomain":"orqexorchestrate-88","customDomains":["docs.orqex.com"],"gitSource":{"type":"github","owner":"orqex","repo":"orchestrate-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6adbdf4da2aa2b5dfd7367ed","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Guide","count":26},{"language":"default","tag":"API Reference","count":26},{"language":"default","tag":"Payments","count":10},{"language":"default","tag":"Payouts","count":10},{"language":"default","tag":"Payment intents","count":7},{"language":"default","tag":"Get started","count":6},{"language":"default","tag":"Utilities","count":5},{"language":"default","tag":"Payment attempts","count":5},{"language":"default","tag":"Refunds","count":4},{"language":"default","tag":"SDK","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"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":"api-reference/refunds/get-refund-availability","slug":"/api-reference/refunds/get-refund-availability","pageMetadata":{"title":"Get refund availability","description":"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds/availability","href":"/api-reference/refunds/get-refund-availability","autogeneratedByOpenApi":true},"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: \"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\"\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":{"title":"Get refund availability","description":"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds/availability","href":"/api-reference/refunds/get-refund-availability","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Refunds"],"operationId":"getRefundAvailability","summary":"Get refund availability","description":"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.","parameters":["a089a204-f13a-405c-8a2e-d9e94f3c8d5d"],"responses":{"200":"810547e1-facb-4a67-a49f-e83d299589f5","401":"6209330b-5f6d-4bd5-af69-592939badfca","403":"fe8157e3-aa0d-4e6e-8ffa-6fa766ee0bc0","404":"88845019-3216-4071-843b-99ac3ff64dc3","429":"b6a6ef35-b2d2-4d8d-94ad-1ef2dbef7328"},"method":"get","type":"path","servers":["71f83360-01ba-4d5a-924a-1bac8bee81e5"],"security":["408f846f-6c4f-4502-b5bb-7242b173898b"],"path":"/payment/intents/{paymentIntentId}/refunds/availability","baseUrlOptions":["https://api.orqex.com/v1"],"title":"Get refund availability","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a089a204-f13a-405c-8a2e-d9e94f3c8d5d":{"name":"paymentIntentId","in":"path","required":true,"description":"The payment intent id.","schema":{"type":"string","isRequired":true,"description":"The payment intent id.","uniqueKey":"","typeLabel":"string"}}},"responses":{"810547e1-facb-4a67-a49f-e83d299589f5":{"description":"The refund position of the payment.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"What this payment can still be refunded for. `refundable_amount` is authoritative: it already reserves in-flight refunds, so a refund up to that amount is the one guaranteed not to be rejected on balance.","properties":{"is_refundable":{"type":"boolean","description":"Whether a refund can be created right now. When `false`, `unavailable_reason` says why.","uniqueKey":"data.is_refundable","typeLabel":"boolean"},"refundable_amount":{"type":"object","properties":{"value":{"oneOf":[{"type":"number","example":50,"uniqueKey":"data.refundable_amount.value.oneOf.0","typeLabel":"number"},{"type":"null","example":50,"uniqueKey":"data.refundable_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refundable_amount.value","typeLabel":"number | null"},"formatted":{"oneOf":[{"type":"string","example":"$50.00","uniqueKey":"data.refundable_amount.formatted.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50.00","uniqueKey":"data.refundable_amount.formatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refundable_amount.formatted","typeLabel":"string | null"},"short":{"oneOf":[{"type":"string","example":"$50","uniqueKey":"data.refundable_amount.short.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50","uniqueKey":"data.refundable_amount.short.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refundable_amount.short","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","example":"USD","uniqueKey":"data.refundable_amount.currency.oneOf.0","typeLabel":"string"},{"type":"null","example":"USD","uniqueKey":"data.refundable_amount.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refundable_amount.currency","typeLabel":"string | null"}},"uniqueKey":"data.refundable_amount","typeLabel":"object"},"refunded_amount":{"type":"object","properties":{"value":{"oneOf":[{"type":"number","example":50,"uniqueKey":"data.refunded_amount.value.oneOf.0","typeLabel":"number"},{"type":"null","example":50,"uniqueKey":"data.refunded_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunded_amount.value","typeLabel":"number | null"},"formatted":{"oneOf":[{"type":"string","example":"$50.00","uniqueKey":"data.refunded_amount.formatted.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50.00","uniqueKey":"data.refunded_amount.formatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunded_amount.formatted","typeLabel":"string | null"},"short":{"oneOf":[{"type":"string","example":"$50","uniqueKey":"data.refunded_amount.short.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50","uniqueKey":"data.refunded_amount.short.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunded_amount.short","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","example":"USD","uniqueKey":"data.refunded_amount.currency.oneOf.0","typeLabel":"string"},{"type":"null","example":"USD","uniqueKey":"data.refunded_amount.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunded_amount.currency","typeLabel":"string | null"}},"uniqueKey":"data.refunded_amount","typeLabel":"object"},"pending_amount":{"type":"object","properties":{"value":{"oneOf":[{"type":"number","example":50,"uniqueKey":"data.pending_amount.value.oneOf.0","typeLabel":"number"},{"type":"null","example":50,"uniqueKey":"data.pending_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pending_amount.value","typeLabel":"number | null"},"formatted":{"oneOf":[{"type":"string","example":"$50.00","uniqueKey":"data.pending_amount.formatted.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50.00","uniqueKey":"data.pending_amount.formatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pending_amount.formatted","typeLabel":"string | null"},"short":{"oneOf":[{"type":"string","example":"$50","uniqueKey":"data.pending_amount.short.oneOf.0","typeLabel":"string"},{"type":"null","example":"$50","uniqueKey":"data.pending_amount.short.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pending_amount.short","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","example":"USD","uniqueKey":"data.pending_amount.currency.oneOf.0","typeLabel":"string"},{"type":"null","example":"USD","uniqueKey":"data.pending_amount.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pending_amount.currency","typeLabel":"string | null"}},"uniqueKey":"data.pending_amount","typeLabel":"object"},"has_pending_refund":{"type":"boolean","description":"Whether at least one refund is currently in flight.","uniqueKey":"data.has_pending_refund","typeLabel":"boolean"},"available_types":{"type":"array","description":"Refund types the remaining balance allows. `partial` is absent when no amount smaller than the balance can be expressed in the currency.","items":{"type":"string","enum":["full","partial"],"uniqueKey":"data.available_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["full","partial"],"uniqueKey":"data.available_types","typeLabel":"enum\u003cstring>[]"},"execution_method":{"oneOf":[{"type":"string","enum":["gateway","payout"],"description":"How the reversal would be executed. `payout` means it would be sent back to the original payer. `null` when no refund is available.","uniqueKey":"data.execution_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["gateway","payout"],"description":"How the reversal would be executed. `payout` means it would be sent back to the original payer. `null` when no refund is available.","uniqueKey":"data.execution_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.execution_method","typeLabel":"enum\u003cstring> | null"},"unavailable_reason":{"oneOf":[{"type":"string","description":"Why no refund can be created, or `null` when one can.","uniqueKey":"data.unavailable_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why no refund can be created, or `null` when one can.","uniqueKey":"data.unavailable_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.unavailable_reason","typeLabel":"string | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"is_refundable":true,"refundable_amount":{"value":50,"formatted":"$50.00","short":"$50","currency":"USD"},"refunded_amount":{"value":50,"formatted":"$50.00","short":"$50","currency":"USD"},"pending_amount":{"value":50,"formatted":"$50.00","short":"$50","currency":"USD"},"has_pending_refund":true,"available_types":["full","partial"],"execution_method":"gateway","unavailable_reason":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6209330b-5f6d-4bd5-af69-592939badfca":{"description":"Missing, invalid, inactive or expired API key.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe8157e3-aa0d-4e6e-8ffa-6fa766ee0bc0":{"description":"The request address is not on the API key's allowlist.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"88845019-3216-4071-843b-99ac3ff64dc3":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b6a6ef35-b2d2-4d8d-94ad-1ef2dbef7328":{"description":"Rate limit exceeded. Limits vary by operation and resource; respect the Retry-After header.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"408f846f-6c4f-4502-b5bb-7242b173898b":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your secret key, e.g. `sk_live_...` or `sk_sandbox_...`.","scopes":[]}}},"servers":{"71f83360-01ba-4d5a-924a-1bac8bee81e5":{"url":"https://api.orqex.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your secret key, e.g. `sk_live_...` or `sk_sandbox_...`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your secret key, e.g. `sk_live_...` or `sk_sandbox_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"orqexorchestrate-88","siteName":"Orqex Orchestrate","title":"Get refund availability - Orqex Orchestrate","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T01:01:42.059Z","originalFileLocation":"api-reference/refunds/get-refund-availability.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=\"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orqex Orchestrate\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get refund availability - Orqex Orchestrate\">\u003cmeta data-mint-head property=\"og:description\" content=\"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orqex Orchestrate Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orqex.com/api-reference/refunds/get-refund-availability\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orqexorchestrate-88.mintlify.site/_mintlify/api/og/v2?division=Refunds\u0026amp;title=Get+refund+availability\u0026amp;description=What+this+payment+can+still+be+refunded+for%2C+before+you+submit+an+amount%3A+the+remaining+balance%2C+whether+a+refund+is+possible+at+all%2C+and+which+refund+types+it+\u0026amp;theme=2313ed0dda63a6a5e6af2835\u0026amp;signature=dbf2a70d8ad64006c8dacf3340141b8b226239fc8b952b594b9d59c16ad0f0cd\">\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=\"Get refund availability - Orqex Orchestrate\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orqexorchestrate-88.mintlify.site/_mintlify/api/og/v2?division=Refunds\u0026amp;title=Get+refund+availability\u0026amp;description=What+this+payment+can+still+be+refunded+for%2C+before+you+submit+an+amount%3A+the+remaining+balance%2C+whether+a+refund+is+possible+at+all%2C+and+which+refund+types+it+\u0026amp;theme=2313ed0dda63a6a5e6af2835\u0026amp;signature=dbf2a70d8ad64006c8dacf3340141b8b226239fc8b952b594b9d59c16ad0f0cd\">\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/orqexorchestrate-88/PwEujbMsVIWQc-Yt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orqex Orchestrate\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#144419\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orqex.com/api-reference/refunds/get-refund-availability\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/refunds/get-refund-availability.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orqex.com/#organization\",\"name\":\"Orqex Orchestrate\",\"url\":\"https://docs.orqex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orqexorchestrate-88/06_-n2_BOcv6tYvd/images/orqex-logo-light.svg?fit=max\u0026auto=format\u0026n=06_-n2_BOcv6tYvd\u0026q=85\u0026s=edc1d7ebd6ade98d993366c147ddd404\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orqex.com#website\",\"name\":\"Orqex Orchestrate\",\"url\":\"https://docs.orqex.com\",\"publisher\":{\"@id\":\"https://docs.orqex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability#webpage\",\"url\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability\",\"name\":\"Get refund availability\",\"description\":\"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\",\"dateModified\":\"2026-08-25T01:01:42.059Z\",\"isPartOf\":{\"@id\":\"https://docs.orqex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Refunds\",\"item\":\"https://docs.orqex.com/api-reference/refunds/list-refunds\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get refund availability\",\"item\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability#apireference\",\"headline\":\"Get refund availability\",\"name\":\"Get refund availability\",\"description\":\"What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.\",\"url\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orqex.com/api-reference/refunds/get-refund-availability#webpage\"},\"dateModified\":\"2026-08-25T01:01:42.059Z\",\"publisher\":{\"@id\":\"https://docs.orqex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orqex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orqex Orchestrate\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Orqex Orchestrate\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/refunds/get-refund-availability.md","siteName":"Orqex Orchestrate","nav":{"global":null,"tabs":[{"tab":"Guide","icon":"book-open","pages":[{"title":"Guide","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Checkout","pages":[{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/checkouts","href":"/api-reference/checkout/create-a-checkout-session"},{"title":"Retrieve a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/checkouts/{checkoutId}","href":"/api-reference/checkout/retrieve-a-checkout-session"}]},{"group":"Payment intents","pages":[{"title":"List payment intents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents","href":"/api-reference/payment-intents/list-payment-intents"},{"title":"Create a payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents","href":"/api-reference/payment-intents/create-a-payment-intent"},{"title":"Retrieve a payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}","href":"/api-reference/payment-intents/retrieve-a-payment-intent"},{"title":"List available countries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/countries","href":"/api-reference/payment-intents/list-available-countries"},{"title":"List available methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/countries/{countryCode}/methods","href":"/api-reference/payment-intents/list-available-methods"},{"title":"Authorize the active attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents/{paymentIntentId}/authorize","href":"/api-reference/payment-intents/authorize-the-active-attempt"},{"title":"Requery a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents/{paymentIntentId}/requery","href":"/api-reference/payment-intents/requery-a-payment"}]},{"group":"Payment attempts","pages":[{"title":"List attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/attempts","href":"/api-reference/payment-attempts/list-attempts"},{"title":"Start a payment attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents/{paymentIntentId}/attempts","href":"/api-reference/payment-attempts/start-a-payment-attempt"},{"title":"Retrieve an attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/attempts/{attemptId}","href":"/api-reference/payment-attempts/retrieve-an-attempt"},{"title":"Inspect an attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/attempts/{attemptId}/inspect","href":"/api-reference/payment-attempts/inspect-an-attempt"},{"title":"Confirm an attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents/{paymentIntentId}/attempts/{attemptId}/confirm","href":"/api-reference/payment-attempts/confirm-an-attempt"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Create a refund","description":"Refunds all or part of a completed payment. Check `GET /payment/intents/{paymentIntentId}/refunds/availability` first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/intents/{paymentIntentId}/refunds","href":"/api-reference/refunds/create-a-refund"},{"title":"Get refund availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds/availability","href":"/api-reference/refunds/get-refund-availability"},{"title":"Retrieve a refund","description":"A single refund.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds/{refundId}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts","href":"/api-reference/payouts/create-a-payout"},{"title":"Retrieve a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts/{payoutId}","href":"/api-reference/payouts/retrieve-a-payout"},{"title":"Sync a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts/{payoutId}/sync","href":"/api-reference/payouts/sync-a-payout"},{"title":"Inspect a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts/{payoutId}/inspect","href":"/api-reference/payouts/inspect-a-payout"}]},{"group":"Utilities","pages":[{"title":"Latest exchange rates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /exchange-rates/latest/{baseCurrency}","href":"/api-reference/utilities/latest-exchange-rates"},{"title":"List quotable currencies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /exchange-rates/currencies","href":"/api-reference/utilities/list-quotable-currencies"},{"title":"Payment method status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /utils/status/payment/method/{methodCode}/{countryCode}","href":"/api-reference/utilities/payment-method-status"}]}]},{"tab":"SDK","icon":"cube","pages":[{"title":"SDK","href":"/sdk/php/installation"}]}]},"basePath":"","title":"Get refund availability - Orqex Orchestrate","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"]}