Get Location Settlements

GET {{baseUrl}}/v1/:location_id/settlements?order=<object>&begin_time=<string>&end_time=<string>&limit=<integer>&status=<string>&batch_token=<string>

Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.

Request Params

KeyDatatypeRequiredDescription
orderstringThe order in which employees are listed in the response, based on their created_at field. Default value: ASC
begin_timestringThe beginning of the requested reporting period, in RFC 3339 format.
end_timestringThe end of the requested reporting period, in RFC 3339 format.
limitstringThe maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
statusstringIf provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
batch_tokenstringA pagination cursor to retrieve the next set of results for your
original query to the endpoint.