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.

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

cURL

cURL

curl --request GET \
  --url https://api.xpaycheckout.com/payments/v2/get-intent/{xIntentId} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "amount": 100,
  "currency": "USD",
  "presentmentCurrency": "USD",
  "receiptId": "order123",
  "customerDetails": {
    "name": "John Doe",
    "email": "[e-mail]",
    "contactNumber": "[phone]",
    "customerAddress": {
      "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
        }
      },
      "chargeTime": 1727340330123,
      "errorCode": "card_declined"
    },
    {
      "status": "SUCCESS",
      "paymentMetadata": {
        "paymentMethod": "CARD",
        "cardMetadata": {
          "brand": "Visa",
          "country": "US",
          "lastFourDigit": "4242",
          "expiryMonth": 12,
          "expiryYear": 2025
        }
      },
      "chargeTime": 1727340331123,
      "errorCode": null
    }
  ],
  "succeededCharge": {
    "status": "SUCCESS",
    "paymentMetadata": {
      "paymentMethod": "CARD",
      "cardMetadata": {
        "brand": "Visa",
        "country": "US",
        "lastFourDigit": "4242",
        "expiryMonth": 12,
        "expiryYear": 2025
      }
    },
    "chargeTime": 1727340331123,
    "errorCode": null
  }
}

Anti-Polling Warning: Avoid polling this endpoint; use webhooks for real-time updates. See Anti-Polling Policy.

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

xIntentId · string · required

Unique identifier of the intent

Example:

"in_fooBOwYsaK50AEfK"

Query Parameters

expand · enum<string>[]

List of fields to expand in the response. Available options:

• charge_attempts : includes all charge attempts
• succeeded_charge : includes the successful charge details

Available options: charge_attempts, succeeded_charge

Response

200

application/json

Successful response with transaction status and related details

amount · integer

The amount in lowest count unit (e.g., cents for USD)

Example:

100

currency · string

Three-letter currency code

Example:

"USD"

presentmentCurrency · string

The currency that the customer paid in

Example:

"USD"

receiptId · string

Your identifier for the order

Example:

"order123"

customerDetails · object

Show child attributes

customerReferenceId · string

Your unique identifier for the customer. This can be used to associate the payment with a specific customer in your system.

Example:

"cus_Tfd3Jq1tZxPjYVhRQW2r3"

description · string

Description of the order, if any

Example:

"Order for 2 items"

callbackUrl · string

Callback URL to notify order status

Example:

"https://example.com/callback"

cancelUrl · string

The URL to redirect the customer to when they cancel the payment.

Example:

"https://example.com/cancel"

createdAt · string<date-time>

Timestamp of when the intent was created

Example:

"2024-09-26T10:41:50.472+00:00"

status · string

Current status of the intent.

Example:

"CREATED"

xIntentId · string

Unique identifier of the intent

Example:

"in_fooBOwYsaK50AEfK"

succeededAt · integer

Epoch timestamp in milliseconds of when the payment was successfully completed

Example:

1727340330123

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.

Show child attributes

Example:

{
  "orderId": "12345",
  "customerNote": "Deliver after 5 PM"
}

chargeAttempts · object[]

List of all charge attempts for this intent. Only included when charge_attempts is specified in the expand parameter.

Show child attributes

Example:

[
  {
    "status": "FAILED",
    "paymentMetadata": {
      "paymentMethod": "CARD",
      "cardMetadata": {
        "brand": "Visa",
        "country": "US",
        "lastFourDigit": "4242",
        "expiryMonth": 12,
        "expiryYear": 2025
      }
    },
    "chargeTime": 1727340330123,
    "errorCode": "card_declined"
  },
  {
    "status": "SUCCESS",
    "paymentMetadata": {
      "paymentMethod": "CARD",
      "cardMetadata": {
        "brand": "Visa",
        "country": "US",
        "lastFourDigit": "4242",
        "expiryMonth": 12,
        "expiryYear": 2025
      }
    },
    "chargeTime": 1727340331123,
    "errorCode": null
  }
]

succeededCharge · object

Details of the successful charge attempt. Only included when succeeded_charge is specified in the expand parameter and the payment was successful.

Show child attributes

Example:

{
  "status": "SUCCESS",
  "paymentMetadata": {
    "paymentMethod": "CARD",
    "cardMetadata": {
      "brand": "Visa",
      "country": "US",
      "lastFourDigit": "4242",
      "expiryMonth": 12,
      "expiryYear": 2025
    }
  },
  "chargeTime": 1727340331123,
  "errorCode": null
}