V1ListPaymentsRequest

July 10, 2019 ยท View on GitHub

Description

Properties

NameTypeDescriptionNotes
orderStringThe order in which payments are listed in the response. See SortOrder for possible values[optional]
beginTimeStringThe 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]
endTimeStringThe 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]
limitIntegerThe maximum number of payments to return in a single response. This value cannot exceed 200.[optional]
batchTokenStringA pagination cursor to retrieve the next set of results for your original query to the endpoint.[optional]
includePartialBooleanIndicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.[optional]