Get all refunds for a merchant

get

https://apisandbox.dev.clover.com/v3/merchants/{mId}/refunds

Retrieves refunds for a merchant, including associated taxes and tips.

Data Retrieval Rules:

90-Day Limit: This endpoint returns a maximum of 90 days of refund data.
Automatic Time-Filter Adjustment: If a query's time-based filter (e.g., createdTime or clientCreatedTime) spans more than 90 days, the server automatically adjusts the range to fetch only the most recent 90 days of results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant identifier (mId).

Query Params

filter

string

Filters the results based on a set of criteria. For detailed syntax, see the API filtering documentation.

Filter fields to display search results: [id, voided, createdTime, clientCreatedTime, orderRef.id, payment.id, employee.id, device.id]

Important: When filtering by createdTime or clientCreatedTime, the query is subject to the 90-day data retrieval limit outlined in the main endpoint description.

expand

string

Fields that display when the list is expanded: [payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo]

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

200Successful response. All refunds for a merchant are displayed.