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.
REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the next_action.
REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
FAILED: The PaymentIntent has failed.
PARTIALLY_CAPTURED: A partially captured authorization has an outstanding balance; do not submit another capture.
EXPIRED: The pre-authorization expired and was released.
Remaining pre-authorized amount available for capture. A final capture consumes the available authorization; inspect capture_records for channel processing results.
Aggregate capture amount recorded on the PaymentIntent. Capture acceptance can update this value before channel completion; check capture_records for processing results.
Snapshot of the customer associated with this PaymentIntent. Returned when customer or customer_id was supplied at creation time. The customer's unique identifier is exposed at the top level as customer_id; the id field is not included inside this object.
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API. The provided client_secret is valid for 60 minutes.
Latest PaymentAttempt; null when no payment attempt is available.
Latest payment attempt
No payment attempt
Show child attributes
{"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/retrieve-payment-intent","slug":"/global-acquiring/v1.6/api-reference/retrieve-payment-intent","pageMetadata":{"title":"Retrieve a PaymentIntent","description":"Retrieves the details of a specific payment intent","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","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: \"Retrieves the details of a specific payment intent\"\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":"Retrieve a PaymentIntent","description":"Retrieves the details of a specific payment intent","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/uqpay-ecc4f4d8/77dcf16d44608ed8/error-code-table.js"],"openApiReferenceData":{"operation":{"summary":"Retrieve a PaymentIntent","description":"Retrieves the details of a specific payment intent","operationId":"retrieve-payment-intent","x-mint":{"href":"/global-acquiring/v1.6/api-reference/retrieve-payment-intent"},"tags":["Payment Intents"],"parameters":["64f8a05f-eb6d-476e-b27e-44598083469d","b06e891b-7ca6-4757-98b7-1da0ab1ce0f3","42f9fe7e-eaee-4e10-948e-58bcc6c3839b"],"responses":{"200":"ec5cbcd3-a1f3-4f14-958f-afe7cc73d6d3"},"method":"get","type":"path","servers":["d847b3de-ab64-4f74-88d8-0cd213f288af","ddf4e041-e7fd-46dd-87b9-25d8dd2de8af"],"security":["0b896c3b-909f-48d8-b424-aabe1fc8d157"],"path":"/v2/payment_intents/{id}","baseUrlOptions":["https://api-sandbox.uqpaytech.com/api","https://api.uqpay.com/api"],"title":"Retrieve a PaymentIntent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"64f8a05f-eb6d-476e-b27e-44598083469d":{"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"},"b06e891b-7ca6-4757-98b7-1da0ab1ce0f3":{"name":"id","in":"path","required":true,"description":"The unique ID of a payment intent.","schema":{"type":"string","example":"PI1925112193204883441","isRequired":true,"description":"The unique ID of a payment intent.","uniqueKey":"","typeLabel":"string"}},"42f9fe7e-eaee-4e10-948e-58bcc6c3839b":{"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"}},"responses":{"ec5cbcd3-a1f3-4f14-958f-afe7cc73d6d3":{"description":"Payment intent retrieved successfully","content":{"application/json":{"examples":{"sandbox":{"title":"sandbox","value":{"amount":"1","available_payment_method_types":null,"cancel_time":"2026-09-14T17:03:36+08:00","cancellation_reason":"abandoned","captured_amount":"0","client_secret":"\u003cclient-secret>","complete_time":"2026-09-14T17:03:36+08:00","create_time":"2026-09-14T17:03:35+08:00","currency":"SGD","customer_id":"","description":"Updated contract test","intent_status":"CANCELLED","latest_payment_attempt":null,"merchant_order_id":"ce37d547-53c7-4648-988b-691a352b5446","metadata":null,"next_action":null,"payment_intent_id":"PI2099423807759454208","payment_method_flows":{},"return_url":"https://example.com/return","update_time":"2026-09-14T17:03:36+08:00"}}},"schema":{"type":"object","required":["payment_intent_id","amount","currency","intent_status"],"properties":{"payment_intent_id":{"type":"string","example":"b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6","description":"Unique identifier for the PaymentIntent","maxLength":36,"isRequired":true,"uniqueKey":"payment_intent_id","typeLabel":"string"},"amount":{"type":"string","example":"10.12","description":"Payment amount. This is the order amount you would like to charge your customer.","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","description":"Three-letter currency code","example":"SGD","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"intent_status":{"type":"string","description":"Status of this PaymentIntent.\n\n- `REQUIRES_PAYMENT_METHOD`: The PaymentIntent is waiting for the confirm request.\n- `REQUIRES_CUSTOMER_ACTION`: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the `next_action`.\n- `REQUIRES_CAPTURE`: The PaymentIntent is waiting for your capture to complete the payment.\n- `PENDING`: The PaymentIntent is pending the final result from the provider. No further action is required.\n- `SUCCEEDED`: The PaymentIntent has succeeded. The payment is complete.\n- `CANCELLED`: The PaymentIntent has been canceled by your request. The payment is closed.\n- `FAILED`: The PaymentIntent has failed.\n- `PARTIALLY_CAPTURED`: A partially captured authorization has an outstanding balance; do not submit another capture.\n- `EXPIRED`: The pre-authorization expired and was released.\n","enum":["PARTIALLY_CAPTURED","EXPIRED","REQUIRES_PAYMENT_METHOD","REQUIRES_CUSTOMER_ACTION","REQUIRES_CAPTURE","PENDING","SUCCEEDED","CANCELLED","FAILED"],"example":"SUCCEEDED","isRequired":true,"uniqueKey":"intent_status","typeLabel":"enum\u003cstring>"},"current_funds_action":{"type":"object","description":"Refund or authorization-release details, when available in Retrieve or List PaymentIntents.","uniqueKey":"current_funds_action","typeLabel":"object"},"capture_records":{"type":"array","description":"Capture records returned by Retrieve and List PaymentIntents.","items":{"type":"object","properties":{"capture_id":{"type":"string","description":"Unique identifier of the capture.","uniqueKey":"capture_records.items.[INDEX].capture_id","typeLabel":"string"},"merchant_capture_order_id":{"oneOf":[{"type":"string","description":"Merchant capture reference, if supplied for the capture.","uniqueKey":"capture_records.items.[INDEX].merchant_capture_order_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant capture reference, if supplied for the capture.","uniqueKey":"capture_records.items.[INDEX].merchant_capture_order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"capture_records.items.[INDEX].merchant_capture_order_id","typeLabel":"string | null"},"capture_sequence":{"type":"integer","description":"Sequence of this capture within the authorization.","uniqueKey":"capture_records.items.[INDEX].capture_sequence","typeLabel":"integer"},"capture_amount":{"type":"string","description":"Amount of this capture.","uniqueKey":"capture_records.items.[INDEX].capture_amount","typeLabel":"string"},"currency":{"type":"string","description":"Currency of this capture.","uniqueKey":"capture_records.items.[INDEX].currency","typeLabel":"string"},"capture_mode":{"type":"string","description":"Whether the capture closes the authorization. The capture API accepts only final capture.","enum":["final","non_final"],"uniqueKey":"capture_records.items.[INDEX].capture_mode","typeLabel":"enum\u003cstring>"},"channel_capture_status":{"type":"integer","description":"Processing result: 0 pending, 1 processing, 2 completed, 3 failed. Capture acceptance is not channel completion.","enum":[0,1,2,3],"uniqueKey":"capture_records.items.[INDEX].channel_capture_status","typeLabel":"enum\u003cinteger>"},"arn":{"type":"string","description":"Acquirer reference number, when available.","uniqueKey":"capture_records.items.[INDEX].arn","typeLabel":"string"},"channel_capture_time":{"oneOf":[{"type":"string","description":"Channel capture timestamp, when available.","format":"date-time","uniqueKey":"capture_records.items.[INDEX].channel_capture_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Channel capture timestamp, when available.","format":"date-time","uniqueKey":"capture_records.items.[INDEX].channel_capture_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"capture_records.items.[INDEX].channel_capture_time","typeLabel":"string\u003cdate-time> | null"},"request_time":{"type":"string","description":"Time the capture was requested.","format":"date-time","uniqueKey":"capture_records.items.[INDEX].request_time","typeLabel":"string\u003cdate-time>"},"complete_time":{"oneOf":[{"type":"string","description":"Completion timestamp, when available.","format":"date-time","uniqueKey":"capture_records.items.[INDEX].complete_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Completion timestamp, when available.","format":"date-time","uniqueKey":"capture_records.items.[INDEX].complete_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"capture_records.items.[INDEX].complete_time","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"capture_records.items.[INDEX]","typeLabel":"object"},"uniqueKey":"capture_records","typeLabel":"object[]"},"authorization_type":{"type":"string","description":"Authorization mode for this payment.","enum":["authorization","pre_authorization"],"uniqueKey":"authorization_type","typeLabel":"enum\u003cstring>"},"authorization_expires_at":{"oneOf":[{"type":"string","description":"Pre-authorization expiry. Null when no expiry is recorded. Use the returned time rather than a fixed holding period.","format":"date-time","uniqueKey":"authorization_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Pre-authorization expiry. Null when no expiry is recorded. Use the returned time rather than a fixed holding period.","format":"date-time","uniqueKey":"authorization_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"authorization_expires_at","typeLabel":"string\u003cdate-time> | null"},"available_to_capture":{"type":"string","description":"Remaining pre-authorized amount available for capture. A final capture consumes the available authorization; inspect capture_records for channel processing results.","uniqueKey":"available_to_capture","typeLabel":"string"},"available_to_void":{"type":"string","description":"Remaining pre-authorized amount, equal to available_to_capture. A positive value alone does not mean cancellation is permitted.","uniqueKey":"available_to_void","typeLabel":"string"},"description":{"type":"string","description":"Descriptor while creating a PaymentIntent.","maxLength":255,"uniqueKey":"description","typeLabel":"string"},"available_payment_method_types":{"oneOf":[{"type":"array","description":"Available payment method types for this PaymentIntent.","items":{"type":"string","uniqueKey":"available_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"available_payment_method_types.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Available payment method types for this PaymentIntent.","items":{"type":"string"},"uniqueKey":"available_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"available_payment_method_types","typeLabel":"string[] | null"},"captured_amount":{"type":"string","example":"10.12","description":"Aggregate capture amount recorded on the PaymentIntent. Capture acceptance can update this value before channel completion; check capture_records for processing results.","uniqueKey":"captured_amount","typeLabel":"string"},"customer":{"type":"object","properties":{"id":{"type":"string","description":"Unique customer ID","example":"cus_hkduz3gvz1feg25e87fjcahsxq","uniqueKey":"customer.id","typeLabel":"string"},"external_customer_id":{"type":"string","description":"Identifier for the customer in your own system, echoed back when supplied at creation time.","example":"CUS_1715740800123","maxLength":128,"uniqueKey":"customer.external_customer_id","typeLabel":"string"},"first_name":{"type":"string","description":"Customer's first name","example":"John","maxLength":64,"uniqueKey":"customer.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Customer's last name","example":"Doe","maxLength":64,"uniqueKey":"customer.last_name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Customer's email address","example":"[email protected]","maxLength":254,"uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","description":"Customer's phone number","example":"+1 123456789","maxLength":32,"uniqueKey":"customer.phone_number","typeLabel":"string"},"address":{"type":"object","required":["country_code","city","street","postcode"],"properties":{"country_code":{"type":"string","description":"The two-letter country code in ISO 3166-1 alpha-2 format.","minLength":2,"maxLength":2,"example":"SG","isRequired":true,"uniqueKey":"customer.address.country_code","typeLabel":"string"},"city":{"type":"string","description":"City of the address. Maximum of 100 characters.","maxLength":100,"example":"Singapore","isRequired":true,"uniqueKey":"customer.address.city","typeLabel":"string"},"street":{"type":"string","description":"Street of the address. Maximum of 100 characters.","maxLength":100,"example":"444 Orchard Rd, Midpoint Orchard, Singapore ","isRequired":true,"uniqueKey":"customer.address.street","typeLabel":"string"},"postcode":{"type":"string","description":"Postcode of the address. Maximum of 10 characters.","maxLength":10,"example":"924011","isRequired":true,"uniqueKey":"customer.address.postcode","typeLabel":"string"},"state":{"type":"string","description":"State or province of the address. Maximum of 100 characters.\n\n- Required when `country_code` is \"US\" or \"CA\".\n","maxLength":100,"example":"","uniqueKey":"customer.address.state","typeLabel":"string"}},"uniqueKey":"customer.address","typeLabel":"object"},"metadata":{"additionalProperties":{"maxLength":512,"type":"string","uniqueKey":"customer.metadata.additionalProperties","typeLabel":"string"},"example":{"key1":"value1","key2":"value2"},"description":"Any key-value object. Max length = 512 bytes. This must be valid JSON data.","type":"object","uniqueKey":"customer.metadata","typeLabel":"object"},"create_time":{"type":"string","format":"date/time","example":"2025-03-21T17:17:32+08:00","description":"Last time at which this customer was created.","uniqueKey":"customer.create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2025-03-21T17:17:32+08:00","description":"Last time at which this customer was updated or operated on.","uniqueKey":"customer.update_time","typeLabel":"string\u003cdate/time>"}},"description":"Snapshot of the customer associated with this PaymentIntent. Returned when `customer` or `customer_id` was supplied at creation time. The customer's unique identifier is exposed at the top level as `customer_id`; the `id` field is not included inside this object.","uniqueKey":"customer","typeLabel":"object"},"customer_id":{"type":"string","description":"ID of the customer associated with this PaymentIntent. Empty for guest checkout.","example":"cus_asyknf3wlfxhs1s6plamk80i8v","maxLength":36,"uniqueKey":"customer_id","typeLabel":"string"},"cancel_time":{"oneOf":[{"type":"string","title":"Event timestamp","description":"Cancellation timestamp; an empty string when no cancellation time is recorded.","format":"date-time","uniqueKey":"cancel_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","title":"Event time unavailable","description":"Cancellation timestamp; an empty string when no cancellation time is recorded.","enum":[""],"uniqueKey":"cancel_time.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"cancel_time","typeLabel":"string\u003cdate-time> | enum\u003cstring>"},"cancellation_reason":{"type":"string","description":"Reason for canceling this PaymentIntent.","example":"Order cancelled","uniqueKey":"cancellation_reason","typeLabel":"string"},"client_secret":{"type":"string","description":"PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API. The provided client_secret is valid for 60 minutes.","example":"eyJhbGciOiJI***********ujNdZ1DF9CqWEfF1jphxI","uniqueKey":"client_secret","typeLabel":"string"},"merchant_order_id":{"type":"string","maxLength":36,"description":"The merchant reference id created in merchant's system that corresponds to this PaymentIntent","example":"1bf70d90-9ed0-48ce-9370-9bd7ef6ab9ee","uniqueKey":"merchant_order_id","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"maxLength":512,"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Metadata associated with the payment. Returns `null` when no metadata is set.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"maxLength":512,"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Metadata associated with the payment. Returns `null` when no metadata is set.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"next_action":{"oneOf":[{"type":"object","description":"Null when no next action is available; otherwise follow the returned action instructions.","required":["type"],"properties":{"type":{"type":"string","description":"The type of action required to continue the payment.\n- `redirect_to_url`: Redirect the customer to a URL for authentication (e.g., 3DS verification or wallet login).\n- `display_qr_code`: Display a QR code for the customer to scan with their payment app.\n- `display_bank_details`: Display bank account details for the customer to complete a manual bank transfer.\n- `redirect_iframe`: Embed the provided iframe HTML into your page to display an inline authentication interface.\n","enum":["redirect_to_url","display_qr_code","display_bank_details","redirect_iframe"],"isRequired":true,"uniqueKey":"next_action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"redirect_to_url":{"type":"object","description":"Contains instructions for authenticating a payment by redirecting your customer to another page or application.","properties":{"url":{"type":"string","format":"uri","description":"The URL you must redirect your customer to in order to authenticate the payment.","example":"https://example.checkout-page.com","uniqueKey":"next_action.oneOf.0.redirect_to_url.url","typeLabel":"string\u003curi>"},"return_url":{"oneOf":[{"type":"string","title":"Return URL","description":"Return URL after authentication; empty when no return URL is provided.","format":"uri","minLength":1,"example":"https://example.payment-result-page.com","uniqueKey":"next_action.oneOf.0.redirect_to_url.return_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"string","title":"No return URL","description":"Return URL after authentication; empty when no return URL is provided.","enum":[""],"example":"https://example.payment-result-page.com","uniqueKey":"next_action.oneOf.0.redirect_to_url.return_url.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"next_action.oneOf.0.redirect_to_url.return_url","typeLabel":"string\u003curi> | enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.0.redirect_to_url","typeLabel":"object"},"redirect_iframe":{"type":"object","description":"Contains instructions for authenticating a payment using an iframe embed method. The client needs to embed the returned iframe script content into their page to complete the payment authentication flow.","properties":{"iframe":{"type":"string","format":"html","description":"Complete iframe HTML script content containing the authentication page embed code. The client must directly embed this script into their page to display the authentication interface.","uniqueKey":"next_action.oneOf.0.redirect_iframe.iframe","typeLabel":"string\u003chtml>"}},"uniqueKey":"next_action.oneOf.0.redirect_iframe","typeLabel":"object"},"display_qr_code":{"type":"object","description":"The field that contains QR code info.","properties":{"qr_code_url":{"type":"string","description":"The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.","example":"https://sg-acquiring-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/payment/20250829/qrcode_PA1961262701099356160?X-Amz-Algorithm=AWS4-HMAC-SHA256\\u0026X-Amz-Credential=ASIAY******f987429","uniqueKey":"next_action.oneOf.0.display_qr_code.qr_code_url","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","description":"The date (unix timestamp) when the QR code expires.","uniqueKey":"next_action.oneOf.0.display_qr_code.expires_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"next_action.oneOf.0.display_qr_code","typeLabel":"object"},"display_bank_details":{"type":"object","description":"Contains the bank transfer details necessary for the customer to complete the payment.","properties":{"bank_name":{"type":"string","description":"The bank name of the account.","uniqueKey":"next_action.oneOf.0.display_bank_details.bank_name","typeLabel":"string"},"account_number":{"type":"string","description":"The account number.","example":"GB71950018692652646598","uniqueKey":"next_action.oneOf.0.display_bank_details.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"The routing number.","example":"012345678","uniqueKey":"next_action.oneOf.0.display_bank_details.routing_number","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.0.display_bank_details","typeLabel":"object"}},"uniqueKey":"next_action.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null when no next action is available; otherwise follow the returned action instructions.","required":["type"],"properties":{"type":{"type":"string","description":"The type of action required to continue the payment.\n- `redirect_to_url`: Redirect the customer to a URL for authentication (e.g., 3DS verification or wallet login).\n- `display_qr_code`: Display a QR code for the customer to scan with their payment app.\n- `display_bank_details`: Display bank account details for the customer to complete a manual bank transfer.\n- `redirect_iframe`: Embed the provided iframe HTML into your page to display an inline authentication interface.\n","enum":["redirect_to_url","display_qr_code","display_bank_details","redirect_iframe"]},"redirect_to_url":{"type":"object","description":"Contains instructions for authenticating a payment by redirecting your customer to another page or application.","properties":{"url":{"type":"string","format":"uri","description":"The URL you must redirect your customer to in order to authenticate the payment.","example":"https://example.checkout-page.com"},"return_url":{"oneOf":[{"type":"string","title":"Return URL","description":"Return URL after authentication; empty when no return URL is provided.","format":"uri","minLength":1,"example":"https://example.payment-result-page.com"},{"type":"string","title":"No return URL","description":"Return URL after authentication; empty when no return URL is provided.","enum":[""],"example":"https://example.payment-result-page.com"}]}}},"redirect_iframe":{"type":"object","description":"Contains instructions for authenticating a payment using an iframe embed method. The client needs to embed the returned iframe script content into their page to complete the payment authentication flow.","properties":{"iframe":{"type":"string","format":"html","description":"Complete iframe HTML script content containing the authentication page embed code. The client must directly embed this script into their page to display the authentication interface."}}},"display_qr_code":{"type":"object","description":"The field that contains QR code info.","properties":{"qr_code_url":{"type":"string","description":"The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.","example":"https://sg-acquiring-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/payment/20250829/qrcode_PA1961262701099356160?X-Amz-Algorithm=AWS4-HMAC-SHA256\\u0026X-Amz-Credential=ASIAY******f987429"},"expires_at":{"type":"string","format":"date-time","description":"The date (unix timestamp) when the QR code expires."}}},"display_bank_details":{"type":"object","description":"Contains the bank transfer details necessary for the customer to complete the payment.","properties":{"bank_name":{"type":"string","description":"The bank name of the account."},"account_number":{"type":"string","description":"The account number.","example":"GB71950018692652646598"},"routing_number":{"type":"string","description":"The routing number.","example":"012345678"}}}},"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action","typeLabel":"object | null"},"return_url":{"type":"string","description":"The web page URL or application scheme URI to redirect the customer after payment authentication.","example":"https://127.0.0.1:8080/api/v1/callback","uniqueKey":"return_url","typeLabel":"string"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Time at which this PaymentIntent was created.","uniqueKey":"create_time","typeLabel":"string\u003cdate/time>"},"complete_time":{"oneOf":[{"type":"string","title":"Event timestamp","description":"Completion timestamp; an empty string when no completion time is recorded.","format":"date-time","uniqueKey":"complete_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","title":"Event time unavailable","description":"Completion timestamp; an empty string when no completion time is recorded.","enum":[""],"uniqueKey":"complete_time.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"complete_time","typeLabel":"string\u003cdate-time> | enum\u003cstring>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Last time at which this PaymentIntent was updated or operated on.","uniqueKey":"update_time","typeLabel":"string\u003cdate/time>"},"latest_payment_attempt":{"oneOf":[{"type":"object","title":"Latest payment attempt","description":"Latest PaymentAttempt; null when no payment attempt is available.","required":["attempt_id","amount","currency"],"properties":{"attempt_id":{"type":"string","description":"Unique identifier for the attempt.","example":"24fc62b4-90d1-42e3-96ab-dd54ccc648b3","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.attempt_id","typeLabel":"string"},"amount":{"type":"string","example":"9.98","description":"Amount of the PaymentAttempt.","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"Three-letter currency code","example":"SGD","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.currency","typeLabel":"string"},"authorization_type":{"type":"string","description":"Authorization mode for this payment.","enum":["authorization","pre_authorization"],"uniqueKey":"latest_payment_attempt.oneOf.0.authorization_type","typeLabel":"enum\u003cstring>"},"refunded_amount":{"type":"string","description":"Refunded amount.","example":"0.00","uniqueKey":"latest_payment_attempt.oneOf.0.refunded_amount","typeLabel":"string"},"create_time":{"type":"string","format":"date/time","example":"2025-03-21T17:17:32+08:00","description":"The time at which this PaymentAttempt was created.","uniqueKey":"latest_payment_attempt.oneOf.0.create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2025-03-21T17:17:32+08:00","description":"Last time at which this PaymentAttempt was updated or operated on.","uniqueKey":"latest_payment_attempt.oneOf.0.update_time","typeLabel":"string\u003cdate/time>"},"complete_time":{"oneOf":[{"type":"string","title":"Event timestamp","description":"Completion timestamp; an empty string when no completion time is recorded.","format":"date-time","uniqueKey":"latest_payment_attempt.oneOf.0.complete_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","title":"Event time unavailable","description":"Completion timestamp; an empty string when no completion time is recorded.","enum":[""],"uniqueKey":"latest_payment_attempt.oneOf.0.complete_time.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"latest_payment_attempt.oneOf.0.complete_time","typeLabel":"string\u003cdate-time> | enum\u003cstring>"},"cancellation_reason":{"type":"string","description":"Reason for canceling this PaymentIntent.","example":"Order cancelled","uniqueKey":"latest_payment_attempt.oneOf.0.cancellation_reason","typeLabel":"string"},"auth_code":{"type":"string","description":"Authorization code returned by the issuer upon successful authorization.","example":"A12B3C","uniqueKey":"latest_payment_attempt.oneOf.0.auth_code","typeLabel":"string"},"arn":{"type":"string","description":"Acquirer Reference Number (ARN). A 23-digit identifier used for cross-institution reconciliation and chargeback tracking.","example":"74537604221222132710572","uniqueKey":"latest_payment_attempt.oneOf.0.arn","typeLabel":"string"},"rrn":{"type":"string","description":"Retrieval Reference Number (RRN). A 12-digit identifier used for transaction lookup and customer service queries.","example":"123456789012","uniqueKey":"latest_payment_attempt.oneOf.0.rrn","typeLabel":"string"},"advice_code":{"type":"string","description":"An empty string means no advice code was provided.\n\nIssuer advice code indicating the recommended action after a decline. Helps merchants implement intelligent retry strategies.\n\n- `01`: New attempt may succeed. Retry recommended.\n- `02`: Do not retry. Try a different payment method.\n- `03`: Do not retry. Cardholder should contact their issuer.\n- `21`: Cancel all pending authorizations. Card may be compromised.\n- `85`: Do not retry. Issuer will not approve this transaction type.\n","enum":["01","02","03","21","85",""],"example":"01","uniqueKey":"latest_payment_attempt.oneOf.0.advice_code","typeLabel":"enum\u003cstring>"},"authentication_data":{"type":"object","description":"Authentication and verification data for this payment attempt.","properties":{"cvv_result":{"type":"string","description":"An empty string means no verification result is available.\n\nCVV/CVC verification result returned by the issuer.\n\n- `M`: Match.\n- `N`: No match.\n- `P`: Not processed.\n- `U`: Unsupported.\n","enum":["M","N","P","U",""],"uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.cvv_result","typeLabel":"enum\u003cstring>"},"avs_result":{"type":"string","description":"Address Verification System (AVS) result. Indicates whether the billing address provided matches the issuer's records.","example":"Y","uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.avs_result","typeLabel":"string"},"three_ds":{"type":"object","properties":{"three_ds_version":{"type":"string","description":"The 3D Secure protocol version used for authentication.","example":"2.2.0","uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds.three_ds_version","typeLabel":"string"},"eci":{"type":"string","description":"Electronic Commerce Indicator. A two-digit code indicating the security level of the transaction and the liability shift outcome.","example":"05","uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds.eci","typeLabel":"string"},"cavv":{"type":"string","description":"Cardholder Authentication Verification Value. A cryptographic value generated by the issuer's Access Control Server confirming successful authentication.","example":"AAABCZIhcQAAAABZlyFxAAAAAAA=","uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds.cavv","typeLabel":"string"},"three_ds_authentication_status":{"type":"string","description":"An empty string means no authentication result is available.\n\nThe result of the 3DS authentication.\n\n- `Y`: Authentication successful.\n- `A`: Authentication attempted. Liability shift is granted but full authentication was not completed.\n- `N`: Authentication failed or denied.\n- `U`: Authentication could not be performed due to technical or other issues.\n- `R`: Authentication rejected by the issuer.\n- `C`: Challenge required. Additional verification steps are needed.\n","example":"Y","enum":["Y","A","N","U","R","C",""],"uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds.three_ds_authentication_status","typeLabel":"enum\u003cstring>"},"three_ds_cancellation_reason":{"type":"string","description":"The reason the 3DS authentication flow was cancelled, if applicable.","example":"01","uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds.three_ds_cancellation_reason","typeLabel":"string"}},"uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data.three_ds","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.authentication_data","typeLabel":"object"},"payment_method":{"oneOf":[{"type":"object","title":"card","description":"The payment method details used for this PaymentAttempt.","required":["type","card"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.type","typeLabel":"enum\u003cstring>"},"card":{"type":"object","required":["card_name","card_number","network","authorization_type"],"properties":{"card_name":{"type":"string","description":"Card holder name. Maximum length is 128.","example":"john doe","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.card_name","typeLabel":"string"},"card_number":{"type":"string","description":"Masked card number. First 6 digits (BIN) and last 4 digits are visible.","example":"541333******4047","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.card_number","typeLabel":"string"},"network":{"type":"string","description":"The card network. Examples include `visa`, `mastercard`, `unionpay`.","enum":["visa","mastercard","unionpay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.network","typeLabel":"enum\u003cstring>"},"authorization_type":{"type":"string","description":"Authorization mode. Pre-authorization requires account and channel support and auto_capture=false. Match the top-level authorization_type when both are supplied. Use authorization_expires_at from the response for the holding deadline.","enum":["authorization","pre_authorization"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.authorization_type","typeLabel":"enum\u003cstring>"},"brand":{"type":"string","description":"The card brand.","example":"visa","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.brand","typeLabel":"string"},"bin":{"type":"string","description":"Bank Identification Number. The first 6–8 digits of the card number identifying the issuing institution.","example":"541333","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.bin","typeLabel":"string"},"last4":{"type":"string","description":"The last four digits of the card number.","example":"4047","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.last4","typeLabel":"string"},"card_type":{"type":"string","description":"The card funding type.","enum":["credit","debit","prepaid"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.card_type","typeLabel":"enum\u003cstring>"},"expiry_month":{"type":"string","description":"Two-digit expiry month of the card.","example":"12","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.expiry_month","typeLabel":"string"},"expiry_year":{"type":"string","description":"Four-digit expiry year of the card.","example":"2027","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.expiry_year","typeLabel":"string"},"billing":{"description":"Billing information of the customer.","type":"object","required":["first_name","last_name","email","address"],"properties":{"first_name":{"type":"string","description":"First name of the customer. Maximum length is 128.","maxLength":128,"example":"John","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the customer. Maximum length is 128.","maxLength":128,"example":"Doe","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.last_name","typeLabel":"string"},"email":{"type":"string","description":"Email address of the customer.","maxLength":225,"example":"[email protected]","format":"email","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.email","typeLabel":"string\u003cemail>"},"address":{"type":"object","required":["country_code","city","street","postcode"],"properties":{"country_code":{"type":"string","description":"The two-letter country code in ISO 3166-1 alpha-2 format.","minLength":2,"maxLength":2,"example":"SG","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address.country_code","typeLabel":"string"},"city":{"type":"string","description":"City of the address. Maximum of 100 characters.","maxLength":100,"example":"Singapore","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address.city","typeLabel":"string"},"street":{"type":"string","description":"Street of the address. Maximum of 100 characters.","maxLength":100,"example":"444 Orchard Rd, Midpoint Orchard, Singapore ","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address.street","typeLabel":"string"},"postcode":{"type":"string","description":"Postcode of the address. Maximum of 10 characters.","maxLength":10,"example":"924011","isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address.postcode","typeLabel":"string"},"state":{"type":"string","description":"State or province of the address. Maximum of 100 characters.\n\n- Required when `country_code` is \"US\" or \"CA\".\n","maxLength":100,"example":"","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address.state","typeLabel":"string"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.address","typeLabel":"object"},"phone_number":{"type":"string","description":"Phone number of the customer.","maxLength":36,"example":"12025550123","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing.phone_number","typeLabel":"string"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.billing","typeLabel":"object"},"auto_capture":{"type":"boolean","default":true,"description":"Specifies whether the funds should be requested automatically after the payment is authorized. Default to `true`. Set it to `false` if you want to capture the funds sometimes later.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card.auto_capture","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0.card","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.0","typeLabel":"card · object"},{"type":"object","title":"applepay","description":"The payment method details used for this PaymentAttempt.","required":["type","applepay"],"properties":{"type":{"type":"string","enum":["applepay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.type","typeLabel":"enum\u003cstring>"},"applepay":{"type":"object","description":"Apple Pay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["redirect","mobile_web","mobile_app","contactless"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.is_present","typeLabel":"boolean"},"network":{"type":"string","enum":["visa","mastercard","amex","discover","jcb"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.network","typeLabel":"enum\u003cstring>"},"card_type":{"type":"string","description":"The type of card used (e.g., credit, debit).","enum":["debit","credit"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.card_type","typeLabel":"enum\u003cstring>"},"token_type":{"type":"string","enum":["decrypted","encrypted"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.token_type","typeLabel":"enum\u003cstring>"},"auth_method":{"type":"string","enum":["cryptogram_3ds","pan_only"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay.auth_method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1.applepay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.1","typeLabel":"applepay · object"},{"type":"object","title":"googlepay","description":"The payment method details used for this PaymentAttempt.","required":["type","googlepay"],"properties":{"type":{"type":"string","enum":["googlepay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.type","typeLabel":"enum\u003cstring>"},"googlepay":{"type":"object","description":"Google Pay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["redirect","mobile_web","mobile_app","contactless"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.is_present","typeLabel":"boolean"},"network":{"type":"string","enum":["visa","mastercard","amex","discover","jcb"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.network","typeLabel":"enum\u003cstring>"},"card_type":{"type":"string","description":"The type of card used (e.g., credit, debit).","enum":["debit","credit"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.card_type","typeLabel":"enum\u003cstring>"},"token_type":{"type":"string","enum":["decrypted","encrypted"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.token_type","typeLabel":"enum\u003cstring>"},"auth_method":{"type":"string","enum":["cryptogram_3ds","pan_only"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay.auth_method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2.googlepay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.2","typeLabel":"googlepay · object"},{"type":"object","title":"alipaycn","description":"The payment method details used for this PaymentAttempt.","required":["type","alipaycn"],"properties":{"type":{"type":"string","enum":["alipaycn"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3.type","typeLabel":"enum\u003cstring>"},"alipaycn":{"type":"object","description":"AlipayCN payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3.alipaycn.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3.alipaycn.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3.alipaycn.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3.alipaycn","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.3","typeLabel":"alipaycn · object"},{"type":"object","title":"alipayhk","description":"The payment method details used for this PaymentAttempt.","required":["type","alipayhk"],"properties":{"type":{"type":"string","enum":["alipayhk"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4.type","typeLabel":"enum\u003cstring>"},"alipayhk":{"type":"object","description":"AlipayHK payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4.alipayhk.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4.alipayhk.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4.alipayhk.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4.alipayhk","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.4","typeLabel":"alipayhk · object"},{"type":"object","title":"unionpay","description":"The payment method details used for this PaymentAttempt.","required":["type","unionpay"],"properties":{"type":{"type":"string","enum":["unionpay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5.type","typeLabel":"enum\u003cstring>"},"unionpay":{"type":"object","description":"UnionPay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode","securepay"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5.unionpay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5.unionpay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5.unionpay.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5.unionpay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.5","typeLabel":"unionpay · object"},{"type":"object","title":"wechatpay","description":"The payment method details used for this PaymentAttempt.","required":["type","wechatpay"],"properties":{"type":{"type":"string","enum":["wechatpay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6.type","typeLabel":"enum\u003cstring>"},"wechatpay":{"type":"object","description":"WeChat Pay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode","mini_program","mobile_app","mobile_web","official_account"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6.wechatpay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"Customer device operating system; empty when not supplied for the payment flow.","enum":["ios","android",""],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6.wechatpay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6.wechatpay.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6.wechatpay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.6","typeLabel":"wechatpay · object"},{"type":"object","title":"grabpay","description":"The payment method details used for this PaymentAttempt.","required":["type","grabpay"],"properties":{"type":{"type":"string","enum":["grabpay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.type","typeLabel":"enum\u003cstring>"},"grabpay":{"type":"object","description":"GrabPay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.grabpay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"Customer device operating system; empty when not supplied for the payment flow.","enum":["ios","android",""],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.grabpay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.grabpay.is_present","typeLabel":"boolean"},"shopper_name":{"type":"string","description":"The name of the shopper.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.grabpay.shopper_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7.grabpay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.7","typeLabel":"grabpay · object"},{"type":"object","title":"crypto","description":"The payment method details used for this PaymentAttempt.","required":["type","crypto"],"properties":{"type":{"type":"string","enum":["crypto"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8.type","typeLabel":"enum\u003cstring>"},"crypto":{"type":"object","description":"Cryptocurrency payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["redirect","qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8.crypto.flow","typeLabel":"enum\u003cstring>"},"network":{"type":"string","enum":["ETH","TRON"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8.crypto.network","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8.crypto.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8.crypto","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.8","typeLabel":"crypto · object"},{"type":"object","title":"paynow","description":"The payment method details used for this PaymentAttempt.","required":["type","paynow"],"properties":{"type":{"type":"string","enum":["paynow"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.9.type","typeLabel":"enum\u003cstring>"},"paynow":{"type":"object","description":"PayNow payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.9.paynow.flow","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.9.paynow.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.9.paynow","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.9","typeLabel":"paynow · object"},{"type":"object","title":"truemoney","description":"The payment method details used for this PaymentAttempt.","required":["type","truemoney"],"properties":{"type":{"type":"string","enum":["truemoney"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10.type","typeLabel":"enum\u003cstring>"},"truemoney":{"type":"object","description":"Truemoney payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10.truemoney.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10.truemoney.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10.truemoney.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10.truemoney","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.10","typeLabel":"truemoney · object"},{"type":"object","title":"tng","description":"The payment method details used for this PaymentAttempt.","required":["type","tng"],"properties":{"type":{"type":"string","enum":["tng"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11.type","typeLabel":"enum\u003cstring>"},"tng":{"type":"object","description":"Touch'n Go payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11.tng.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device. An empty string means the operating system was not provided.","enum":["ios","android",""],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11.tng.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11.tng.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11.tng","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.11","typeLabel":"tng · object"},{"type":"object","title":"gcash","description":"The payment method details used for this PaymentAttempt.","required":["type","gcash"],"properties":{"type":{"type":"string","enum":["gcash"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12.type","typeLabel":"enum\u003cstring>"},"gcash":{"type":"object","description":"GCash payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12.gcash.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12.gcash.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12.gcash.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12.gcash","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.12","typeLabel":"gcash · object"},{"type":"object","title":"dana","description":"The payment method details used for this PaymentAttempt.","required":["type","dana"],"properties":{"type":{"type":"string","enum":["dana"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13.type","typeLabel":"enum\u003cstring>"},"dana":{"type":"object","description":"Dana payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13.dana.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13.dana.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13.dana.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13.dana","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.13","typeLabel":"dana · object"},{"type":"object","title":"kakaopay","description":"The payment method details used for this PaymentAttempt.","required":["type","kakaopay"],"properties":{"type":{"type":"string","enum":["kakaopay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14.type","typeLabel":"enum\u003cstring>"},"kakaopay":{"type":"object","description":"KakaoPay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14.kakaopay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14.kakaopay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14.kakaopay.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14.kakaopay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.14","typeLabel":"kakaopay · object"},{"type":"object","title":"toss","description":"The payment method details used for this PaymentAttempt.","required":["type","toss"],"properties":{"type":{"type":"string","enum":["toss"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15.type","typeLabel":"enum\u003cstring>"},"toss":{"type":"object","description":"Toss Pay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15.toss.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15.toss.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15.toss.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15.toss","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.15","typeLabel":"toss · object"},{"type":"object","title":"naverpay","description":"The payment method details used for this PaymentAttempt.","required":["type","naverpay"],"properties":{"type":{"type":"string","enum":["naverpay"],"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16.type","typeLabel":"enum\u003cstring>"},"naverpay":{"type":"object","description":"Naver Pay payment information returned in the response.","properties":{"flow":{"type":"string","description":"The checkout flow used for this payment.","enum":["qrcode"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16.naverpay.flow","typeLabel":"enum\u003cstring>"},"os_type":{"type":"string","description":"The operating system type of the customer device.","enum":["ios","android"],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16.naverpay.os_type","typeLabel":"enum\u003cstring>"},"is_present":{"type":"boolean","description":"Whether this is an in-person (offline) payment.","uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16.naverpay.is_present","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16.naverpay","typeLabel":"object"}},"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method.oneOf.16","typeLabel":"naverpay · object"}],"uniqueKey":"latest_payment_attempt.oneOf.0.payment_method","typeLabel":"card · object | applepay · object | googlepay · object | alipaycn · object | alipayhk · object | unionpay · object | wechatpay · object | grabpay · object | crypto · object | paynow · object | truemoney · object | tng · object | gcash · object | dana · object | kakaopay · object | toss · object | naverpay · object"},"failure_code":{"type":"string","description":"PaymentAttempt failure code. Possible values are defined in [Error Code Reference.payment_error](/global-acquiring/v1.6/guide/error-codes) section.","example":"","uniqueKey":"latest_payment_attempt.oneOf.0.failure_code","typeLabel":"string"},"attempt_status":{"type":"string","description":"The status of the attempt.\n- `INITIATED`: The payment attempt has been created based on the initial request.\n- `AUTHENTICATION_REDIRECTED`: Waiting for the customer to complete identity verification, such as 3D Secure or QR code scanning.\n- `PENDING_AUTHORIZATION`: The authorization request has been received and is pending a final decision from the payment provider.\n- `AUTHORIZED`: The authorization has been successfully completed. Payment will be captured automatically or manually depending on configuration.\n- `CAPTURE_REQUESTED`: The capture request has been submitted successfully, and the payment is considered complete.\n- `SETTLED`: Funds have been settled from the payment provider and received by UQPAY.\n- `SUCCEEDED`: UQPAY has settled funds to your wallet.\n- `CANCELLED`: The payment attempt has been cancelled. Any authorized funds, if applicable, will be returned to the customer.\n- `EXPIRED`: The payment attempt was not completed within the allowed time window and has expired.\n- `FAILED`: The payment attempt has failed. Please create a new PaymentAttempt to retry.\n","example":"INITIATED","enum":["INITIATED","AUTHENTICATION_REDIRECTED","PENDING_AUTHORIZATION","AUTHORIZED","CAPTURE_REQUESTED","SETTLED","SUCCEEDED","CANCELLED","EXPIRED","FAILED"],"uniqueKey":"latest_payment_attempt.oneOf.0.attempt_status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"latest_payment_attempt.oneOf.0","typeLabel":"Latest payment attempt · object"},{"type":"object","title":"No payment attempt","description":"Latest PaymentAttempt; null when no payment attempt is available.","enum":[null],"uniqueKey":"latest_payment_attempt.oneOf.1","typeLabel":"No payment attempt · object"},{"type":"null","title":"No payment attempt","description":"Latest PaymentAttempt; null when no payment attempt is available.","enum":[null],"uniqueKey":"latest_payment_attempt.oneOf.2","typeLabel":"null"}],"uniqueKey":"latest_payment_attempt","typeLabel":"Latest payment attempt · object | No payment attempt · object | null"}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"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":"Retrieve a PaymentIntent - UQPAY Developer Docs","navMaps":{"firstHrefInVersion":{"v1.6":{"href":"/global-acquiring/v1.6/api-reference/retrieve-payment-intent","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/global-acquiring/v1.6/api-reference/retrieve-payment-intent","matchLevel":0},"zh":{"href":"/zh/global-acquiring/v1.6/api-reference/retrieve-payment-intent","matchLevel":1}}},"lastModified":"2026-09-26T14:19:00.549Z","originalFileLocation":"global-acquiring/v1.6/api-reference/retrieve-payment-intent.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=\"Retrieves the details of a specific payment intent\">\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=\"Retrieve a PaymentIntent - UQPAY Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the details of a specific payment intent\">\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/retrieve-payment-intent\">\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+Intents\u0026amp;title=Retrieve+a+PaymentIntent\u0026amp;description=Retrieves+the+details+of+a+specific+payment+intent\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=0533665c5993d5b59e7edf49f55de0c9caad91e503bacff6ce5463081c274fcc\">\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=\"Retrieve a PaymentIntent - UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the details of a specific payment intent\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uqpay-ecc4f4d8.mintlify.app/_mintlify/api/og/v2?division=Payment+Intents\u0026amp;title=Retrieve+a+PaymentIntent\u0026amp;description=Retrieves+the+details+of+a+specific+payment+intent\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=0533665c5993d5b59e7edf49f55de0c9caad91e503bacff6ce5463081c274fcc\">\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/retrieve-payment-intent\">\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/retrieve-payment-intent.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://developers-sandbox.uqpaytech.com/docs/zh/global-acquiring/v1.6/api-reference/retrieve-payment-intent\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent\">\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/retrieve-payment-intent#webpage\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent\",\"name\":\"Retrieve a PaymentIntent\",\"description\":\"Retrieves the details of a specific payment intent\",\"dateModified\":\"2026-09-26T14:19:00.549Z\",\"isPartOf\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent#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 Intents\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/create-payment-intent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a PaymentIntent\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent#apireference\",\"headline\":\"Retrieve a PaymentIntent\",\"name\":\"Retrieve a PaymentIntent\",\"description\":\"Retrieves the details of a specific payment intent\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent\",\"mainEntityOfPage\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-acquiring/v1.6/api-reference/retrieve-payment-intent#webpage\"},\"dateModified\":\"2026-09-26T14:19:00.549Z\",\"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","description":"Creates a new payment intent to process a payment.\nAfter the PaymentIntent is created, attach a payment method and `confirm` API to continue the payment.\n","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","description":"Updates properties on a PaymentIntent object without confirming. Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the `payment_method` always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.","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","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","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/retrieve-payment-intent"}]}]},"basePath":"","title":"Retrieve a PaymentIntent - 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"]}