v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Clearing

Clearings:Get

This API returns the clearing summary information for a specific clearing. If you want to retrieve also the clearing lines, please use the Clearing:Lines endpoint. You need to have access to the merchant if you request a clearing.

get/v2/clearings/{identifier}

Path parameters

identifierstring required

The identifier can be a clearing ID.

Response

idstring

periodstring

periodType'day' | 'week' | 'month'

clearingDatestring date-time

status'OPEN' | 'FAILED' | 'PAID'

paymentTypeobject

Example response

{
  "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"
  }
}