v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Clearing

Clearings:Records

Retrieve the transactions that are in a clearing. You can filter on the clearing ID or the settlement code. Note that you need to have access to the merchant to retrieve the transactions if you request the transactions for a clearing ID or settlement code from one of your sub-merchants.

get/v2/clearings/{identifier}/records

Path parameters

identifierstring required

The identifier can be a clearing ID or a settlement code.

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

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

{
  "clearingRecords": [
    {
      "currencyAmount": {
        "value": 100,
        "currency": "EUR"
      },
      "amount": {
        "value": 100,
        "currency": "EUR"
      },
      "paymentMethod": {
        "id": 1,
        "name": "iDeal"
      },
      "paymentProfile": {
        "id": 10,
        "name": "iDeal",
        "direction": "DEBIT",
        "collecting": true
      },
      "turnoverGroup": {
        "code": "CT-1234-4321",
        "name": "E-Commerce"
      },
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant"
      }
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}