Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.
A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"UQPAY Developer Docs","colors":{"primary":"#1A56DB","light":"#3B82F6","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-light.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=f7d617f71b284158f3d0d2a8e2872806","dark":"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-dark.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=3fd4b4156eb5c214e01f731ef3f34eb3","href":"/"},"favicon":"https://mintcdn.com/uqpay-ecc4f4d8/LSVZGfPa5IJvbfLG/images/favicon.png?fit=max\u0026auto=format\u0026n=LSVZGfPa5IJvbfLG\u0026q=85\u0026s=b827dc48353a177e8a524fd888b06f90","contextual":{"options":["cursor","vscode","mcp","add-mcp"],"display":"header"},"variables":{"sdk-release-line":"3.1","sdk-node-current":"3.1.0","sdk-python-current":"3.1.0","sdk-go-current":"3.1.0","sdk-java-current":"3.1.0","sdk-cli-current":"3.1.0"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"/changelog","label":"Changelog"}]},"href":"account-center/v1.6/guide/overview"},{"language":"zh","navbar":{"links":[{"href":"/zh/changelog","label":"更新日志"}]},"href":"zh/account-center/v1.6/guide/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uqpay-ecc4f4d8","hasAudioNarration":false,"actualSubdomain":"uqpay-ecc4f4d8","customDomains":["developers-sandbox.uqpaytech.com"],"gitSource":{"type":"github","owner":"marshall-uq","repo":"uqpay-developer-docs","deployBranch":"sandbox","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab7d43e1f314e367e7a139f","collectionId":"cda03377-3e47-4f38-a089-845d2586e57c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab7d43e1f314e367e7a139f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ab7d43e1f314e367e7a139f","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"API Reference","count":136},{"language":"zh","tag":"API 参考","count":136},{"language":"en","tag":"Guide","count":93},{"language":"zh","tag":"指南","count":93},{"language":"en","tag":"Card Issuance","count":78},{"language":"zh","tag":"Card Issuance","count":78},{"language":"en","tag":"Stablecoin Account","count":70},{"language":"zh","tag":"Stablecoin Account","count":66},{"language":"en","tag":"Global Account","count":52},{"language":"zh","tag":"Global Account","count":52},{"language":"en","tag":"AI Knowledge Base","count":47},{"language":"en","tag":"Global Acquiring","count":47},{"language":"zh","tag":"AI 知识库","count":47},{"language":"zh","tag":"Global Acquiring","count":47},{"language":"en","tag":"Webhooks","count":40},{"language":"zh","tag":"Webhooks","count":40},{"language":"en","tag":"Account Center","count":37},{"language":"en","tag":"Card Issuance API","count":37},{"language":"zh","tag":"Account Center","count":37},{"language":"zh","tag":"Card Issuance API","count":37}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#assistant-entry,#assistant-entry-mobile,#chat-assistant-sheet{display:none!important}[data-component-part=products-selector-item]:has(svg[style*=sparkles]),[data-component-part=products-selector-trigger]:has(svg[style*=sparkles]){display:none!important}.landing-page{margin:-1.5rem -1.5rem 0}.landing-hero{padding:5rem 1.5rem 4rem;position:relative;border-bottom:1px solid #e5e7eb}.landing-badge{display:inline-block;padding:.3rem .85rem;background:#eff6ff;border:1px solid #bfdbfe;border-radius:100px;color:#1d4ed8;font-size:.8rem;font-weight:500;letter-spacing:.01em;margin-bottom:1.5rem}.landing-quickstart{margin-top:-2rem;position:relative;z-index:10;padding-bottom:1rem}.landing-steps-container{background:#fff;border-radius:1rem;box-shadow:0 4px 24px rgba(0,0,0,.06),0 1px 3px rgba(0,0,0,.03);border:1px solid #e5e7eb;overflow:hidden}.landing-step{display:flex;align-items:center;gap:1rem;padding:1.25rem 1.5rem;text-decoration:none;transition:background .15s ease;border-right:1px solid #f0f0f0}.landing-step:last-child{border-right:none}.landing-step:hover{background:#f8fafc;text-decoration:none}.landing-step-number{display:flex;align-items:center;justify-content:center;min-width:2.25rem;height:2.25rem;background:#1a56db;color:#fff;font-weight:700;font-size:.85rem;border-radius:.5rem}.landing-step-title{display:block;font-weight:600;font-size:.9rem;color:#111827}.landing-step-desc{display:block;font-size:.8rem;color:#6b7280;margin-top:.1rem}.landing-devtools{background:#f8fafc;border-radius:1.5rem;margin:0 1rem 2rem}.landing-page [class*=Card]{transition:transform .2s ease,box-shadow .2s ease}.landing-page [class*=Card]:hover{transform:translateY(-2px);box-shadow:0 8px 24px rgba(0,0,0,.06)}.dark .landing-hero{border-bottom-color:#1f2937}.dark .landing-badge{background:rgba(29,78,216,.15);border-color:rgba(59,130,246,.3);color:#60a5fa}.dark .landing-steps-container{background:#1f2937;border-color:#374151;box-shadow:0 4px 24px rgba(0,0,0,.3)}.dark .landing-step{border-right-color:#374151}.dark .landing-step:hover{background:#263244}.dark .landing-step-number{background:#2563eb}.dark .landing-step-title{color:#f3f4f6}.dark .landing-step-desc{color:#9ca3af}.dark .landing-devtools{background:#111827}@media (max-width:768px){.landing-step{border-right:none;border-bottom:1px solid #f0f0f0}.landing-step:last-child{border-bottom:none}.dark .landing-step{border-bottom-color:#374151}}@media (min-width:900px){#error-code-table{width:100%!important;min-width:0!important;table-layout:fixed}#error-code-table td,#error-code-table th{min-width:0!important;padding-left:.75rem;padding-right:.75rem;vertical-align:top;overflow-wrap:anywhere}#error-code-table th:nth-child(1){width:20%}#error-code-table th:nth-child(2){width:28%}#error-code-table th:nth-child(3){width:23%}#error-code-table th:nth-child(4){width:29%}#error-code-table code.mint-whitespace-nowrap,#error-code-table code.whitespace-nowrap{display:inline-block;max-width:100%;white-space:normal!important;overflow-wrap:anywhere;word-break:break-word}}"}],"page":{"pagePath":"global-acquiring/v1.6/api-reference/create-refund","slug":"/global-acquiring/v1.6/api-reference/create-refund","pageMetadata":{"title":"Create a refund","description":"Create a refund for a completed payment","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/refunds","href":"/global-acquiring/v1.6/api-reference/create-refund","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: \"Create a refund for a completed payment\"\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":"Create a refund","description":"Create a refund for a completed payment","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/refunds","href":"/global-acquiring/v1.6/api-reference/create-refund","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/uqpay-ecc4f4d8/77dcf16d44608ed8/error-code-table.js"],"openApiReferenceData":{"operation":{"summary":"Create a refund","description":"Create a refund for a completed payment","operationId":"create-refund","x-mint":{"href":"/global-acquiring/v1.6/api-reference/create-refund"},"tags":["Payment Refunds"],"parameters":["78fca40a-e265-4772-aace-9ecf7252d242","d6b5ae11-972e-4785-b1e2-2128aeb98c0f","ff24d491-2dbf-4f52-8dae-af9c28db200a"],"requestBody":"15a1e3bf-16aa-455d-9e69-638d42a78f64","responses":{"200":"1c7ac6bc-3053-46e2-9a07-c93aa0a3c425"},"method":"post","type":"path","servers":["d847b3de-ab64-4f74-88d8-0cd213f288af","ddf4e041-e7fd-46dd-87b9-25d8dd2de8af"],"security":["0b896c3b-909f-48d8-b424-aabe1fc8d157"],"path":"/v2/payment/refunds","baseUrlOptions":["https://api-sandbox.uqpaytech.com/api","https://api.uqpay.com/api"],"title":"Create a refund","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"78fca40a-e265-4772-aace-9ecf7252d242":{"in":"header","name":"x-client-id","schema":{"type":"string","isRequired":true,"description":"The API client id generated by UQPAY","uniqueKey":"","typeLabel":"string"},"required":true,"description":"The API client id generated by UQPAY","example":"Up1HIsjiETgON9PMGPXLy7"},"d6b5ae11-972e-4785-b1e2-2128aeb98c0f":{"in":"header","name":"x-on-behalf-of","schema":{"type":"string","isRequired":false,"description":"Specifies the sub-account on whose behalf the request is made. This should be set to the `account_id`, which can be retrieved via the [List Connected Accounts](/account-center/v1.6/api-reference/list-connected-accounts). If omitted or empty, the request is executed using the master account.\nMore information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts).\n","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Specifies the sub-account on whose behalf the request is made. This should be set to the `account_id`, which can be retrieved via the [List Connected Accounts](/account-center/v1.6/api-reference/list-connected-accounts). If omitted or empty, the request is executed using the master account.\nMore information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts).\n","example":"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"},"ff24d491-2dbf-4f52-8dae-af9c28db200a":{"in":"header","name":"x-idempotency-key","schema":{"type":"string","format":"uuid","isRequired":true,"description":"A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.","example":"2adesf8e-9d63-44bc-b975-9b6ae3440dde"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_intent_id","amount","reason"],"properties":{"payment_intent_id":{"type":"string","description":"The ID of the payment intent to refund","example":"PI1234567890123456789","maxLength":36,"isRequired":true,"uniqueKey":"payment_intent_id","typeLabel":"string"},"amount":{"type":"string","description":"The amount to refund","example":"10.01","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"reason":{"type":"string","description":"The reason for the refund","maxLength":100,"example":"Return good","isRequired":true,"uniqueKey":"reason","typeLabel":"string"},"txn_batch_no":{"type":"string","description":"Batch reference for this POS operation; omit for non-POS requests.","uniqueKey":"txn_batch_no","typeLabel":"string"},"payment_attempt_id":{"type":"string","description":"The ID of the payment attempt to refund","example":"PA1234567890123456789","uniqueKey":"payment_attempt_id","typeLabel":"string"},"metadata":{"type":"object","description":"Additional metadata for the refund","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"example":{"customer_id":"cust_12345","order_id":"order_6789"},"maximum":3200,"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_intent_id":"PI1234567890123456789","amount":"10.01","reason":"Return good","txn_batch_no":"\u003cstring>","payment_attempt_id":"PA1234567890123456789","metadata":{"customer_id":"cust_12345","order_id":"order_6789"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"1c7ac6bc-3053-46e2-9a07-c93aa0a3c425":{"description":"Refund created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"payment_refund_id":{"type":"string","description":"The unique identifier for the refund","example":"RF123456789","uniqueKey":"payment_refund_id","typeLabel":"string"},"payment_attempt_id":{"type":"string","description":"The ID of the payment attempt that was refunded","example":"PA123456789","uniqueKey":"payment_attempt_id","typeLabel":"string"},"amount":{"type":"string","description":"The amount refunded","example":"10.01","uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","description":"The three-letter currency code (ISO 4217)","example":"USD","format":"iso-4217","uniqueKey":"currency","typeLabel":"string\u003ciso-4217>"},"refund_status":{"type":"string","description":"The current status of the refund.\n\n- `INITIATED`: The refund has been initiated.\n- `PROCESSING`: The refund is being processed.\n- `SUCCEEDED`: The refund was successfully completed.\n- `FAILED`: The refund attempt failed.\n- `REVERSAL_INITIATED`: The reversal of the refund has been initiated.\n- `REVERSAL_PROCESSING`: The reversal of the refund is currently being processed.\n- `REVERSAL_SUCCEEDED`: The reversal of the refund was successfully completed.\n","example":"SUCCEEDED","enum":["INITIATED","PROCESSING","SUCCEEDED","FAILED","REVERSAL_INITIATED","REVERSAL_PROCESSING","REVERSAL_SUCCEEDED"],"uniqueKey":"refund_status","typeLabel":"enum\u003cstring>"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"The time at which this payment refund was created.","uniqueKey":"create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Last time at which this payment refund was updated or operated on.","uniqueKey":"update_time","typeLabel":"string\u003cdate/time>"},"reason":{"type":"string","description":"The reason for the refund","example":"Order 1234 has been returned","maxLength":100,"uniqueKey":"reason","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"Additional metadata associated with the refund. User-defined key-value pairs.","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"customer_id":"cust_12345","order_id":"order_6789"},"maximum":3200,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional metadata associated with the refund. User-defined key-value pairs.","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"customer_id":"cust_12345","order_id":"order_6789"},"maximum":3200,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_refund_id":"RF123456789","payment_attempt_id":"PA123456789","amount":"10.01","currency":"USD","refund_status":"SUCCEEDED","create_time":"2024-03-01T00:00:00+08:00","update_time":"2024-03-01T00:00:00+08:00","reason":"Order 1234 has been returned","metadata":{"customer_id":"cust_12345","order_id":"order_6789"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0b896c3b-909f-48d8-b424-aabe1fc8d157":{"XAuthToken":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The API token for login provided by UQPAY.","scopes":[]}}},"servers":{"d847b3de-ab64-4f74-88d8-0cd213f288af":{"url":"https://api-sandbox.uqpaytech.com/api","description":"Sandbox base URL."},"ddf4e041-e7fd-46dd-87b9-25d8dd2de8af":{"url":"https://api.uqpay.com/api","description":"Production base URL."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The API token for login provided by UQPAY.","scopes":[]},"schema":{"title":"x-auth-token","type":"string","description":"The API token for login provided by UQPAY.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XAuthToken","name":"x-auth-token"}],"title":"XAuthToken"}]},"originalFileLocation":"global-acquiring/v1.6/payment.yaml"},"subdomain":"uqpay-ecc4f4d8","siteName":"UQPAY Developer Docs","title":"Create a refund - UQPAY Developer Docs","navMaps":{"firstHrefInVersion":{"v1.6":{"href":"/global-acquiring/v1.6/api-reference/create-refund","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/global-acquiring/v1.6/api-reference/create-refund","matchLevel":0},"zh":{"href":"/zh/global-acquiring/v1.6/api-reference/create-refund","matchLevel":1}}},"lastModified":"2026-09-26T14:19:00.689Z","originalFileLocation":"global-acquiring/v1.6/api-reference/create-refund.mdx","locale":"en"},"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=\"Create a refund for a completed payment\">\u003cmeta data-mint-head name=\"application-name\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_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=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a refund - UQPAY Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a refund for a completed payment\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uqpay-ecc4f4d8.mintlify.app/_mintlify/api/og/v2?division=Payment+Refunds\u0026amp;title=Create+a+refund\u0026amp;description=Create+a+refund+for+a+completed+payment\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=e87232026f2771405eb2fd975289e69bbad7c127daf671de0aaf6b9fbd666484\">\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=\"Create a refund - UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a refund for a completed payment\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uqpay-ecc4f4d8.mintlify.app/_mintlify/api/og/v2?division=Payment+Refunds\u0026amp;title=Create+a+refund\u0026amp;description=Create+a+refund+for+a+completed+payment\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=e87232026f2771405eb2fd975289e69bbad7c127daf671de0aaf6b9fbd666484\">\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=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A56DB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/global-acquiring/v1.6/api-reference/create-refund.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://developers-sandbox.uqpaytech.com/docs/zh/global-acquiring/v1.6/api-reference/create-refund\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\",\"name\":\"UQPAY Developer Docs\",\"url\":\"https://developers-sandbox.uqpaytech.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-light.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=f7d617f71b284158f3d0d2a8e2872806\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\",\"name\":\"UQPAY Developer Docs\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs\",\"publisher\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund#webpage\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\",\"name\":\"Create a refund\",\"description\":\"Create a refund for a completed payment\",\"dateModified\":\"2026-09-26T14:19:00.689Z\",\"isPartOf\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment API\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-payment-intent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payment Refunds\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/list-refunds\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a refund\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund#apireference\",\"headline\":\"Create a refund\",\"name\":\"Create a refund\",\"description\":\"Create a refund for a completed payment\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund\",\"mainEntityOfPage\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-refund#webpage\"},\"dateModified\":\"2026-09-26T14:19:00.689Z\",\"publisher\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UQPAY Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"UQPAY Developer Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"/changelog","label":"Changelog"}]},"products":[{"product":"Account Center","icon":"user","pages":[{"title":"Account Center","href":"/account-center/v1.6/guide/overview"}]},{"product":"Global Acquiring","icon":"cash-register","versions":[{"version":"v1.6","tag":"Latest","tabs":[{"tab":"Guide","icon":"book-open","pages":[{"title":"Guide","href":"/global-acquiring/v1.6/guide/overview"}]},{"tab":"Webhooks","icon":"bell","pages":[{"title":"Webhooks","href":"/global-acquiring/v1.6/webhooks/paymentintent-result"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Payment API","pages":[{"group":"Payment Intents","pages":[{"title":"Create a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Create payment intent","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment_intents/create","href":"/global-acquiring/v1.6/api-reference/create-payment-intent"},{"title":"Retrieve a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Retrieve payment intent","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment_intents/{id}","href":"/global-acquiring/v1.6/api-reference/retrieve-payment-intent"},{"title":"Update a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Update payment intent","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment_intents/{id}","href":"/global-acquiring/v1.6/api-reference/update-payment-intent"},{"title":"Confirm a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Confirm payment intent","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment_intents/{id}/confirm","href":"/global-acquiring/v1.6/api-reference/confirm-payment-intent"},{"title":"Capture a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Capture payment intent","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment_intents/{id}/capture","href":"/global-acquiring/v1.6/api-reference/capture-payment-intent"},{"title":"Cancel a PaymentIntent","deprecated":null,"version":null,"sidebarTitle":"Cancel payment intent","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment_intents/{id}/cancel","href":"/global-acquiring/v1.6/api-reference/cancel-payment-intent"},{"title":"List all PaymentIntents","deprecated":null,"version":null,"sidebarTitle":"List payment intents","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment_intents","href":"/global-acquiring/v1.6/api-reference/list-payment-intents"}]},{"group":"Payment Attempts","pages":[{"title":"Retrieve a PaymentAttempt","deprecated":null,"version":null,"sidebarTitle":"Retrieve payment attempt","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/payment_attempts/{id}","href":"/global-acquiring/v1.6/api-reference/retrieve-payment-attempt"},{"title":"List all PaymentAttempts","deprecated":null,"version":null,"sidebarTitle":"List payment attempts","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/payment_attempts","href":"/global-acquiring/v1.6/api-reference/list-payment-attempts"}]},{"group":"Payment Refunds","pages":[{"title":"List all refunds","description":"Retrieve a list of refunds with optional filtering","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/refunds","href":"/global-acquiring/v1.6/api-reference/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/refunds","href":"/global-acquiring/v1.6/api-reference/create-refund"},{"title":"Retrieve a refund","description":"Retrieve details of a specific refund by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve refund","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/refunds/{id}","href":"/global-acquiring/v1.6/api-reference/retrieve-refund"}]},{"group":"Payment Reports","pages":[{"title":"Get list of settlements","deprecated":null,"version":null,"sidebarTitle":"Get list of settlements","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/settlements","href":"/global-acquiring/v1.6/api-reference/get-list-of-settlements"}]},{"group":"Payment Balances","pages":[{"title":"Retrieve Balance","deprecated":null,"version":null,"sidebarTitle":"Retrieve balance","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/balances/{currency}","href":"/global-acquiring/v1.6/api-reference/retrieve-balance"},{"title":"List Balances","deprecated":null,"version":null,"sidebarTitle":"List balances","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/balances","href":"/global-acquiring/v1.6/api-reference/list-balances"}]},{"group":"Payment Payouts","pages":[{"title":"Create Payout","deprecated":null,"version":null,"sidebarTitle":"Create payout","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/payout/create","href":"/global-acquiring/v1.6/api-reference/create-payout"},{"title":"Retrieve Payout","deprecated":null,"version":null,"sidebarTitle":"Retrieve payout","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/payout/{payout_id}","href":"/global-acquiring/v1.6/api-reference/retrieve-payout"},{"title":"List all Payouts","deprecated":null,"version":null,"sidebarTitle":"List payouts","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/payout","href":"/global-acquiring/v1.6/api-reference/list-payouts"}]},{"group":"Bank Accounts","pages":[{"title":"Create Bank Account","deprecated":null,"version":null,"sidebarTitle":"Create bank account","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/bankaccount/create","href":"/global-acquiring/v1.6/api-reference/create-bank-account"},{"title":"Retrieve Bank Account","deprecated":null,"version":null,"sidebarTitle":"Retrieve bank account","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/bankaccount/{id}","href":"/global-acquiring/v1.6/api-reference/retrieve-bank-account"},{"title":"Update Bank Account","deprecated":null,"version":null,"sidebarTitle":"Update bank account","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/payment/bankaccount/{id}","href":"/global-acquiring/v1.6/api-reference/update-bank-account"},{"title":"List all Bank Accounts","deprecated":null,"version":null,"sidebarTitle":"List bank accounts","openapi":"/global-acquiring/v1.6/payment.yaml get /v2/payment/bankaccount","href":"/global-acquiring/v1.6/api-reference/list-bank-accounts"}]},{"group":"Terminal Management","pages":[{"title":"Register Terminal","deprecated":null,"version":null,"sidebarTitle":"Register terminal","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/terminal/register","href":"/global-acquiring/v1.6/api-reference/register-terminal"},{"title":"Get PIN Key","deprecated":null,"version":null,"sidebarTitle":"Get pin key","openapi":"/global-acquiring/v1.6/payment.yaml post /v2/terminal/getPinKey","href":"/global-acquiring/v1.6/api-reference/get-pin-key"}]}]}]}]}]},{"product":"Global Account","icon":"building-columns","pages":[{"title":"Global Account","href":"/global-account/v1.6/guide/overview"}]},{"product":"Card Issuance","icon":"credit-card","pages":[{"title":"Card Issuance","href":"/card-issuance/v1.6/guide/overview"}]},{"product":"Stablecoin Account","icon":"arrow-right-arrow-left","pages":[{"title":"Stablecoin Account","href":"/stablecoin-account/v1.6/guide/overview"}]},{"product":"Developer Tools","icon":"code","pages":[{"title":"Developer Tools","href":"/developer-tools/mcp/mcp-integration-guide"}]},{"product":"AI Knowledge Base","icon":"sparkles","pages":[{"title":"AI Knowledge Base","href":"/ai-knowledge-base/card-issuing/corpus_overview"}]}]},{"language":"zh","navbar":{"links":[{"href":"/zh/changelog","label":"更新日志"}]},"pages":[{"title":"zh","href":"/zh/global-acquiring/v1.6/api-reference/create-refund"}]}]},"basePath":"","title":"Create a refund - UQPAY Developer Docs","buildId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","deploymentId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-vlKR2tYY.js","utils-DBDPZSWe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CxHK4zz2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-27b98BOz.js","snippetPresets-DNnui32z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-cDVS2zyo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BEE-OyDQ.js","shallow-fqEMZOYR.js","getApiPlaygroundDisplay-BPut1_OB.js","CodeSnippet-h9vp8UTG.js","CodeSnippets-DoMjCW5Q.js","Page-BOWGOUSK.js","getPastedJson-C4r-hmQ_.js","icon-CCDahfhO.js","MethodPill-Dpq0JSrS.js","DuplicateIcon-BGPwFt-j.js","createIcon-DBULrQp7.js","DynamicMarkdown-B74atANy.js","SectionHeading-DZCpbSmT.js","axios-vUo_bRtp.js","Markdown-BwkgxkAH.js","clsx-CEIlvfOI.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-f6OgbvLC.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DvlTOml0.js"]}