---
title: "getSettlementsByParams"
method: GET
path: "/settlements"
tags: ["sampled", "getSettlementsByParams"]
---

# getSettlementsByParams

`GET /settlements`

Returns Settlements as per parameter(s).

## Query parameters

- `currency` string
- `participantId` integer
- `settlementWindowId` number
- `accountId` number
- `state` 'PENDING_SETTLEMENT' | 'PS_TRANSFERS_RECORDED' | 'PS_TRANSFERS_RESERVED' | 'PS_TRANSFERS_COMMITTED' | 'SETTLING' | 'SETTLED' | 'ABORTED'
- `fromDateTime` string, date-time
- `toDateTime` string, date-time
- `fromSettlementWindowDateTime` string, date-time
- `toSettlementWindowDateTime` string, date-time

## Response `200`

Settlement window(s) returned by the filtering parameters.

- Settlement[]
  - `id` integer
  - `state` string
  - `settlementWindows` SettlementWindows[]
    - 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
  - `participants` Participant[]
    - `id` integer
    - `accounts` Accounts[]
      - `id` integer — Participant Currency Id
      - `reason` string — TBD
      - `state` string
      - `netSettlementAmount` NetSettlementAmount
        - `amount` number
        - `currency` string

## Other responses

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

---

[API](https://skmtc.net/mojaloop/apis/mojaloop-central-settlements.md) · [All operations](https://skmtc.net/mojaloop/apis/mojaloop-central-settlements/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mojaloop/mojaloop-central-settlements/versions/09d34527e74f/schema)