• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
V1 list settlements
V1
Connect V1 APIs and webhooks

Use the Square API for all new development. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective May 13th, 2021

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.

Permissions
SETTLEMENTS_READ

Deprecation date
2021-05-13
Retirement date
2023-06-16
Replaced by
ListPayouts
Migration guide
Name Description
location_id
string

Required

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.

Name Description
order
string

The order in which settlements are listed in the response.

begin_time
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.

end_time
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.

limit
integer (32-bit)

The maximum number of settlements to return in a single response. This value cannot exceed 200.

status
string

Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).

batch_token
string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Fields

Name Description
{items}
Settlement [ ]

Examples

You are viewing an old version of the API
GET /v1/{location_id}/settlements
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/settlements \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'