You are viewing an old version of the API
List settlements
V1

Note We recommend using the Square API (V2) for all new development when possible.

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.

Required permissions SETTLEMENTS_READ

Path Parameters

Name Description
location_id
string

Required

The ID of the location to list settlements for.

Query Parameters

Name Description
order
string

TThe order in which payments 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

The maximum number of payments 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}
V1​Settlement [ ]

Root array of on V1Settlement objects on the response

Examples

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

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?