Refunds
API ReferenceRefundsList
List Refunds
Retrieve a list of refunds with optional filtering and pagination.
GET /refunds/list
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 10 | Number of refunds to return (max: 100) |
offset | integer | No | 0 | Number of refunds to skip |
payment_id | string | No | — | Filter refunds by payment ID |
status | string | No | — | Filter by refund status |
created_gte | string | No | — | Filter refunds created on or after this date |
created_lte | string | No | — | Filter refunds created on or before this date |
Request Example
curl -X POST 'https://api.v2.paychtec.com/refunds/list' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "limit": 10, "payment_id": "pay_mbabizu24mvu3mela5njyhpit4"}'Response
{
"count": 1,
"total_count": 1,
"data": [
{
"refund_id": "ref_1234567890abcdef",
"payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
"amount": 500,
"currency": "USD",
"status": "succeeded",
"reason": "Customer requested refund",
"created": "2024-01-22T14:00:00Z"
}
]
}