List payments
Retrieves a list of all payment intents for the specified organization and livemode. This endpoint supports filtering, sorting, and pagination through query parameters.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Fields to expand related entities. For example, ["organization"].
Maximum number of items to retrieve. Default is 25.
Number of items to skip before starting to collect the result set.
Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".
Search term to filter the results. Supports multiple terms with "~" for partial matches.
Query parameters for filtering, sorting, and pagination. Supports expanding related entities, setting limits, skipping items, ordering by specific fields, and searching by terms.
Response
The amount to be charged, specified in the smallest currency unit (e.g., cents).
The ID of the checkout session associated with the payment intent.
The ID of the customer associated with the payment intent. Can be null if no customer is associated.
Additional metadata for the payment group. This can be used to store additional information about the payment intent in a key-value pair format.
The status of the payment intent.
CANCELED
, PROCESSING
, REQUIRES_PAYMENT_METHOD
, REQUIRES_CONFIRMATION
, REQUIRES_ACTION
, REQUIRES_CAPTURE
, SUCCEEDED
, REFUNDED
, PARTIALLY_REFUNDED
, CASHBACK_SENT
The ID of the payment group associated with the payment intent. Can be null if no payment group is associated.
A unique string chosen by you to reconcile the payment intent with your internal systems. Useful for linking the payment intent to internal records.