v1
latestOpenAPI 3.0.32026-07-264469137.7 KBPayments
List payments
Return a paginated list of payments your organization has received, newest first. Filter with query parameters for reconciliation and monitoring. List items carry a summary of each payment; call Retrieve a payment for the full object including fees, products, and status history.
get/v1/payments
Query parameters
limitinteger
Page size. Defaults to 50. Maximum is 100.
offsetinteger
Number of records to skip before returning results.
status_filter'created' | 'processing' | 'succeeded' | 'accepted' | 'failed' | 'expired' | 'cancelled' | 'refunded' | 'partially_refunded' | 'underpaid' | 'overpaid'
Optional exact status filter for charge records.
Response
Success - Payments list retrieved
Example response
{
"items": [
{
"reference": "order_9876",
"id": "chrg_1a2b3c4d5e",
"status": "succeeded",
"is_refundable": true,
"amount": "10.00",
"customer_name": "Jane Doe",
"customer_email": "customer@example.com",
"amount_paid": "10.00",
"amount_remaining": "0.00",
"settlement_amount": "10.00",
"settlement_currency": "USD",
"currency": "USD",
"transaction_date": "2026-04-27T12:00:00Z",
"completed_at": "2026-04-27T12:00:05Z"
}
],
"pagination": {
"next_cursor": "cur_50",
"has_more": true,
"limit": 50,
"returned": 50,
"total": 150
}
}