Retrieve Settlements

Returns a paginated list of settlement records. Each settlement aggregates the financial outcome of one or more cleared transactions.

URL test:

    https://test.lightcms.io/trancore/v1/trancore/settlements?startDate=2024-11-01&endDate=2024-11-30&page=0&size=20&sort=settlementDate,desc

Method:

GET

Path items:

/trancore/settlements

Parameters:

Parameter	Location	Type	Example	Description	Required
reportNr	query	string			No
settlementServices	query	string		Comma-separated list of transaction types to filter. Use API trancore/settlementservices. Default is all of values. Example: 'INTERNATIONAL,CZECH_NATIONAL'	No
summaryLevel	query	string		Comma-separated list of transaction types to filter. Use API trancore/summarylevels. Default is all of values. Example: 'DEBIT_TOTAL,ROUTING_TOTAL'	No
settlementDateFrom	query	string	2024-11-01	Inclusive lower bound of the settlement date (ISO‑8601, yyyy‑MM‑dd).	No
settlementDateTo	query	string	2024-11-30	Inclusive upper bound of the settlement date (ISO‑8601, yyyy‑MM‑dd).	No
page	query	integer	0	Zero‑based page index (default 0).	No
size	query	integer	20	Number of records per page (default 20).	No
sort	query	string	settlementDate,desc	Sort field and direction; default settlementDate,desc.	No

Example:

    curl -X GET "https://test.lightcms.io/trancore/v1/trancore/settlements?settlementDateFrom=2024-11-01&settlementDateTo=2024-11-30&page=0&size=20&sort=settlementDate,desc" \
         -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK

    {
      "id": 7,
      "processor": "PROCESSOR",
      "messageFormatVersion": 1,
      "systemTransactionDatetime": "2025-02-19T09:03:14Z",
      "reportDate": "2024-11-09",
      "settlementDate": "2024-11-09",
      "reportNr": "130",
      "reportSubGroup": "4",
      "isReversal": false,
      "sourceCountry": "CZE",
      "destinationCountry": "CZE",
      "summaryLevel": "DEBIT_TOTAL",
      "settlementService": "CZECH_NATIONAL",
      "settlementCurrency": "CZK",
      "firstTotal": 5,
      "interchangeValueDirection": "DEBIT",
      "interchangeValue": 120,
      "interchangeFeeDirection": "CREDIT",
      "interchangeFee": 0.36
    },
    {
      "id": 6,
      "processor": "PROCESSOR",
      "messageFormatVersion": 1,
      "systemTransactionDatetime": "2025-02-19T09:03:13Z",
      "reportDate": "2024-11-08",
      "settlementDate": "2024-11-08",
      "reportNr": "130",
      "reportSubGroup": "4",
      "isReversal": false,
      "sourceCountry": "CZE",
      "destinationCountry": "CZE",
      "summaryLevel": "DEBIT_TOTAL",
      "settlementService": "CZECH_NATIONAL",
      "settlementCurrency": "CZK",
      "firstTotal": 1,
      "interchangeValueDirection": "DEBIT",
      "interchangeValue": 19,
      "interchangeFeeDirection": "CREDIT",
      "interchangeFee": 0.06
    }

Parameter	Location	Type	Description
id	content	integer	Internal identifier of the settlement record.
processor	content	string	Processor name.
messageFormatVersion	content	integer	Version of the message format.
systemTransactionDatetime	content	string	System timestamp of the settlement generation (ISO‑8601, UTC).
reportDate	content	string	Date of the settlement report (ISO‑8601, yyyy‑MM‑dd).
settlementDate	content	string	Date the settlement was posted (ISO‑8601, yyyy‑MM‑dd).
reportNr	content	string	Report number (business‑specific identifier).
reportSubGroup	content	string	Sub‑group within the report (e.g., 4).
isReversal	content	boolean	Indicates whether the settlement represents a reversal.
sourceCountry	content	string	ISO‑3166‑1 alpha‑2 code of the source country.
destinationCountry	content	string	ISO‑3166‑1 alpha‑2 code of the destination country.
summaryLevel	content	string	Aggregation level (DEBIT_TOTAL, ROUTING_TOTAL, etc.).
settlementService	content	string	Service used for settlement (CZECH_NATIONAL, INTERNATIONAL, …).
settlementCurrency	content	string	ISO‑4217 currency code of the settlement (e.g., CZK).
firstTotal	content	integer	Primary total count for the aggregation level.
interchangeValueDirection	content	string	Direction of the interchange value (DEBIT or CREDIT).
interchangeValue	content	number	Total interchange amount (in settlement currency).
interchangeFeeDirection	content	string	Direction of the interchange fee (DEBIT or CREDIT).
interchangeFee	content	number	Total interchange fee amount (in settlement currency).
visaChargeFee	content	number	(Only for ROUTING_TOTAL records) Visa charge fee.
visaChargeFeeDirection	content	string	Direction of the Visa charge fee (DEBIT or CREDIT).

500 - Internal error

Status Code: 500 Internal error

{
  "timestamp": "2025-07-22T13:09:02.348+02:00",
  "status": 500,
  "error": "Internal Server Error",
  "path": "/cms/v1/trancore/settlements"
}

Parameter	Location	Type	Description
timestamp	root	string	ISO‑8601 timestamp when the error occurred.
status	root	integer	HTTP status code (500).
error	root	string	Short description of the error.
path	root	string	The request path that caused the error.