Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PAYMENTS

Get all refunds for a merchant

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.
get/v3/merchants/{mId}/refunds

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

filterstring

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.

expandstring

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

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. All refunds for a merchant are displayed.

idstring

Unique identifier of the refund.

amountinteger

Total amount refunded, including tax and tip

taxAmountinteger

Tax amount refunded.

tipAmountinteger

Tip amount refunded.

createdTimeinteger

Time when the refund was recorded on the server.

clientCreatedTimeinteger

Time when the refund was recorded on the client.

gatewayProcessingTimeinteger

Time when the refund was processed by the payment gateway.

voidedboolean

Indicates voided information.

voidReasonstring

Indicates reason of voided.

externalReferenceIdstring

External reference identifier, if associated with the refund.

authCodestring

Authorization code generated by the acquirer.

status'FAIL' | 'SUCCESS' | 'PENDING'

Status of the refund. It can be Fail/Success/Pending.

reasonstring

Reason why the refund initiated.