Payments
API ReferencePaymentsList
List Payments
Retrieve a list of payments with optional filtering and pagination.
POST /payments/list
Returns a paginated list of payments matching the specified filters. Results are ordered by creation date, with the most recent payments appearing first.
Body Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 10 | Number of payments to return (1-100) |
offset | integer | No | 0 | Number of payments to skip |
status | string | No | — | Filter by payment status (succeeded, failed, processing, requires_capture, cancelled) |
customer_id | string | No | — | Filter by customer ID |
created_gte | string | No | — | Filter payments created on or after this date (ISO 8601) |
created_lte | string | No | — | Filter payments created on or before this date (ISO 8601) |
currency | string | No | — | Filter by currency code |
Request Example
curl -X POST 'https://api.v2.paychtec.com/payments/list' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "limit": 10, "offset": 0, "status": "succeeded", "created_gte": "2024-01-01T00:00:00Z"}'Response
{
"count": 2,
"total_count": 150,
"data": [
{
"payment_id": "pay_1234567890abcdef",
"status": "succeeded",
"amount": 5000,
"currency": "USD",
"created": "2024-01-22T10:30:00Z"
},
{
"payment_id": "pay_0987654321fedcba",
"status": "succeeded",
"amount": 2500,
"currency": "USD",
"created": "2024-01-22T09:15:00Z"
}
]
}