GET
/
payments
/
v2
/
get-intent
/
{xIntentId}
curl --request GET \
  --url https://api.xpaycheckout.com/payments/v2/get-intent/{xIntentId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "amount": 100,
  "currency": "USD",
  "presentmentCurrency": "USD",
  "receiptId": "order123",
  "mode": "TEST",
  "customerDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "contactNumber": "9123456789",
    "customerAddress": {
      "country": "US",
      "postalCode": "2424"
    }
  },
  "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": "66f53a6e2097773e4f0112c8",
  "fwdUrl": "https://pay.xpaycheckout.com/?xpay_intent_id=67f53a6e2097773e4f0112c8",
  "metadata": {
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM"
  }
}

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:

"66f53a6e2097773e4f0112c8"

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"

​
mode
string

The mode in which the transaction was made (e.g., TEST or LIVE)

Example:

"TEST"

​
customerDetails
object
​
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

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:

"66f53a6e2097773e4f0112c8"

​
fwdUrl
string

The URL to redirect the customer to the xPay payment gateway for payment.

Example:

"https://pay.xpaycheckout.com/?xpay_intent_id=67f53a6e2097773e4f0112c8"

​
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.

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

Was this page helpful?