GET
/
payment-intents
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier of the Payment Intent to fetch

Query Parameters

expand
string[]

Fields to expand related entities. For example, ["organization"].

take
number

Maximum number of items to retrieve. Default is 25.

skip
number

Number of items to skip before starting to collect the result set.

orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Query parameters for additional filtering, sorting, and expansion.

Response

200 - application/json
amount
number
default: 1000required

The amount to be charged, specified in the smallest currency unit (e.g., cents).

checkoutSessionId
string
required

The ID of the checkout session associated with the payment intent.

customerId
string | null

The ID of the customer associated with the payment intent. Can be null if no customer is associated.

metadata
object

Additional metadata for the payment group. This can be used to store additional information about the payment intent in a key-value pair format.

status
enum<string>

The status of the payment intent.

Available options:
CANCELED,
PROCESSING,
REQUIRES_PAYMENT_METHOD,
REQUIRES_CONFIRMATION,
REQUIRES_ACTION,
REQUIRES_CAPTURE,
SUCCEEDED,
REFUNDED,
PARTIALLY_REFUNDED,
CASHBACK_SENT
paymentGroupId
string | null

The ID of the payment group associated with the payment intent. Can be null if no payment group is associated.

clientReferenceId
string

A unique string chosen by you to reconcile the payment intent with your internal systems. Useful for linking the payment intent to internal records.