V1List settlements

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.

Permissions:SETTLEMENTS_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

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.

Link to section

Query parameters

Link to section

order

string

The order in which settlements are listed in the response.

Link to section

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.

Link to section

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.

Link to section

limit

integer(32-bit)

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

Link to section

status

string

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

Link to section

batch_token

string

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

Link to section

Response fields

Link to section

{items}