• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve settlement
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

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.

Required permissions: SETTLEMENTS_READ

Path Parameters

Name Description
location_id
string

Required

The ID of the settlements's associated location.

settlement_id
string

Required

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

Response Fields

Name Description
id
string

The settlement's unique identifier.

status
string

The settlement's current status.

total_money
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.

initiated_at
string

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

bank_account_id
string

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

entries
SettlementEntry [ ]

The entries included in this settlement.

Examples

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

Share Feedback

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