Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Clearing

Clearing:Lines

A Pay. clearing contains multiple clearing lines. This API returns all clearing lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the clearing lines also for your merchants

get/v2/clearings/{identifier}/lines

Path parameters

identifierstring required

Clearing identifier

Query parameters

pageinteger

The collection page number

eqstring

Filter on the exact clearing line type.

neqstring

Filter out the specified clearing line type.

Filter by clearing line type.

{
  "eq": "10",
  "neq": "10"
}
eqstring

Filter on the exact state.

neqstring

Filter out the specified state.

Filter state.

{
  "eq": "SETTLED",
  "neq": "SETTLED"
}

Response

OK

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "clearingLines": [
    {
      "releaseDate": "2024-06-04",
      "turnoverDate": "2024-06-04",
      "clearingLineType": {
        "id": 10,
        "name": "iDeal",
        "direction": "DEBIT",
        "collecting": true
      },
      "volume": {
        "value": 100,
        "currency": "EUR"
      }
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}