GET /settlements – MOJALOOP Central Settlements

sampled

getSettlementsByParams

Changed on Sep 8, 2026

Returns Settlements as per parameter(s).

get/settlements

Request

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

Query parameters

currencystring

A valid currency to filter on.

participantIdinteger

A valid participant Id to filter on.

settlementWindowIdnumber

A valid Settlement Window Id to filter on.

accountIdnumber

A valid Account Id to filter on.

A settlement state to filter on.

fromDateTimestring date-time

The start date for query (relates to central-ledger.settlement.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z

toDateTimestring date-time

The end date for query (relates to central-ledger.settlement.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z

fromSettlementWindowDateTimestring date-time

The start date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z

toSettlementWindowDateTimestring date-time

The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z

Response

Settlement window(s) returned by the filtering parameters.

idinteger

statestring

Example response

[
  {
    "participants": [
      {
        "accounts": [
          {
            "state": "PENDING_SETTLEMENT"
          }
        ]
      }
    ]
  }
]

Changes

Sep 8, 20267fbaa3e7ca2b Revision changes
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status

Operation history