List refunds
Refunds
List refunds
Returns a paginated list of refunds for the authenticated organization, ordered newest first.
GET
List refunds
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Query Parameters
Search by refund ID, order ID, payment-provider refund ID, or customer name, email, or ID.
Filter by refund status.
Available options:
PENDING, PROCESSING, SUCCEEDED, FAILED, CANCELED Include refunds created on or after this date.
Include refunds created on or before this date.
Number of results per page. Defaults to 1000, maximum 10000.
Required range:
1 <= x <= 10000Page number to return.
Required range:
x >= 1