---
title: "getSettlementWindowsByParams"
method: GET
path: "/settlementWindows"
tags: ["sampled", "getSettlementWindowsByParams"]
---

# getSettlementWindowsByParams

`GET /settlementWindows`

## Request

- Base URL: `/v2` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v2/settlementWindows`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/docs/settlementWindows/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns Settlement Windows as per parameter(s).

## Query parameters

- `participantId` integer
- `state` 'OPEN' | 'CLOSED' | 'PENDING_SETTLEMENT' | 'SETTLED' | 'ABORTED'
- `fromDateTime` string, date-time
- `toDateTime` string, date-time
- `currency` string

## Response `200`

Settlement window(s) returned by the filtering parameters.

- SettlementWindow[]
  - `id` integer, required
  - `reason` string
  - `state` string, required
  - `createdDate` string, required
  - `changedDate` string
  - `content` SettlementWindowContent[]
    - `id` integer, required
    - `state` string, required
    - `ledgerAccountType` string, required
    - `currencyId` string, required
    - `createdDate` string, required
    - `changedDate` string
    - `settlementId` integer

## Other responses

- `400`: Bad request.
- `401`: Authorisation information is missing or invalid.
- `404`: No data found.
- `415`: Unsupported Media Type.
- `default`: Unexpected error

## Changes

- **2026-09-08** `7fbaa3e7ca2b`: 6 info
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `401`
  - added the media type `application/json` for the response with the status `404`
  - …2 more

[Operation history](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/changes/settlementWindows/get.md)

---

[API](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements.md) - [All operations](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/llms.txt) - [OpenAPI document](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/revisions/7fbaa3e7ca2b?raw)