V1ListRefundsRequest

March 13, 2019 ยท View on GitHub

Description

Properties

NameGetterSetterTypeDescriptionNotes
ordergetOrder()setOrder($value)stringTThe order in which payments are listed in the response. See SortOrder for possible values[optional]
begin_timegetBeginTime()setBeginTime($value)stringThe 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.[optional]
end_timegetEndTime()setEndTime($value)stringThe 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.[optional]
limitgetLimit()setLimit($value)intThe 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.[optional]
batch_tokengetBatchToken()setBatchToken($value)stringA pagination cursor to retrieve the next set of results for your original query to the endpoint.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]