v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Clearing

Clearings:Settlements

A Pay. clearing contains multiple clearing lines. This API returns the clearing grouped by settlements, including the clearing lines. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the clearing information for your merchant. You can also filter on settlement code and clearing id.

get/v2/clearings/settlements

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

eqstring

Filter on the exact clearing id.

Filter for a specific clearing ID.

{
  "eq": "CLEARING-20212977767"
}

eqstring

Filter on the exact settlement code.

Filter settlements by settlement code.

{
  "eq": "SK6Y-7PBP"
}

eqstring

Filter on the exact payment date.

gtstring

Filter on payment date greater than the given value.

gtestring

Filter on payment date greater than or equal to the given value.

ltstring

Filter on payment date less than the given value.

ltestring

Filter on payment date less than or equal to the given value.

Filter settlements by payment date.

{
  "eq": "2024-10-01",
  "gt": "2024-09-01",
  "gte": "2024-09-01",
  "lt": "2024-11-01",
  "lte": "2024-11-01"
}

eqstring

Filter on the exact turnover group code.

neqstring

Filter out the specified turnover group code.

Filter settlements by turnover group.

{
  "eq": "CT-1234-1234",
  "neq": "CT-5678-5678"
}

Response

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "settlements": [
    {
      "code": "SK6Y-7PBP",
      "description": "Clearing: 4 invoices / Funds: 227.562,66",
      "settlementDate": "2007-10-02",
      "confirmationDate": "2021-12-31",
      "amount": {
        "value": 100,
        "currency": "EUR"
      },
      "baseAccountIban": "NL35RABO0117713678",
      "clearingAccount": {
        "method": "iban",
        "iban": {
          "iban": "NL91ABNA0417164300",
          "bic": "ABNANL2A",
          "owner": "Robbert van der Werf"
        }
      },
      "clearings": [
        {
          "clearingId": "CLEARING-20212977767",
          "clearingLines": [
            {
              "code": "RT-1234-4321-1234",
              "clearingDate": "2024-06-04",
              "settlementDate": "2024-06-04",
              "valueDate": "2024-06-04",
              "state": "SETTLED",
              "turnoverGroup": {
                "code": "CT-1234-4321",
                "name": "E-Commerce"
              },
              "clearingLineType": {
                "id": 10,
                "name": "iDeal",
                "direction": "DEBIT",
                "collecting": true
              },
              "amount": {
                "value": 100,
                "currency": "EUR"
              },
              "merchant": {
                "code": "M-1234-4321",
                "name": "GMS Demo Merchant",
                "contractPackage": "Corporate"
              },
              "transactions": 3,
              "uniquePayers": 3
            }
          ]
        }
      ]
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}