GET /v1/{location_id}/settlements/{settlement_id}
Provides comprehensive information for a single settlement.
The returned Settlement objects include an entries field that lists
the transactions that contribute to the settlement total. Most
settlement entries correspond to a payment payout, but settlement
entries are also generated for less common events, like refunds, manual
adjustments, or chargeback holds.
Square initiates its regular deposits as indicated in the Deposit Options with Square help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day.
Square does not know when an initiated settlement completes, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
The ID of the settlements's associated location. |
settlement_id |
String | Yes |
The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. |
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.