{
"errorCode": "bad_request",
"errorDescription": "Failed to read request"
}
Payments
Get Intent
You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it’s a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.
A collection of key-value pairs that were provided when the object was created. These metadata values are echoed back in the response, allowing you to store and retrieve custom information such as context-specific attributes, references, or tags. This can be useful for correlating records in your system or attaching meaningful context to transactions.
Show child attributes
Example:
{ "orderId": "12345", "customerNote": "Deliver after 5 PM" }
The payment method associated with a successful intent. See Payment Methods for the full list of supported payment methods and their availability.
Available options:
CARD,
GOOGLE_PAY,
APPLE_PAY,
PAYPAL,
AMAZON_PAY,
CASH_APP,
KLARNA,
AFTERPAY,
AFFIRM,
VENMO,
CARD_INSTALLMENT
Example:
"CARD"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"xPay","colors":{"primary":"#3bc2ff","light":"#3bc2ff","dark":"#0331ff"},"logo":{"light":"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/light.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=007fbae209bf88bae6f124ed06a79e04","dark":"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/dark.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=d445abb6483342208e929b08ec3a86b1","href":"https://xpaycheckout.com"},"favicon":"https://mintcdn.com/xpay/REkE_HjmjRViMmXV/favicon.png?fit=max\u0026auto=format\u0026n=REkE_HjmjRViMmXV\u0026q=85\u0026s=e98a1531e8c761f704c90cd01c2df5ff","api":{"mdx":{"auth":{"method":"basic","name":"[usernameName]:[passwordName]"},"server":"https://api.xpaycheckout.com"}},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:hello@xpaycheckout.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.xpaycheckout.com"}},"footer":{"socials":{"website":"https://www.xpaycheckout.com/","linkedin":"https://www.linkedin.com/company/xpay-checkout"}},"integrations":{"posthog":{"apiKey":"phc_7aJLSdii3o5FaFeGUyQGl2x4Hf8K133tfU4zkmuE3sY"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"xpay","hasAudioNarration":false,"actualSubdomain":"xpay","customDomains":["docs.xpaycheckout.com"],"gitSource":{"type":"github","owner":"xpay-technologies","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf0312808b7de58450a89b","collectionId":"167099e3-c643-4d27-8889-6b517b5adbf7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf0312808b7de58450a89b"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adf0312808b7de58450a89b","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Developer Resources","count":80},{"language":"default","tag":"API References","count":36},{"language":"default","tag":"Webhooks","count":34},{"language":"default","tag":"Webhook Events","count":31},{"language":"default","tag":"Products","count":15},{"language":"default","tag":"Dashboard \u0026 Operations","count":12},{"language":"default","tag":"Intent Events","count":11},{"language":"default","tag":"Subscription Events","count":11},{"language":"default","tag":"Dispute Management","count":10},{"language":"default","tag":"Payments","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developer-resources/endpoints/payments/get-intent","slug":"/developer-resources/endpoints/payments/get-intent","pageMetadata":{"title":"Get Intent","openapi":"GET /payments/v2/get-intent/{xIntentId}","description":"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.","href":"/developer-resources/endpoints/payments/get-intent"},"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: \"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it’s a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const entityType_0=`payment intent`;function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Anti-Polling Warning`}),`: Avoid polling this endpoint; use webhooks for real-time `,entityType_0,` updates. See `,_jsx(_components.a,{href:`/developer-resources/rate-limits#quotas`,children:`Anti-Polling Policy`}),`.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{entityType_0,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Intent","openapi":"GET /payments/v2/get-intent/{xIntentId}","description":"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.","href":"/developer-resources/endpoints/payments/get-intent"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[523,539,"`payment intent`,` u"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.","parameters":["198c2640-901b-4346-bf69-15bf7849a1e1","273e6e5d-66a8-4ee1-8f95-5f13a5aec712"],"responses":{"200":"329b1586-3353-43a8-a275-5d18674c4d0d","400":"7ceb7464-7c34-4ff2-b739-dcf3f7301fa4"},"method":"get","type":"path","servers":["3326f4fb-4f32-40c7-8421-4cb311bc2da0"],"security":["ea68e7b4-b63a-4c0b-aef2-904d73dbf5f7"],"path":"/payments/v2/get-intent/{xIntentId}","baseUrlOptions":["https://api.xpaycheckout.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"198c2640-901b-4346-bf69-15bf7849a1e1":{"name":"xIntentId","in":"path","required":true,"schema":{"type":"string","example":"in_fooBOwYsaK50AEfK","isRequired":true,"description":"Unique identifier of the intent","uniqueKey":"","typeLabel":"string"},"description":"Unique identifier of the intent"},"273e6e5d-66a8-4ee1-8f95-5f13a5aec712":{"name":"expand","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["charge_attempts","succeeded_charge"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"List of fields to expand in the response. Available options: \n - `charge_attempts` : includes all charge attempts \n - `succeeded_charge` : includes the successful charge details","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"List of fields to expand in the response. Available options: \n - `charge_attempts` : includes all charge attempts \n - `succeeded_charge` : includes the successful charge details","example":["charge_attempts","succeeded_charge"]}},"responses":{"329b1586-3353-43a8-a275-5d18674c4d0d":{"description":"Successful response with transaction status and related details","content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"The amount in lowest count unit (e.g., cents for USD)","example":100,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","description":"Three-letter currency code","example":"USD","uniqueKey":"currency","typeLabel":"string"},"presentmentCurrency":{"type":"string","description":"The currency that the customer paid in","example":"USD","uniqueKey":"presentmentCurrency","typeLabel":"string"},"receiptId":{"description":"Your identifier for the order","type":"string","example":"order123","uniqueKey":"receiptId","typeLabel":"string"},"customerDetails":{"type":"object","description":"Billing details for the customer.","required":["name","email","contactNumber"],"properties":{"name":{"type":"string","description":"Customer's name","example":"John Doe","isRequired":true,"uniqueKey":"customerDetails.name","typeLabel":"string"},"email":{"type":"string","description":"Customer's email address","example":"john.doe@example.com","isRequired":true,"uniqueKey":"customerDetails.email","typeLabel":"string"},"contactNumber":{"type":"string","description":"Customer's contact number ([E.164 format](https://en.wikipedia.org/wiki/E.164)), including the country code (e.g., +1 for US, +44 for UK, +91 for India).","example":"+919123456789","isRequired":true,"uniqueKey":"customerDetails.contactNumber","typeLabel":"string"},"customerAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Line 1 of the customer's address","example":"123 Main St","uniqueKey":"customerDetails.customerAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Line 2 of the customer's address","example":"Apt 1","uniqueKey":"customerDetails.customerAddress.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City of the customer's address","example":"New York","uniqueKey":"customerDetails.customerAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State of the customer's address","example":"NY","uniqueKey":"customerDetails.customerAddress.state","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","example":"US","uniqueKey":"customerDetails.customerAddress.country","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code","example":"2424","uniqueKey":"customerDetails.customerAddress.postalCode","typeLabel":"string"}},"uniqueKey":"customerDetails.customerAddress","typeLabel":"object"}},"uniqueKey":"customerDetails","typeLabel":"object"},"customerReferenceId":{"type":"string","description":"Your unique identifier for the customer. This can be used to associate the payment with a specific customer in your system.","example":"cus_Tfd3Jq1tZxPjYVhRQW2r3","uniqueKey":"customerReferenceId","typeLabel":"string"},"description":{"type":"string","description":"Description of the order, if any","example":"Order for 2 items","uniqueKey":"description","typeLabel":"string"},"callbackUrl":{"type":"string","description":"Callback URL to notify order status","example":"https://example.com/callback","uniqueKey":"callbackUrl","typeLabel":"string"},"cancelUrl":{"type":"string","description":"The URL to redirect the customer to when they cancel the payment.","example":"https://example.com/cancel","uniqueKey":"cancelUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the intent was created","example":"2024-09-26T10:41:50.472+00:00","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","description":"Current status of the intent. Refer [payment statuses](/products/one-time-payments/payment-statuses)","example":"CREATED","uniqueKey":"status","typeLabel":"string"},"xIntentId":{"description":"Unique identifier of the intent","type":"string","example":"in_fooBOwYsaK50AEfK","uniqueKey":"xIntentId","typeLabel":"string"},"succeededAt":{"type":"integer","description":"Epoch timestamp in milliseconds of when the payment was successfully completed","example":1727340330123,"uniqueKey":"succeededAt","typeLabel":"integer"},"metadata":{"type":"object","description":"A collection of key-value pairs that were provided when the object was created. These metadata values are echoed back in the response, allowing you to store and retrieve custom information such as context-specific attributes, references, or tags. This can be useful for correlating records in your system or attaching meaningful context to transactions.","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"example":{"orderId":"12345","customerNote":"Deliver after 5 PM"},"uniqueKey":"metadata","typeLabel":"object"},"chargeAttempts":{"type":"array","items":{"type":"object","description":"Charge attempt details","properties":{"status":{"type":"string","description":"Status of the charge attempt","example":"SUCCESS","uniqueKey":"chargeAttempts.items.[INDEX].status","typeLabel":"string"},"paymentMetadata":{"type":"object","description":"Payment metadata for this charge attempt","properties":{"paymentMethod":{"type":"string","description":"The payment method used for this attempt. Refer to [supported payment methods](/get-started/payment-methods-supported#payment-method-enums) for a complete list of available payment methods.","example":"CARD","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.paymentMethod","typeLabel":"string"},"cardMetadata":{"type":"object","description":"Card-specific metadata (only present for card payments)","properties":{"brand":{"type":"string","description":"The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others","example":"visa","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.brand","typeLabel":"string"},"country":{"type":"string","description":"Country code of the card issuer","example":"US","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.country","typeLabel":"string"},"lastFourDigit":{"type":"string","description":"Last 4 digits of the card number","example":"4242","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.lastFourDigit","typeLabel":"string"},"expiryMonth":{"type":"integer","format":"int64","description":"Card expiration month","example":12,"uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.expiryMonth","typeLabel":"integer\u003cint64>"},"expiryYear":{"type":"integer","format":"int64","description":"Card expiration year","example":2028,"uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.expiryYear","typeLabel":"integer\u003cint64>"},"cardType":{"type":"string","description":"Type of card funding, such as Credit or Debit","enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"],"example":"CREDIT","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata.cardType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardMetadata","typeLabel":"object"},"cardInstallmentMetadata":{"type":"object","description":"Card installment (EMI) metadata (only present for `CARD_INSTALLMENT` payments)","properties":{"cardInstallmentTenure":{"type":"string","description":"The installment tenure (in months) selected for this payment","enum":["three","six","nine","twelve"],"example":"three","uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardInstallmentMetadata.cardInstallmentTenure","typeLabel":"enum\u003cstring>"}},"uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata.cardInstallmentMetadata","typeLabel":"object"}},"uniqueKey":"chargeAttempts.items.[INDEX].paymentMetadata","typeLabel":"object"},"chargeTime":{"type":"integer","format":"int64","description":"Timestamp in epoch milliseconds when the charge was attempted","example":1727340330123,"uniqueKey":"chargeAttempts.items.[INDEX].chargeTime","typeLabel":"integer\u003cint64>"},"errorCode":{"type":"string","description":"Error code if the charge attempt failed. Refer to [error codes documentation](/products/one-time-payments/error-codes) for a complete list of possible error codes.","example":"card_declined","uniqueKey":"chargeAttempts.items.[INDEX].errorCode","typeLabel":"string"}},"uniqueKey":"chargeAttempts.items.[INDEX]","typeLabel":"object"},"description":"List of all charge attempts for this intent. Only included when `charge_attempts` is specified in the expand parameter.","example":[{"status":"FAILED","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340330123,"errorCode":"card_declined"},{"status":"SUCCESS","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340331123,"errorCode":null}],"uniqueKey":"chargeAttempts","typeLabel":"object[]"},"succeededCharge":{"type":"object","description":"Details of the successful charge attempt. Only included when `succeeded_charge` is specified in the expand parameter and the payment was successful.","properties":{"status":{"type":"string","description":"Status of the charge attempt","example":"SUCCESS","uniqueKey":"succeededCharge.status","typeLabel":"string"},"paymentMetadata":{"type":"object","description":"Payment metadata for this charge attempt","properties":{"paymentMethod":{"type":"string","description":"The payment method used for this attempt. Refer to [supported payment methods](/get-started/payment-methods-supported#payment-method-enums) for a complete list of available payment methods.","example":"CARD","uniqueKey":"succeededCharge.paymentMetadata.paymentMethod","typeLabel":"string"},"cardMetadata":{"type":"object","description":"Card-specific metadata (only present for card payments)","properties":{"brand":{"type":"string","description":"The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others","example":"visa","uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.brand","typeLabel":"string"},"country":{"type":"string","description":"Country code of the card issuer","example":"US","uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.country","typeLabel":"string"},"lastFourDigit":{"type":"string","description":"Last 4 digits of the card number","example":"4242","uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.lastFourDigit","typeLabel":"string"},"expiryMonth":{"type":"integer","format":"int64","description":"Card expiration month","example":12,"uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.expiryMonth","typeLabel":"integer\u003cint64>"},"expiryYear":{"type":"integer","format":"int64","description":"Card expiration year","example":2028,"uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.expiryYear","typeLabel":"integer\u003cint64>"},"cardType":{"type":"string","description":"Type of card funding, such as Credit or Debit","enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"],"example":"CREDIT","uniqueKey":"succeededCharge.paymentMetadata.cardMetadata.cardType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"succeededCharge.paymentMetadata.cardMetadata","typeLabel":"object"},"cardInstallmentMetadata":{"type":"object","description":"Card installment (EMI) metadata (only present for `CARD_INSTALLMENT` payments)","properties":{"cardInstallmentTenure":{"type":"string","description":"The installment tenure (in months) selected for this payment","enum":["three","six","nine","twelve"],"example":"three","uniqueKey":"succeededCharge.paymentMetadata.cardInstallmentMetadata.cardInstallmentTenure","typeLabel":"enum\u003cstring>"}},"uniqueKey":"succeededCharge.paymentMetadata.cardInstallmentMetadata","typeLabel":"object"}},"uniqueKey":"succeededCharge.paymentMetadata","typeLabel":"object"},"chargeTime":{"type":"integer","format":"int64","description":"Timestamp in epoch milliseconds when the charge was attempted","example":1727340330123,"uniqueKey":"succeededCharge.chargeTime","typeLabel":"integer\u003cint64>"},"errorCode":{"type":"string","description":"Error code if the charge attempt failed. Refer to [error codes documentation](/products/one-time-payments/error-codes) for a complete list of possible error codes.","example":"card_declined","uniqueKey":"succeededCharge.errorCode","typeLabel":"string"}},"example":{"status":"SUCCESS","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340331123,"errorCode":null},"uniqueKey":"succeededCharge","typeLabel":"object"},"paymentMethod":{"type":"string","enum":["CARD","GOOGLE_PAY","APPLE_PAY","PAYPAL","AMAZON_PAY","CASH_APP","KLARNA","AFTERPAY","AFFIRM","VENMO","CARD_INSTALLMENT"],"description":"The payment method associated with a successful intent. See [Payment Methods](/get-started/payment-methods-supported) for the full list of supported payment methods and their availability.","example":"CARD","uniqueKey":"paymentMethod","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":100,"currency":"USD","presentmentCurrency":"USD","receiptId":"order123","customerDetails":{"name":"John Doe","email":"john.doe@example.com","contactNumber":"+919123456789","customerAddress":{"addressLine1":"123 Main St","addressLine2":"Apt 1","city":"New York","state":"NY","country":"US","postalCode":"2424"}},"customerReferenceId":"cus_Tfd3Jq1tZxPjYVhRQW2r3","description":"Order for 2 items","callbackUrl":"https://example.com/callback","cancelUrl":"https://example.com/cancel","createdAt":"2024-09-26T10:41:50.472+00:00","status":"CREATED","xIntentId":"in_fooBOwYsaK50AEfK","succeededAt":1727340330123,"metadata":{"orderId":"12345","customerNote":"Deliver after 5 PM"},"chargeAttempts":[{"status":"FAILED","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340330123,"errorCode":"card_declined"},{"status":"SUCCESS","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340331123,"errorCode":null}],"succeededCharge":{"status":"SUCCESS","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2025,"cardType":"CREDIT"}},"chargeTime":1727340331123,"errorCode":null},"paymentMethod":"CARD"}}},"exampleType":"generated"}},"exampleType":"generated"},"7ceb7464-7c34-4ff2-b739-dcf3f7301fa4":{"description":"Invalid request, xIntentId not found","content":{"application/json":{"schema":{"required":["errorCode","errorDescription"],"type":"object","properties":{"errorCode":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorDescription":{"type":"string","example":"Failed to read request","isRequired":true,"uniqueKey":"errorDescription","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"bad_request","errorDescription":"Failed to read request"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ea68e7b4-b63a-4c0b-aef2-904d73dbf5f7":{"basicAuth":{"type":"http","scheme":"basic","scopes":[]}}},"servers":{"3326f4fb-4f32-40c7-8421-4cb311bc2da0":{"url":"https://api.xpaycheckout.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"developer-resources/endpoints/openapi.json"},"subdomain":"xpay","siteName":"xPay","title":"Get Intent - xPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T06:51:57.639Z","originalFileLocation":"developer-resources/endpoints/payments/get-intent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it\u0026#x27;s a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\">\u003cmeta data-mint-head name=\"application-name\" content=\"xPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Intent - xPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it\u0026#x27;s a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"xPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://xpay.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+Intent\u0026amp;description=You+can+use+this+API+to+get+the+status+of+the+transaction+that+corresponds+to+a+particular+intent.+This+API+also+returns+the+masked+card+info+of+the+payer+%28if+i\u0026amp;theme=ec85a6ae573973953713558e\u0026amp;signature=04ccea6b41cf718383b6aa0d3d39183fb27026fdd87e62eef74bca22c5261642\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Intent - xPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it\u0026#x27;s a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://xpay.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+Intent\u0026amp;description=You+can+use+this+API+to+get+the+status+of+the+transaction+that+corresponds+to+a+particular+intent.+This+API+also+returns+the+masked+card+info+of+the+payer+%28if+i\u0026amp;theme=ec85a6ae573973953713558e\u0026amp;signature=04ccea6b41cf718383b6aa0d3d39183fb27026fdd87e62eef74bca22c5261642\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"xPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3bc2ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer-resources/endpoints/payments/get-intent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.xpaycheckout.com/#organization\",\"name\":\"xPay\",\"url\":\"https://docs.xpaycheckout.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/light.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=007fbae209bf88bae6f124ed06a79e04\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.xpaycheckout.com#website\",\"name\":\"xPay\",\"url\":\"https://docs.xpaycheckout.com\",\"publisher\":{\"@id\":\"https://docs.xpaycheckout.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent#webpage\",\"url\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent\",\"name\":\"Get Intent\",\"description\":\"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\",\"dateModified\":\"2026-01-28T06:51:57.639Z\",\"isPartOf\":{\"@id\":\"https://docs.xpaycheckout.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developer Resources\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/getyourkeys\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API References\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/create-intent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payments\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/create-intent\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get Intent\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent#apireference\",\"headline\":\"Get Intent\",\"name\":\"Get Intent\",\"description\":\"You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transaction.\",\"url\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent#webpage\"},\"dateModified\":\"2026-01-28T06:51:57.639Z\",\"publisher\":{\"@id\":\"https://docs.xpaycheckout.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.xpaycheckout.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"xPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"xPay","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/get-started/introduction"},{"title":"Onboarding","href":"/get-started/onboarding"},{"title":"Currencies Supported","href":"/get-started/currencies-supported"},{"title":"Payment Methods","href":"/get-started/payment-methods-supported"}]},{"group":"Products","pages":[{"group":"One Time Payments","pages":[{"title":"Overview","href":"/products/one-time-payments/overview"},{"title":"Integration Process","href":"/products/one-time-payments/integrationProcess"},{"title":"Payment Statuses","href":"/products/one-time-payments/payment-statuses"},{"title":"Error Codes","href":"/products/one-time-payments/error-codes"},{"title":"Saved Cards","href":"/products/one-time-payments/saved-cards"}]},{"group":"Subscription","pages":[{"title":"Overview","href":"/products/subscription/overview"},{"title":"Integration Process","href":"/products/subscription/integrationProcess"},{"title":"Subscription Statuses","href":"/products/subscription/subscription-statuses"},{"title":"Retry Mechanism","href":"/products/subscription/subscription-retry-mechanism"}]},{"title":"Payment Links","href":"/products/payment-links/payment-links"},{"group":"Setup Method","pages":[{"title":"Overview","href":"/products/setup-method/overview"},{"title":"Integration Process","href":"/products/setup-method/integrationProcess"}]},{"title":"Argus","href":"/products/argus/overview"},{"title":"Virtual Bank Accounts","href":"/products/virtual-bank-accounts/virtual-bank-accounts"},{"title":"Platform Connect","href":"/products/platform-connect/overview"}]},{"group":"Dashboard \u0026 Operations","pages":[{"title":"Team Roles \u0026 Permissions","href":"/dashboard-operations/team-roles-permissions"},{"title":"Payouts","href":"/dashboard-operations/payouts/payouts"},{"group":"Dispute Management","pages":[{"title":"Overview","href":"/dashboard-operations/dispute-management/dispute-management"},{"title":"How disputes work","href":"/dashboard-operations/dispute-management/how-disputes-work"},{"title":"Reason codes","href":"/dashboard-operations/dispute-management/reason-codes"},{"title":"Network code reference","href":"/dashboard-operations/dispute-management/network-code-reference"},{"title":"Responding by reason","href":"/dashboard-operations/dispute-management/responding-by-reason"},{"title":"Secondary evidence","href":"/dashboard-operations/dispute-management/secondary-evidence"},{"title":"Evidence guidelines","href":"/dashboard-operations/dispute-management/evidence-guidelines"},{"title":"Deadlines","href":"/dashboard-operations/dispute-management/deadlines"},{"title":"Reducing disputes","href":"/dashboard-operations/dispute-management/reducing-disputes"},{"title":"Dispute FAQ","href":"/dashboard-operations/dispute-management/faq"}]}]},{"group":"Developer Resources","pages":[{"title":"Get Started","href":"/developer-resources/getyourkeys"},{"title":"Authentication","href":"/developer-resources/authentication"},{"title":"Rate Limits","href":"/developer-resources/rate-limits"},{"title":"Idempotent Requests","href":"/developer-resources/idempotency"},{"title":"Errors","href":"/developer-resources/errors"},{"group":"API References","pages":[{"group":"Payments","pages":[{"title":"Create Intent","openapi":"POST /payments/create-intent","href":"/developer-resources/endpoints/payments/create-intent"},{"title":"Capture Payment","openapi":"POST /payments/capture-payment","description":"Captures a payment that was previously authorized by creating an intent with `manualCapture` set to `true`.","href":"/developer-resources/endpoints/payments/capture-payment"},{"title":"Get Intent","openapi":"GET /payments/v2/get-intent/{xIntentId}","href":"/developer-resources/endpoints/payments/get-intent"},{"title":"Refund","openapi":"POST /payments/merchant/refund","description":"The Refund APIs allow merchants to process refunds for previously captured payments","href":"/developer-resources/endpoints/payments/refund"},{"title":"Cancel Payment","openapi":"POST /payments/cancel/{xIntentId}","href":"/developer-resources/endpoints/payments/cancel-payment"},{"title":"List Intents","openapi":"GET /payments/intents","href":"/developer-resources/endpoints/payments/list-intents"},{"title":"Charge Raw Card","openapi":"POST /payments/s2s/charge-raw-card","href":"/developer-resources/endpoints/payments/charge-raw-card"},{"title":"Get Refunds of an Intent","openapi":"GET /payments/refunds/{intentId}","href":"/developer-resources/endpoints/payments/get-refunds-for-intent"},{"title":"Get Refund","openapi":"GET /payments/refund/{refundId}","href":"/developer-resources/endpoints/payments/get-refund"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription","openapi":"POST /subscription/create","href":"/developer-resources/endpoints/subscriptions/create-subscription"},{"title":"Get Subscription","openapi":"GET /subscription/get-subscription/{subscriptionId}","href":"/developer-resources/endpoints/subscriptions/get-subscription"},{"title":"Edit Subscription","openapi":"POST /subscription/edit","href":"/developer-resources/endpoints/subscriptions/edit-subscription"},{"title":"One Time Charge","openapi":"POST /subscription/merchant/one-time-charge","href":"/developer-resources/endpoints/subscriptions/one-time-charge"},{"title":"Manual Retry","openapi":"POST /subscription/manual-retry","href":"/developer-resources/endpoints/subscriptions/manual-retry"},{"title":"Pause Subscription","openapi":"POST /subscription/merchant/pause","href":"/developer-resources/endpoints/subscriptions/pause"},{"title":"Unpause Subscription","openapi":"POST /subscription/merchant/unpause","href":"/developer-resources/endpoints/subscriptions/unpause"},{"title":"Cancel Subscription","openapi":"POST /subscription/merchant/cancel","href":"/developer-resources/endpoints/subscriptions/cancel"}]},{"group":"Payment Links","pages":[{"title":"Payments Links","openapi":"POST /link/merchant/generate-link","href":"/developer-resources/endpoints/payment-links/generate-link"},{"title":"Subscription Link","openapi":"POST /subscription/link/merchant/generate-link","href":"/developer-resources/endpoints/payment-links/subscription-link"}]},{"group":"Customer","pages":[{"title":"Create Customer","openapi":"POST /customer/create","href":"/developer-resources/endpoints/customer/create-customer"},{"title":"Get Customer","openapi":"GET /customer/{customerId}","href":"/developer-resources/endpoints/customer/get-customer"},{"title":"List Payment Method Tokens","openapi":"GET /customer/{customerId}/payment-method-tokens","href":"/developer-resources/endpoints/customer/get-pm-tokens-for-customer"}]},{"group":"Setup Method","pages":[{"title":"Create Setup Method","openapi":"POST /setup-method/create","href":"/developer-resources/endpoints/setup-method/create-setup-method"},{"title":"Create S2S Setup Method","openapi":"POST /setup-method/s2s/create","href":"/developer-resources/endpoints/setup-method/create-s2s-setup-method"},{"title":"Get Setup Method","openapi":"GET /setup-method/{setupMethodId}","href":"/developer-resources/endpoints/setup-method/get-setup-method"},{"title":"Charge Tokenised PM","openapi":"POST /payments/charge-tokenised-pm","href":"/developer-resources/endpoints/setup-method/charge-tokenised-pm"},{"title":"Get Payment Method Token","openapi":"GET /payment-method-token/{paymentMethodTokenId}","href":"/developer-resources/endpoints/setup-method/get-payment-method-token"},{"title":"Delete Tokenised Payment Method","openapi":"POST /payment-method-token/delete","href":"/developer-resources/endpoints/setup-method/delete-tokenised-pm"}]},{"group":"Payouts","pages":[{"title":"Get Payout","openapi":"GET /balance/payouts/{payoutId}","href":"/developer-resources/endpoints/payouts/get-payout"},{"title":"List Payouts","openapi":"GET /balance/payouts","href":"/developer-resources/endpoints/payouts/list-payouts"}]},{"group":"Webhook Configuration","pages":[{"title":"Create a Webhook Configuration","openapi":"POST /webhook","href":"/developer-resources/endpoints/webhooks/create-webhook"},{"title":"List Webhook Configurations","openapi":"GET /webhook","href":"/developer-resources/endpoints/webhooks/get-webhooks"},{"title":"Get Webhook Configuration","openapi":"GET /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/get-webhook-by-id"},{"title":"Edit Webhook Configuration","openapi":"PUT /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/edit-webhook"},{"title":"Delete Webhook Configuration","openapi":"DELETE /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/delete-webhook"}]},{"group":"Argus","pages":[{"title":"Block Fingerprint by Intent","openapi":"POST /argus/block-fingerprint-by-intent","href":"/developer-resources/endpoints/argus/block-fingerprint-by-intent"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks Introduction","href":"/developer-resources/webhooks/introduction"},{"title":"Webhook Verification","href":"/developer-resources/webhooks/verification"},{"title":"Webhook Events Directory","href":"/developer-resources/webhooks/events-list"},{"group":"Webhook Events","pages":[{"group":"Intent Events","pages":[{"title":"Created","href":"/developer-resources/webhooks/events/intentEvents/created"},{"title":"Checkout Opened","href":"/developer-resources/webhooks/events/intentEvents/checkout_opened"},{"title":"Authorized","href":"/developer-resources/webhooks/events/intentEvents/authorized"},{"title":"Success","href":"/developer-resources/webhooks/events/intentEvents/success"},{"title":"Failed","href":"/developer-resources/webhooks/events/intentEvents/failed"},{"title":"Refunded","href":"/developer-resources/webhooks/events/intentEvents/refunded"},{"title":"Disputed","href":"/developer-resources/webhooks/events/intentEvents/disputed"},{"title":"Dispute Under Review","href":"/developer-resources/webhooks/events/intentEvents/dispute_under_review"},{"title":"Dispute Won","href":"/developer-resources/webhooks/events/intentEvents/disputedWon"},{"title":"Dispute Lost","href":"/developer-resources/webhooks/events/intentEvents/dispute_lost"},{"title":"Early Fraud Warning","href":"/developer-resources/webhooks/events/intentEvents/early_fraud_warning"}]},{"group":"Subscription Events","pages":[{"title":"Created","href":"/developer-resources/webhooks/events/subsEvents/created"},{"title":"Checkout Opened","href":"/developer-resources/webhooks/events/subsEvents/checkout_opened"},{"title":"Trialing","href":"/developer-resources/webhooks/events/subsEvents/trialing"},{"title":"Active","href":"/developer-resources/webhooks/events/subsEvents/active"},{"title":"Paused","href":"/developer-resources/webhooks/events/subsEvents/paused"},{"title":"Unpaused","href":"/developer-resources/webhooks/events/subsEvents/unpaused"},{"title":"Cycle Charged","href":"/developer-resources/webhooks/events/subsEvents/cycle_charged"},{"title":"Unpaid","href":"/developer-resources/webhooks/events/subsEvents/unpaid"},{"title":"Payment Method Updated","href":"/developer-resources/webhooks/events/subsEvents/payment_method_updated"},{"title":"Ended","href":"/developer-resources/webhooks/events/subsEvents/ended"},{"title":"Cancelled","href":"/developer-resources/webhooks/events/subsEvents/cancelled"}]},{"group":"Setup Method Events","pages":[{"title":"Setup Method Created","href":"/developer-resources/webhooks/events/setupMethodEvents/created"},{"title":"Setup Method Checkout Opened","href":"/developer-resources/webhooks/events/setupMethodEvents/checkout_opened"},{"title":"Setup Method Success","href":"/developer-resources/webhooks/events/setupMethodEvents/success"},{"title":"Setup Method Failed","href":"/developer-resources/webhooks/events/setupMethodEvents/failed"},{"title":"Payment Method Token Created","href":"/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_created"},{"title":"Payment Method Token Deleted","href":"/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_deleted"}]},{"group":"Payout Events","pages":[{"title":"Payout Initiated","href":"/developer-resources/webhooks/events/payoutEvents/initiated"},{"title":"Payout Success","href":"/developer-resources/webhooks/events/payoutEvents/success"}]},{"group":"Virtual Bank Account Events","pages":[{"title":"Virtual Bank Account Transaction","href":"/developer-resources/webhooks/events/vbaEvents/transaction"}]}]}]},{"title":null,"href":"/developer-resources/pagination"},{"group":"Sandbox","pages":[{"title":"Sandbox Environment","href":"/developer-resources/sandbox/sandbox"},{"title":"Payment Test Simulation","href":"/developer-resources/sandbox/payment-test-simulation"}]},{"title":"Mobile App Integration","href":"/developer-resources/mobileIntegration"},{"title":"Iframe Guidelines","href":"/developer-resources/iframeGuidelines"}]},{"group":"FAQs","pages":[{"title":"Frequently Asked Questions","href":"/faqs/overall-faq"},{"title":"xPay Card Installments","href":"/faqs/x-pay-card-installments"},{"title":"Klarna FAQs for Merchants","href":"/faqs/klarna-overview"},{"title":"Prohibited Activities / Businesses","href":"/faqs/prohibited-businesses"}]}]},"basePath":"","title":"Get Intent - xPay","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}