ListPaymentRefundsRequest

November 20, 2019 ยท View on GitHub

Description

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

Properties

NameTypeDescriptionNotes
beginTimeStringTimestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year.[optional]
endTimeStringTimestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time.[optional]
sortOrderStringThe order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default).[optional]
cursorStringA 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]
locationIdStringID of location associated with payment.[optional]
statusStringIf 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]
sourceTypeStringIf 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]