---
title: "List settlements"
method: GET
path: "/settlement"
tags: ["Settlements"]
---

# List settlements

`GET /settlement`

Returns your settlements, newest first. Each settlement groups the transactions paid out together in a single bank transfer.

Narrow the results with `status[]`, `created_at`, and `updated_at`. Pagination is cursor-based: pass the previous response's `metadata.next_cursor` back as `cursor`. An empty `next_cursor` means there are no further pages.


**Required scope:** <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">settlement:read</code>

## Query parameters

- `limit` number
- `cursor` string
- `created_at` string
- `updated_at` string
- `status[]` string[]

## Response `200`

Successful response with a list of settlements

- object
  - `data` Settlement[], required
    - `id` string, uuid, required — Unique identifier for the settlement.
    - `created_at` string, date-time, required — Timestamp when the settlement was created. Always present.
    - `updated_at` string, date-time, nullable, required — Timestamp when the settlement was last updated, or `null` when it has never been updated.
    - `name` string, required — Human-readable name of the settlement (its batch reference).
    - `description` string, required — Human-readable description of the settlement.
    - `status` 'IN_TRANSIT' | 'SUCCEEDED' | 'FAILED', required — Current status of the settlement.
    - `total_amount` Money, required — The money type is a data structure used to represent a monetary value in a specific currency. It includes both the amount and the currency type to accurately define the value of money in various contexts, such as financial transactions, pricing, and accounting.
      - `amount` string — Represents the numerical value of the money. The amount should be a string formatted to include up to two decimal places to accurately represent cents or subunits of currency. For example, "123.45" represents one hundred twenty-three units and forty-five subunits of the currency.
      - `currency` string — Indicates the type of currency associated with the amount. This should follow standard currency codes (ISO 4217), such as "USD" for US Dollar, "EUR" for Euro, or "JPY" for Japanese Yen, to specify which currency the amount is denominated in.
    - `number_of_items` integer, required — Number of transactions included in the settlement.
    - `destination` object, required — Where the settled funds are sent.
      - `type` 'IBAN', required — Type of destination.
      - `details` object — Details specific to the destination type.
        - `iban` string — Destination IBAN. Omitted when empty.
  - `metadata` MetadataCursor, required — An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.
    - `next_cursor` string, required — Provides the cursor for the next set of records. This value should be used as the cursor parameter in subsequent requests to continue paginating through the data. If the cursor is an empty string or null, it indicates that there are no more results. To retrieve all available results, continue making subsequent requests until next_cursor is empty or null.
    - `count` number, required — The total number of records in the current response. This field indicates the number of items returned in the current set of results.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `412` — Pre condition failed
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/easypay/apis/easypay-payments-api.md) · [All operations](https://skmtc.net/easypay/apis/easypay-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easypay/easypay-payments-api/versions/cdf25a9ad7b2/schema)