---
title: "ListSettlements"
method: GET
path: "/v1/{location_id}/settlements"
tags: ["V1Transactions"]
---

# ListSettlements

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

## Path parameters

- `location_id` string, required

## Query parameters

- `order` string
- `begin_time` string
- `end_time` string
- `limit` integer
- `status` string
- `batch_token` string

## Response `200`

Success

- V1Settlement[]
  - `bank_account_id` string — The Square-issued unique identifier for the bank account associated with the settlement.
  - `entries` V1SettlementEntry[] — The entries included in this settlement.
    - `amount_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `fee_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `payment_id` string — The settlement's unique identifier.
    - `type` string — The settlement's current status.
  - `id` string — The settlement's unique identifier.
  - `initiated_at` string — The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format.
  - `status` string — The settlement's current status.
  - `total_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string

---

[API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/versions/8d95e3639487/schema)