v1
latestSwagger 2.02026-07-17121946.0 KBsampled
getSettlementWindowsByParams
getSettlementWindowsByParams
Returns Settlement Windows as per parameter(s).
get/settlementWindows
Query parameters
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.
Response
Settlement window(s) returned by the filtering parameters.