List Refunds
List Refunds
List all refunds with pagination — track refund status, amounts, and associated collections. GET /refunds.
GET
List Refunds
Overview
Retrieve a paginated list of refunds for your application.Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Items per page (default: 20, max: 100) |
status | string | Filter by status (PENDING, COMPLETED, FAILED) |
collectionId | string | Filter by original collection ID |
dateFrom | string | Filter from date (YYYY-MM-DD) |
dateTo | string | Filter to date (YYYY-MM-DD) |
Response
| Field | Type | Description |
|---|---|---|
refunds | array | List of refund objects |
pagination | object | Pagination info |
Refund Object
| Field | Type | Description |
|---|---|---|
refundId | string | Unique refund identifier |
collectionId | string | Original collection ID |
amount | number | Refunded amount |
currency | string | Currency code |
reason | string | Reason code (e.g., CUSTOMER_REQUEST) |
reasonDescription | string | Human-readable reason description |
status | string | Refund status |
completedAt | string | Completion timestamp |
createdAt | string | Creation timestamp |
Example Usage
Example Response
Filtering Examples
Refunds for a Specific Collection
Completed Refunds Only
This Month’s Refunds
Authorizations
JWT access token obtained from /auth/token
Query Parameters
Required range:
x <= 100Available options:
PENDING, COMPLETED, FAILED 
