Skip to main content
GET
/
payment-intents
List payment intents
curl --request GET \
  --url https://apiv2.example.com/payment-intents \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "paymentIntentId": "64870b5c-fb61-4c9a-955a-e148e0826c20",
      "customerId": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
      "status": "SUCCEEDED",
      "amount": 29,
      "currency": "USD",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "description": "Mobile subscription renewal",
      "dueAt": "2024-01-15T10:00:00Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

​
customerId
string[]

Filter payment intents by customer IDs

​
status
enum<string>[]

Filter payment intents by status

Current stage of a payment intent as it is collected over card rails.

Available options:
PENDING,
REQUIRES_ACTION,
PROCESSING,
SUCCEEDED,
REQUIRES_PAYMENT_METHOD,
CANCELLED

Response

Payment intents retrieved successfully

​
items
object[]
required
​
pagination
object
required