V1Retrieve settlement

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.

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 settlements's associated location.

Link to section

settlement_id

string

Required

The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

Link to section

Response fields

Link to section

string

The settlement's unique identifier.

Link to section

status

string

The settlement's current status.

Link to section

total_money

The amount of money involved in the settlement. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero.

Link to section

initiated_at

string

The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format.

Link to section

bank_account_id

string

The Square-issued unique identifier for the bank account associated with the settlement.

Link to section

entries

The entries included in this settlement.