GET /v1/{location_id}/settlements
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.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
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
| Name | Type | Required | Description |
|---|---|---|---|
order |
String | No |
The order in which settlements are listed in the response. |
begin_time |
String | No |
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. |
limit |
Integer | No |
The maximum number of settlements to return in a single response. This value cannot exceed 200. |
status |
String | No |
Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). |
batch_token |
String | No |
A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
end_time |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.