API ReferenceRefunds
List refunds
Returns a paginated list of refunds matching the given filters.
Authorization
ApiKey X-Api-Key<token>
Merchant API key for authentication
In: header
Query Parameters
page?integer
Range
1 <= valueDefault
1limit?integer
Range
1 <= value <= 300Default
20sortBy?string
order?string
Default
"desc"Value in
- "asc"
- "desc"
status?string
Filter by refund status.
Value in
- "pending"
- "processing"
- "succeeded"
- "failed"
- "cancelled"
from?string
Only refunds requested at/after this ISO 8601 time.
Format
date-timeto?string
Only refunds requested at/before this ISO 8601 time.
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/refunds"{ "data": [ { "id": "string", "payment_id": "string", "amount": 0, "currency": "string", "status": "string", "reason": "string", "requested_at": "2019-08-24T14:15:22Z", "succeeded_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "limit": 0, "total": 0, "totalPages": 0 }}