---
title: Payment Intents
description: Inspect payment intents, the money collected over card rails for orders and renewals.
---

# Payment Intents

Inspect payment intents, the money collected over card rails for orders and renewals.

## [GET /payment-intents](/api-reference/payment-intents#tag/payment-intents/GET/payment-intents)

List payment intents

Retrieve a paginated list of payment intents with optional filtering by status, customer, or date range.

Authentication: X-Api-Key, or Bearer JWT + X-Api-Key

### Query parameters

- `limit` (`integer`, optional, >= 1, <= 1000, default 100) — The maximum number of items to return.
- `cursor` (`string`, optional) — Opaque pagination token from a previous response's nextCursor.
- `customerId` (`array of string`, optional) — Filter payment intents by customer IDs
- `status` (`array of PaymentIntentStatus`, optional) — Filter payment intents by status

### Responses

#### 200

Payment intents retrieved successfully

Type: `object`

- `items` (`array of PaymentIntentListItem`, required)
  - `paymentIntentId` (`string`, required, example 64870b5c-fb61-4c9a-955a-e148e0826c20) — The unique identifier for this payment intent.
  - `customerId` (`string`, required, example a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d) — The customer this payment intent collects from.
  - `status` (`enum<string>`, required, one of PENDING, REQUIRES_ACTION, PROCESSING, SUCCEEDED, REQUIRES_PAYMENT_METHOD, CANCELED, example SUCCEEDED) — Current stage of a payment intent as it is collected through the payment provider. - PENDING: Created, no charge attempted yet. - REQUIRES_ACTION: The customer must take action to continue (e.g., 3D Secure authentication). - PROCESSING: A charge is in flight with the payment provider. - SUCCEEDED: The full amount has been collected. - REQUIRES_PAYMENT_METHOD: The last charge attempt failed; a new or updated payment method is needed to retry. - CANCELED: Collection was canceled and no further charges will be attempted.
  - `amountMinor` (`integer`, required, int64, example 2900) — The total amount to collect, in minor units of the currency (e.g., 2900 = $29.00 when the currency is USD).
  - `currency` (`string`, required, example USD) — The ISO 4217 currency code the amount is collected in (e.g., "USD").
  - `description` (`string`, optional, example Mobile subscription renewal) — A human-readable description of what is being collected.
  - `dueAt` (`string`, optional, date-time, example 2024-01-15T10:00:00Z) — When the amount is due.
  - `createdAt` (`string`, required, date-time, example 2024-01-15T10:00:00Z) — When the payment intent was created.
  - `updatedAt` (`string`, required, date-time, example 2024-01-15T10:00:00Z) — When the payment intent was last updated.
- `pagination` (`object`, required) — Cursor-based pagination information returned by list endpoints. Pass `nextCursor` as the `cursor` query parameter of the next request to fetch the following page.
  - `nextCursor` (`string | null`, required, example eyJvZmZzZXQiOjEwMH0) — Opaque token for fetching the next page. Null when no more results.

#### 400

The request was malformed or invalid.

Type: [Error](/api-reference/models.md#models/Error)

#### 401

Authentication is required to access this resource.

Type: [Error](/api-reference/models.md#models/Error)

#### 403

Access to this resource is forbidden.

Type: [Error](/api-reference/models.md#models/Error)

#### 500

An unexpected error occurred on the server.

Type: [Error](/api-reference/models.md#models/Error)

### Example request

```bash
curl https://apiv2.example.com/api/v2/payment-intents \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

## [GET /payment-intents/{paymentIntentId}](/api-reference/payment-intents#tag/payment-intents/GET/payment-intents/{paymentIntentId})

Get payment intent

Get a payment intent by ID, including its charge attempts, refunds, and line items.

Authentication: X-Api-Key, or Bearer JWT + X-Api-Key

### Path parameters

- `paymentIntentId` (`string`, required) — The unique identifier of the payment intent to retrieve.

### Responses

#### 200

Payment intent retrieved successfully

Type: [PaymentIntent](/api-reference/models.md#models/PaymentIntent)

#### 400

The request was malformed or invalid.

Type: [Error](/api-reference/models.md#models/Error)

#### 401

Authentication is required to access this resource.

Type: [Error](/api-reference/models.md#models/Error)

#### 403

Access to this resource is forbidden.

Type: [Error](/api-reference/models.md#models/Error)

#### 404

The requested resource was not found.

Type: [Error](/api-reference/models.md#models/Error)

#### 500

An unexpected error occurred on the server.

Type: [Error](/api-reference/models.md#models/Error)

### Example request

```bash
curl https://apiv2.example.com/api/v2/payment-intents/64870b5c-fb61-4c9a-955a-e148e0826c20 \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_API_KEY'
```