Sign in

v1

latestSwagger 2.02026-07-17121946.0 KB
sampled
getSettlementsByParams

getSettlementsByParams

Returns Settlements as per parameter(s).

get/settlements

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.

state'PENDING_SETTLEMENT' | 'PS_TRANSFERS_RECORDED' | 'PS_TRANSFERS_RESERVED' | 'PS_TRANSFERS_COMMITTED' | 'SETTLING' | 'SETTLED' | 'ABORTED'

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"
          }
        ]
      }
    ]
  }
]