Skip to main content
GET
This endpoint retrieves a paginated list of payments. Use filters to narrow results by status, date range, amount, and more.

Authentication

This endpoint requires a valid API key with payments:read permissions.

Query Parameters

integer
Number of items to return (default: 20, max: 100)
string
Cursor for pagination (payment ID)
string
Cursor for reverse pagination (payment ID)
string
Filter by status: “pending”, “processing”, “succeeded”, “failed”, “cancelled”
string
Filter by customer ID
string
Filter by order ID
string
Filter by invoice ID
string
Filter by payment method: “card”, “ach”, “wire”, “paypal”
string
Filter by creation date start (ISO 8601)
string
Filter by creation date end (ISO 8601)
integer
Minimum amount in cents
integer
Maximum amount in cents
string
Filter by currency code

Response

string
Object type, always “list”
array
Array of payment objects
boolean
Whether more items exist