v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Clearing

Settlement:Forecasts

This API returns a forecast of the upcoming settlements. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the settlement forecast information for your merchant.

get/v2/settlements/forecasts

Query parameters

eqstring

Get results that equal the given value

Filter by merchant code (must have authorization for the merchant)

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

Response

totalinteger nullable

The total items the collection contains

Example response

{
  "forecasts": [
    {
      "settlementDate": "2024-06-04",
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "contractPackage": "Corporate"
      },
      "turnoverGroup": {
        "code": "CT-1234-4321",
        "name": "E-Commerce"
      },
      "rollingReserve": {
        "value": 100,
        "currency": "EUR"
      },
      "costs": {
        "value": 100,
        "currency": "EUR"
      }
    }
  ],
  "total": 10
}