V1ListPaymentsRequest
March 13, 2019 ยท View on GitHub
Description
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| order | getOrder() | setOrder($value) | string | The order in which payments are listed in the response. See SortOrder for possible values | [optional] |
| begin_time | getBeginTime() | setBeginTime($value) | string | 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. | [optional] |
| end_time | getEndTime() | setEndTime($value) | string | 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. | [optional] |
| limit | getLimit() | setLimit($value) | int | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] |
| batch_token | getBatchToken() | setBatchToken($value) | string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] |
| include_partial | getIncludePartial() | setIncludePartial($value) | bool | Indicates 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] |
Note: All properties are protected and only accessed via getters and setters.