Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Transactions

ListRefunds

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

get/v1/{location_id}/refunds

Path parameters

location_idstring required

The ID of the location to list refunds for.

Query parameters

orderstring

The order in which payments are listed in the response.

begin_timestring

The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

end_timestring

The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limitinteger

The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.

batch_tokenstring

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response

Success

created_atstring

The time when the merchant initiated the refund for Square to process, in ISO 8601 format.

is_exchangeboolean

Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.

merchant_idstring
payment_idstring

A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.

processed_atstring

The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.

reasonstring

The merchant-specified reason for the refund.

typestring

The type of refund