Skip to main content
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

Authorization
string
header
required

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.

status
enum<string>

Filter by refund status.

Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED,
CANCELED
start_date
string<date>

Include refunds created on or after this date.

end_date
string<date>

Include refunds created on or before this date.

page_size
integer

Number of results per page. Defaults to 1000, maximum 10000.

Required range: 1 <= x <= 10000
page
integer

Page number to return.

Required range: x >= 1

Response

A paginated list of refunds.

count
integer
Example:

1

next
string<uri> | null
Example:

null

previous
string<uri> | null
Example:

null

results
object[]