V1ListSettlementsRequest
March 13, 2019 ยท View on GitHub
squareconnect.models.v1_list_settlements_request
Description
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| order | str | TThe order in which payments are listed in the response. See SortOrder for possible values | [optional] |
| begin_time | str | 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 | str | 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 | int | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] |
| status | str | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). See V1ListSettlementsRequestStatus for possible values | [optional] |
| batch_token | str | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] |