{
"code": 2010,
"message": "transactionNumber does not match a transaction, or the refund hasn't been processed yet."
}
Refund APIs
Query Refund Payment
The payment gateway requests a query refund payment status
Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CommercePay","colors":{"primary":"#5D40E6","light":"#9546E9","dark":"#5834E9"},"logo":{"light":"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed","dark":"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed"},"favicon":"https://mintcdn.com/commercepay/7PrnGTffSwt18xAA/favicon.ico?fit=max\u0026auto=format\u0026n=7PrnGTffSwt18xAA\u0026q=85\u0026s=5bc0f4406b0009f6658b13dd37c95f37","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:payments@commerce.asia","label":"Support"}]},"seo":{"metatags":{"google-site-verification":"dUzHLcHfcaknXY13Nu97zc6gj2DguWeqMvoJWcgBCa4","og:image":"/images/commercepay-og-image.png","twitter:image":"/images/commercepay-og-image.png"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"commercepay","hasAudioNarration":false,"actualSubdomain":"commercepay","customDomains":["docs.commercepay.asia"],"gitSource":{"type":"github","owner":"commerceasia","repo":"commercepay-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae2d375bf78690ab5d17709","collectionId":"968a6a75-68b2-4ecd-bf32-e8fd916b1562","liveDeploymentHistoryId":"6ae2d375bf78690ab5d17709","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae2d375bf78690ab5d17709","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":17},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"All APIs","count":13},{"language":"default","tag":"PaymentGateway","count":10},{"language":"default","tag":"Get Started","count":7},{"language":"default","tag":"Payout APIs","count":3},{"language":"default","tag":"Payins","count":3},{"language":"default","tag":"Payouts","count":3},{"language":"default","tag":"Channel","count":2},{"language":"default","tag":"Payin APIs","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:2.25rem!important;width:auto!important}"}],"page":{"pagePath":"api-reference/query-refund-payment","slug":"/api-reference/query-refund-payment","pageMetadata":{"title":"Query Refund Payment","description":"**The payment gateway requests a query refund payment status**\n\nCheck the status of a refund previously requested via [Refund Payment](/api-reference/refund-payment). Use this to confirm whether a refund has completed, is still processing, or failed.","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"The payment gateway requests a query refund payment status\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Check the status of a refund previously requested via \", _jsx(_components.a, {\n href: \"/api-reference/refund-payment\",\n children: \"Refund Payment\"\n }), \". Use this to confirm whether a refund has completed, is still processing, or failed.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsx(_components.p,{children:`In addition to standard signature errors, this endpoint can return:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2010`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`TransactionNotFound`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`transactionNumber`}),` does not match a transaction, or (for a refund-only lookup) the refund hasn’t been processed yet.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2043`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FailedToRefundQuery`})}),_jsx(_components.td,{children:`The transaction’s channel/provider does not support querying refund status.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2130`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ChannelNotSupportRefund`})}),_jsx(_components.td,{children:`The transaction’s channel is configured to not support refunds.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2160`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`InvalidPaymentGatewaySetting`})}),_jsx(_components.td,{children:`The channel’s provider settings are missing or misconfigured for this tenant.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Query Refund Payment","description":"**The payment gateway requests a query refund payment status**\n\nCheck the status of a refund previously requested via [Refund Payment](/api-reference/refund-payment). Use this to confirm whether a refund has completed, is still processing, or failed.","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["PaymentGateway"],"operationId":"ApiServicesAppPaymentgatewayQueryrefundGet","parameters":["db2285a9-c990-47a3-bdc9-2e1ba1a033d2","ecc82452-5a90-49d5-b0db-e5883d0975b6","07c74918-d0d3-409d-8959-e7a6786092d9","4409449e-075d-4ca4-ac1e-c50b4622c82d","d269d4f3-bee0-4cd7-8552-87242c240c11"],"responses":{"200":"08570ba8-4e06-4731-a78c-bdb4a71aad56","400":"0bab1ebf-b9f6-412d-9838-83bf1e6f9341"},"summary":"Query Refund Payment","description":"**The payment gateway requests a query refund payment status**\n\nCheck the status of a refund previously requested via [Refund Payment](/api-reference/refund-payment). Use this to confirm whether a refund has completed, is still processing, or failed.","x-mint":{"href":"/api-reference/query-refund-payment","metadata":{"title":"Query Refund Payment","sidebarTitle":"Query Refund Payment"},"content":"## Errors\n\nIn addition to standard signature errors, this endpoint can return:\n\n| Code | Name | Meaning |\n| ---- | ---- | ------- |\n| 2010 | `TransactionNotFound` | `transactionNumber` does not match a transaction, or (for a refund-only lookup) the refund hasn't been processed yet. |\n| 2043 | `FailedToRefundQuery` | The transaction's channel/provider does not support querying refund status. |\n| 2130 | `ChannelNotSupportRefund` | The transaction's channel is configured to not support refunds. |\n| 2160 | `InvalidPaymentGatewaySetting` | The channel's provider settings are missing or misconfigured for this tenant. |"},"method":"get","type":"path","servers":["64f6ba68-f659-4eb6-aced-7af162de9cb4"],"security":[],"path":"/api/services/app/PaymentGateway/QueryRefund","baseUrlOptions":["https://staging-payments.commerce.asia"],"title":"Query Refund Payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"db2285a9-c990-47a3-bdc9-2e1ba1a033d2":{"name":"TransactionNumber","in":"query","schema":{"type":"string","maxLength":24,"isRequired":true,"description":"Unique CommercePay Transaction Number","uniqueKey":"","typeLabel":"string"},"description":"Unique CommercePay Transaction Number","required":true},"ecc82452-5a90-49d5-b0db-e5883d0975b6":{"name":"Timestamp","in":"query","schema":{"type":"integer","format":"int64","example":1621851652617,"isRequired":true,"description":"Numeric timestamp in milliseconds representing request validation freshness, generated via `new Date().getTime()`. Example: `1621851652617`.","uniqueKey":"","typeLabel":"integer\u003cint64>"},"description":"Numeric timestamp in milliseconds representing request validation freshness, generated via `new Date().getTime()`. Example: `1621851652617`.","required":true},"07c74918-d0d3-409d-8959-e7a6786092d9":{"schema":{"type":"string","isRequired":true,"description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"","typeLabel":"string"},"in":"header","name":"Abp-TenantId","required":true,"description":"Your unique Merchant ID assigned by CommercePay."},"4409449e-075d-4ca4-ac1e-c50b4622c82d":{"schema":{"type":"string","isRequired":true,"description":"Your API credentials used for authentication (typically a Bearer token).","uniqueKey":"","typeLabel":"string"},"in":"header","name":"Authorization","required":true,"description":"Your API credentials used for authentication (typically a Bearer token)."},"d269d4f3-bee0-4cd7-8552-87242c240c11":{"schema":{"type":"string","isRequired":true,"description":"A unique security hash used to verify the integrity of the request body. See [Generate Signature](/generate-signature) for how to generate this.","uniqueKey":"","typeLabel":"string"},"in":"header","name":"cap-signature","required":true,"description":"A unique security hash used to verify the integrity of the request body. See [Generate Signature](/generate-signature) for how to generate this."}},"responses":{"08570ba8-4e06-4731-a78c-bdb4a71aad56":{"description":"Success","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"x-internal":false,"properties":{"tenantId":{"type":"integer","format":"int64","description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"tenantId","typeLabel":"integer\u003cint64>"},"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionNumber","typeLabel":"string | null"},"refundTransactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundTransactionNumber","typeLabel":"string | null"},"referenceCode":{"oneOf":[{"type":"string","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"referenceCode","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.\r\n\r\nInvalid Format: 1,000.00","example":100,"uniqueKey":"amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"currencyCode","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundStatus","typeLabel":"enum\u003cinteger>"},"responseMessage":{"oneOf":[{"type":"string","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"paymentSessionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentSessionNumber","typeLabel":"string | null"},"refundPaymentList":{"title":"RefundPaymentListDto","type":"object","properties":{"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.transactionNumber","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Refund Amount.","example":100,"uniqueKey":"refundPaymentList.amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.currencyCode","typeLabel":"string | null"},"refundReason":{"oneOf":[{"type":"string","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.refundReason","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundPaymentList.refundStatus","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"refundPaymentList","typeLabel":"RefundPaymentListDto · object"}},"x-examples":{"Example 1":{"tenantId":0,"transactionNumber":"string","paymentSessionNumber":"string","refundTransactionNumber":"string","referenceCode":"string","amount":0,"currencyCode":"string","refundStatus":0,"refundPaymentList":[{"transactionNumber":"string","amount":0,"currencyCode":"string","refundReason":"string","refundStatus":0}],"responseMessage":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example 1":{"title":"Example 1","value":{"tenantId":0,"transactionNumber":"string","refundTransactionNumber":"string","referenceCode":"string","amount":0,"currencyCode":"string","refundStatus":11,"responseMessage":"string","paymentSessionNumber":"string","refundPaymentList":{"transactionNumber":"string","amount":0,"currencyCode":"string","refundReason":"string","refundStatus":11}}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","additionalProperties":false,"x-internal":false,"properties":{"tenantId":{"type":"integer","format":"int64","description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"tenantId","typeLabel":"integer\u003cint64>"},"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionNumber","typeLabel":"string | null"},"refundTransactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundTransactionNumber","typeLabel":"string | null"},"referenceCode":{"oneOf":[{"type":"string","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"referenceCode","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.\r\n\r\nInvalid Format: 1,000.00","example":100,"uniqueKey":"amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"currencyCode","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundStatus","typeLabel":"enum\u003cinteger>"},"responseMessage":{"oneOf":[{"type":"string","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"paymentSessionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentSessionNumber","typeLabel":"string | null"},"refundPaymentList":{"title":"RefundPaymentListDto","type":"object","properties":{"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.transactionNumber","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Refund Amount.","example":100,"uniqueKey":"refundPaymentList.amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.currencyCode","typeLabel":"string | null"},"refundReason":{"oneOf":[{"type":"string","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.refundReason","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundPaymentList.refundStatus","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"refundPaymentList","typeLabel":"RefundPaymentListDto · object"}},"x-examples":{"Example 1":{"tenantId":0,"transactionNumber":"string","paymentSessionNumber":"string","refundTransactionNumber":"string","referenceCode":"string","amount":0,"currencyCode":"string","refundStatus":0,"refundPaymentList":[{"transactionNumber":"string","amount":0,"currencyCode":"string","refundReason":"string","refundStatus":0}],"responseMessage":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"tenantId":123,"transactionNumber":"\u003cstring>","refundTransactionNumber":"\u003cstring>","referenceCode":"\u003cstring>","amount":100,"currencyCode":"MYR","refundStatus":11,"responseMessage":"\u003cstring>","paymentSessionNumber":"\u003cstring>","refundPaymentList":{"transactionNumber":"\u003cstring>","amount":100,"currencyCode":"MYR","refundReason":"\u003cstring>","refundStatus":11}}}},"exampleType":"generated"},"text/plain":{"schema":{"type":"object","additionalProperties":false,"x-internal":false,"properties":{"tenantId":{"type":"integer","format":"int64","description":"Your unique Merchant ID assigned by CommercePay.","uniqueKey":"tenantId","typeLabel":"integer\u003cint64>"},"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number of the original payment being refunded.","maxLength":24,"uniqueKey":"transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionNumber","typeLabel":"string | null"},"refundTransactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number for the refund transaction itself, distinct from the original payment's transactionNumber.","uniqueKey":"refundTransactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundTransactionNumber","typeLabel":"string | null"},"referenceCode":{"oneOf":[{"type":"string","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant-side unique order reference or invoice tracking sequence code.","uniqueKey":"referenceCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"referenceCode","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.\r\n\r\nInvalid Format: 1,000.00","example":100,"uniqueKey":"amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"currencyCode","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundStatus","typeLabel":"enum\u003cinteger>"},"responseMessage":{"oneOf":[{"type":"string","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable status message for the refund request.","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"paymentSessionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Session Number","maxLength":24,"uniqueKey":"paymentSessionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentSessionNumber","typeLabel":"string | null"},"refundPaymentList":{"title":"RefundPaymentListDto","type":"object","properties":{"transactionNumber":{"oneOf":[{"type":"string","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique CommercePay Transaction Number","maxLength":24,"uniqueKey":"refundPaymentList.transactionNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.transactionNumber","typeLabel":"string | null"},"amount":{"type":"number","format":"double","description":"Refund Amount.","example":100,"uniqueKey":"refundPaymentList.amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"oneOf":[{"type":"string","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code with a 3-letter ISO 4217 standard code (e.g., `MYR`).","example":"MYR","maxLength":3,"uniqueKey":"refundPaymentList.currencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.currencyCode","typeLabel":"string | null"},"refundReason":{"oneOf":[{"type":"string","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description for refund.","uniqueKey":"refundPaymentList.refundReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundPaymentList.refundReason","typeLabel":"string | null"},"refundStatus":{"enum":[11,12,13,16,17,18],"type":"integer","format":"int32","x-enumNames":["Refunded","ProcessingRefund","FailedRefund","RefundWithCharges","RefundReverse","Voided"],"description":"Status of the refund itself (not the original payment).\n\n| Value | Name | Meaning |\n| ----- | ---- | ------- |\n| 11 | `Refunded` | Refund completed successfully. |\n| 12 | `ProcessingRefund` | Refund request accepted, being processed by the provider. |\n| 13 | `FailedRefund` | Refund attempt failed. |\n| 16 | `RefundWithCharges` | Refund completed, but provider/processing charges were deducted from the refunded amount. |\n| 17 | `RefundReverse` | A previously completed refund was reversed by the provider. |\n| 18 | `Voided` | The original transaction was voided instead of refunded, e.g. same-day cancellation. |","uniqueKey":"refundPaymentList.refundStatus","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"refundPaymentList","typeLabel":"RefundPaymentListDto · object"}},"x-examples":{"Example 1":{"tenantId":0,"transactionNumber":"string","paymentSessionNumber":"string","refundTransactionNumber":"string","referenceCode":"string","amount":0,"currencyCode":"string","refundStatus":0,"refundPaymentList":[{"transactionNumber":"string","amount":0,"currencyCode":"string","refundReason":"string","refundStatus":0}],"responseMessage":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"tenantId":123,"transactionNumber":"\u003cstring>","refundTransactionNumber":"\u003cstring>","referenceCode":"\u003cstring>","amount":100,"currencyCode":"MYR","refundStatus":11,"responseMessage":"\u003cstring>","paymentSessionNumber":"\u003cstring>","refundPaymentList":{"transactionNumber":"\u003cstring>","amount":100,"currencyCode":"MYR","refundReason":"\u003cstring>","refundStatus":11}}}},"exampleType":"generated"}},"exampleType":"examples"},"0bab1ebf-b9f6-412d-9838-83bf1e6f9341":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"integer","description":"See the Errors table above.","uniqueKey":"code","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"TransactionNotFound":{"title":"TransactionNotFound","value":{"code":2010,"message":"transactionNumber does not match a transaction, or the refund hasn't been processed yet."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"64f6ba68-f659-4eb6-aced-7af162de9cb4":{"description":"Staging","url":"https://staging-payments.commerce.asia"}}},"originalFileLocation":"openapi.json"},"subdomain":"commercepay","siteName":"CommercePay","title":"Query Refund Payment - CommercePay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T05:02:49.752Z","originalFileLocation":"api-reference/query-refund-payment.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=\"The payment gateway requests a query refund payment status Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CommercePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_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/commercepay/GH8Bb27qvn280PyP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Query Refund Payment - CommercePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"The payment gateway requests a query refund payment status Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CommercePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.commercepay.asia/api-reference/query-refund-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://commercepay.mintlify.site/images/commercepay-og-image.png\">\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=\"Query Refund Payment - CommercePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The payment gateway requests a query refund payment status Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://commercepay.mintlify.site/images/commercepay-og-image.png\">\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/commercepay/GH8Bb27qvn280PyP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CommercePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5D40E6\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"dUzHLcHfcaknXY13Nu97zc6gj2DguWeqMvoJWcgBCa4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.commercepay.asia/api-reference/query-refund-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/query-refund-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.commercepay.asia/#organization\",\"name\":\"CommercePay\",\"url\":\"https://docs.commercepay.asia\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/commercepay/zbo4Bt5Hnzxuhmp1/logo/commercepay-logo-cropped.png?fit=max\u0026auto=format\u0026n=zbo4Bt5Hnzxuhmp1\u0026q=85\u0026s=2818942319162624de2b3de633ee42ed\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.commercepay.asia#website\",\"name\":\"CommercePay\",\"url\":\"https://docs.commercepay.asia\",\"publisher\":{\"@id\":\"https://docs.commercepay.asia/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.commercepay.asia/api-reference/query-refund-payment#webpage\",\"url\":\"https://docs.commercepay.asia/api-reference/query-refund-payment\",\"name\":\"Query Refund Payment\",\"description\":\"The payment gateway requests a query refund payment status Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.\",\"dateModified\":\"2026-10-29T05:02:49.752Z\",\"isPartOf\":{\"@id\":\"https://docs.commercepay.asia#website\"},\"breadcrumb\":{\"@id\":\"https://docs.commercepay.asia/api-reference/query-refund-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.commercepay.asia/api-reference/query-refund-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Refund APIs\",\"item\":\"https://docs.commercepay.asia/api-reference/refund-payment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Query Refund Payment\",\"item\":\"https://docs.commercepay.asia/api-reference/query-refund-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.commercepay.asia/api-reference/query-refund-payment#apireference\",\"headline\":\"Query Refund Payment\",\"name\":\"Query Refund Payment\",\"description\":\"The payment gateway requests a query refund payment status Check the status of a refund previously requested via Refund Payment. Use this to confirm whether a refund has completed, is still processing, or failed.\",\"url\":\"https://docs.commercepay.asia/api-reference/query-refund-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.commercepay.asia/api-reference/query-refund-payment#webpage\"},\"image\":\"https://docs.commercepay.asia/images/commercepay-og-image.png\",\"dateModified\":\"2026-10-29T05:02:49.752Z\",\"publisher\":{\"@id\":\"https://docs.commercepay.asia/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.commercepay.asia#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CommercePay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CommercePay","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Get Access Token","deprecated":null,"version":null,"sidebarTitle":"Get Access Token","openapi":"/openapi.json post /api/TokenAuth/Authenticate","href":"/api-reference/get-access-token"}]},{"group":"Channel APIs","pages":[{"title":"Get Channel List","deprecated":null,"version":null,"sidebarTitle":"Get Channel List","openapi":"/openapi.json get /api/services/app/Channel/GetTenantChannelsByCountry","href":"/api-reference/get-tenant-channels-by-country"},{"title":"Get Provider Channels","deprecated":null,"version":null,"sidebarTitle":"Get Provider Channels","openapi":"/openapi.json get /api/services/app/Channel/GetProviderChannels","href":"/api-reference/get-provider-channels"}]},{"group":"Payin APIs","pages":[{"title":"Direct Integration","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/direct-integration-api-request-payment"},{"title":"Hosted Session Checkout","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session"},{"title":"Query Payment","deprecated":null,"version":null,"sidebarTitle":"Query Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/Query","href":"/api-reference/query-payment"}]},{"group":"Saved Payment APIs","pages":[{"title":"Add Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Add Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/AddSavePayment","href":"/api-reference/add-saved-payment"},{"title":"Check Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Check Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/CheckSavedPayment","href":"/api-reference/check-saved-payment"},{"title":"Revoke Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Revoke Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RevokeTokenize","href":"/api-reference/revoke-saved-payment"}]},{"group":"Payout APIs","pages":[{"title":"Request Payout","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/payout-api-requestpayout"},{"title":"Query Wallets","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/QueryWallets","href":"/api-reference/payout-api-querywallets"},{"title":"Query Wallet Histories","api":"POST https://staging-payments.commerce.asia/api/services/app/PaymentGateway/QueryWalletHistory","href":"/api-reference/payout-api-querywallethistories"}]},{"group":"Refund APIs","pages":[{"title":"Refund Payment","description":"**The payment gateway requests a refund payment**\n\nInitiate a full or partial refund for a successful payment transaction. See [Refund Integration](/refund-integration) for full vs. partial refund behavior and bank support. The response's `refundStatus` reflects the outcome directly — if it comes back as `ProcessingRefund`, use [Query Refund Payment](/api-reference/query-refund-payment) to check when it completes.","deprecated":null,"version":null,"sidebarTitle":"Refund Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RefundPayment","href":"/api-reference/refund-payment"},{"title":"Query Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment"}]},{"group":"All APIs","pages":[{"group":"TokenAuth","pages":[{"title":"Get Access Token","description":"The following input parameters are expected to be provided by the Merchant to retrieve the access token.\n\n> - Pass the returned `accessToken` as `Authorization: Bearer {access token from authentication}` on subsequent API calls — see [Request Headers](/request-headers) for the full header list.\n> - The token is valid for **24 hours** (`expireInSeconds`: 86400).","deprecated":null,"version":null,"sidebarTitle":"Get Access Token","openapi":"/openapi.json post /api/TokenAuth/Authenticate","href":"/api-reference/get-access-token"}]},{"group":"Channel","pages":[{"title":"Get Channel List","deprecated":null,"version":null,"sidebarTitle":"Get Channel List","openapi":"/openapi.json get /api/services/app/Channel/GetTenantChannelsByCountry","href":"/api-reference/get-tenant-channels-by-country"},{"title":"Get Provider Channels","deprecated":null,"version":null,"sidebarTitle":"Get Provider Channels","openapi":"/openapi.json get /api/services/app/Channel/GetProviderChannels","href":"/api-reference/get-provider-channels"}]},{"group":"PaymentGateway","pages":[{"title":"Query Payment","deprecated":null,"version":null,"sidebarTitle":"Query Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/Query","href":"/api-reference/query-payment"},{"title":"Request Payment","deprecated":null,"version":null,"sidebarTitle":"Request Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RequestPayment","href":"/api-reference/paymentgateway/request-payment"},{"title":"Process Payment","deprecated":null,"version":null,"sidebarTitle":"Process Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/ProcessPayment","href":"/api-reference/paymentgateway/process-payment"},{"title":"Check Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Check Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/CheckSavedPayment","href":"/api-reference/check-saved-payment"},{"title":"Add Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Add Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/AddSavePayment","href":"/api-reference/add-saved-payment"},{"title":"Revoke Saved Payment","deprecated":null,"version":null,"sidebarTitle":"Revoke Saved Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RevokeTokenize","href":"/api-reference/revoke-saved-payment"},{"title":"Refund Payment","description":"**The payment gateway requests a refund payment**\n\nInitiate a full or partial refund for a successful payment transaction. See [Refund Integration](/refund-integration) for full vs. partial refund behavior and bank support. The response's `refundStatus` reflects the outcome directly — if it comes back as `ProcessingRefund`, use [Query Refund Payment](/api-reference/query-refund-payment) to check when it completes.","deprecated":null,"version":null,"sidebarTitle":"Refund Payment","openapi":"/openapi.json post /api/services/app/PaymentGateway/RefundPayment","href":"/api-reference/refund-payment"},{"title":"Query Refund Payment","deprecated":null,"version":null,"sidebarTitle":"Query Refund Payment","openapi":"/openapi.json get /api/services/app/PaymentGateway/QueryRefund","href":"/api-reference/query-refund-payment"},{"title":"Query Wallets","description":"Inquiry the wallet balance.\r\n\r\nThe following input parameters are expected to be provided by the merchant to retrieve the wallet balances.","deprecated":null,"version":null,"sidebarTitle":"Query Wallets","openapi":"/openapi.json post /api/services/app/PaymentGateway/QueryWallets","href":"/api-reference/paymentgateway/query-wallets"},{"title":"Hosted Session Checkout","deprecated":null,"version":null,"sidebarTitle":"Hosted Session Checkout","openapi":"/openapi.json post /api/services/app/PaymentGateway/InitialSession","href":"/api-reference/initial-session"}]}]}]}]},"basePath":"","title":"Query Refund Payment - CommercePay","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}