GET /settlementWindows – MOJALOOP Central Settlements

sampled

getSettlementWindowsByParams

Returns Settlement Windows as per parameter(s).

get/settlementWindows

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/settlementWindows/get.ts
A function with typed inputs. Its response is checked against the schema.

participantIdinteger

A valid participant Id to filter on.

state'OPEN' | 'CLOSED' | 'PENDING_SETTLEMENT' | 'SETTLED' | 'ABORTED'

A settlement window state to filter on.

fromDateTimestring 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

toDateTimestring 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

currencystring

A valid currency to filter on.

Settlement window(s) returned by the filtering parameters.

idinteger required

reasonstring

statestring required

createdDatestring required

changedDatestring