Refunds
List Refunds for Your Merchant Account
Retrieve a paginated list of refunds for your merchant account. Filter by date range and status, and use page and page_size to navigate large result sets.
List Refunds for Your Merchant Account
Use this endpoint to retrieve a paginated list of all refunds associated with your merchant account. You can narrow results by supplying a
start_date and end_date range, or filter by a specific status such as SUCCESS. Combine page and page_size to page through large result sets efficiently.
Headers
string
required
Your secret API key used to authenticate all requests.
string
required
Must be
application/json.Request Parameters
integer
required
Page number for pagination. Start at
1 to retrieve the first page of results.integer
required
Number of records to return per page.
string
Start date and time for filtering refunds. Use the format
YYYY-MM-DD HH:MM, for example 2026-06-15 00:00.string
End date and time for filtering refunds. Use the format
YYYY-MM-DD HH:MM, for example 2026-06-15 23:59.string
Filter results by refund status. Pass
SUCCESS to retrieve only successfully processed refunds.Response
A successful request returns a200 OK with a JSON body containing a paginated array of refund records.
array
Array of refund objects matching your filter criteria.
integer
The current page number returned.
integer
Number of records returned per page.
integer
Total number of refund records matching your filter.
Omit
start_date, end_date, and status to retrieve all refunds without date or status filtering. Only page and page_size are required.