ListSettlements
Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length.
Note*: the ListSettlements endpoint does not provide entry information.
Path parameters
The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.
Query parameters
The order in which settlements are listed in the response.
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.
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.
The maximum number of settlements to return in a single response. This value cannot exceed 200.
Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
A pagination cursor to retrieve the next set of results for your original query to the endpoint.
Response
Success