Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.59 KB

ListPaymentRefundsRequest.md

File metadata and controls

18 lines (13 loc) · 1.59 KB

SquareConnect.ListPaymentRefundsRequest

Description

Retrieves a list of refunds for the account making the request. Max results per page: 100

Properties

Name Type Description Notes
begin_time String Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. [optional]
end_time String Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. [optional]
sort_order String The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). [optional]
cursor String A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information. [optional]
location_id String ID of location associated with payment. [optional]
status String If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. [optional]
source_type String If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. [optional]