---
title: "GET /payments/v2/get-intent/{xIntentId}"
method: GET
path: "/payments/v2/get-intent/{xIntentId}"
---

# GET /payments/v2/get-intent/{xIntentId}

`GET /payments/v2/get-intent/{xIntentId}`

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.

## Path parameters

- `xIntentId` string, required

## Query parameters

- `expand` string[]

## Response `200`

Successful response with transaction status and related details

- GetIntentDetailsResponse
  - `amount` integer — The amount in lowest count unit (e.g., cents for USD)
  - `currency` string — Three-letter currency code
  - `presentmentCurrency` string — The currency that the customer paid in
  - `receiptId` string — Your identifier for the order
  - `customerDetails` BillingDetails — Billing details for the customer.
    - `name` string, required — Customer's name
    - `email` string, required — Customer's email address
    - `contactNumber` string, required — 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).
    - `customerAddress` CustomerAddress
      - `addressLine1` string — Line 1 of the customer's address
      - `addressLine2` string — Line 2 of the customer's address
      - `city` string — City of the customer's address
      - `state` string — State of the customer's address
      - `country` string — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
      - `postalCode` string — Postal code
  - `customerReferenceId` string — Your unique identifier for the customer. This can be used to associate the payment with a specific customer in your system.
  - `description` string — Description of the order, if any
  - `callbackUrl` string — Callback URL to notify order status
  - `cancelUrl` string — The URL to redirect the customer to when they cancel the payment.
  - `createdAt` string, date-time — Timestamp of when the intent was created
  - `status` string — Current status of the intent. Refer [payment statuses](/products/one-time-payments/payment-statuses)
  - `xIntentId` string — Unique identifier of the intent
  - `succeededAt` integer — Epoch timestamp in milliseconds of when the payment was successfully completed
  - `metadata` object — 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.
  - `chargeAttempts` ChargeDTO[] — List of all charge attempts for this intent. Only included when `charge_attempts` is specified in the expand parameter.
    - `status` string — Status of the charge attempt
    - `paymentMetadata` PaymentMetadataDTO — Payment metadata containing additional information about the payment attempt
      - `paymentMethod` string — 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.
      - `cardMetadata` CardMetadataDTO — Card metadata containing additional information about the card used for payment
        - `brand` string — The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others
        - `country` string — Country code of the card issuer
        - `lastFourDigit` string — Last 4 digits of the card number
        - `expiryMonth` integer — Card expiration month
        - `expiryYear` integer — Card expiration year
        - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN' — Type of card funding, such as Credit or Debit
      - `cardInstallmentMetadata` CardInstallmentMetadataDTO — Card installment (EMI) metadata, present only for `CARD_INSTALLMENT` payments
        - `cardInstallmentTenure` 'three' | 'six' | 'nine' | 'twelve' — The installment tenure (in months) selected for this payment
    - `chargeTime` integer — Timestamp in epoch milliseconds when the charge was attempted
    - `errorCode` string — 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.
  - `succeededCharge` ChargeDTO — Charge attempt details
    - `status` string — Status of the charge attempt
    - `paymentMetadata` PaymentMetadataDTO — Payment metadata containing additional information about the payment attempt
      - `paymentMethod` string — 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.
      - `cardMetadata` CardMetadataDTO — Card metadata containing additional information about the card used for payment
        - `brand` string — The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others
        - `country` string — Country code of the card issuer
        - `lastFourDigit` string — Last 4 digits of the card number
        - `expiryMonth` integer — Card expiration month
        - `expiryYear` integer — Card expiration year
        - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN' — Type of card funding, such as Credit or Debit
      - `cardInstallmentMetadata` CardInstallmentMetadataDTO — Card installment (EMI) metadata, present only for `CARD_INSTALLMENT` payments
        - `cardInstallmentTenure` 'three' | 'six' | 'nine' | 'twelve' — The installment tenure (in months) selected for this payment
    - `chargeTime` integer — Timestamp in epoch milliseconds when the charge was attempted
    - `errorCode` string — 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.
  - `paymentMethod` 'CARD' | 'GOOGLE_PAY' | 'APPLE_PAY' | 'PAYPAL' | 'AMAZON_PAY' | 'CASH_APP' | 'KLARNA' | 'AFTERPAY' | 'AFFIRM' | 'VENMO' | 'CARD_INSTALLMENT' — 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.

## Other responses

- `400` — Invalid request, xIntentId not found

---

[API](https://skmtc.net/xpaycheckout/apis/xpay-api-store.md) · [All operations](https://skmtc.net/xpaycheckout/apis/xpay-api-store/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xpaycheckout/xpay-api-store/versions/6329a7c694bc/schema)