v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Clearing

Clearings:Browse

This API returns a summary of the clearings. 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.

get/v2/clearings

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 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

{
  "clearings": [
    {
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "contractPackage": "Corporate"
      },
      "turnoverGroups": [
        {
          "code": "CT-1234-4321",
          "name": "E-Commerce"
        }
      ],
      "rollingReserve": {
        "value": 100,
        "currency": "EUR"
      },
      "costs": {
        "value": 100,
        "currency": "EUR"
      }
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}