Ctrl+K

List settlements created or updated in a given timeframe (admin)

get/api/clearing/v1/admin/settlements/ids

Admin endpoint to list all settlements created or updated in a given timeframe.

Use only with delivery versus payment (DVP) settlements.

Query Parameters

  • startstring<date-time>Required
    Filter for settlements created or updated after this date. Format: ISO 8601 date string.
  • endstring<date-time>Required
    Filter for settlements created or updated before this date. Format: ISO 8601 date string.

200 Response

settlementIds array[string] required

400 Response

401 Response

error string required
errorName string required

403 Response

error string required
errorName string required

500 Response

error string required
errorName string required