Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Balance

Balance:Year

This API gives an end of year overview

get/v2/balance/year

Query parameters

eqstring

Get results that equal the given value

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

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

Filter by turnover group codes (comma-separated, must exist and have authorization)

Filter by turnover group codes (must exist and have authorization)

{
  "in": "CT-1234-1234,CT-1234-4321"
}
eqinteger

Filter by exact year match (current year or within past 3 years)

Filter by year (current year or within past 3 years)

{
  "eq": 2024
}
eqstring

Filter by exact month match (01-12)

Filter by month (01-12)

{
  "eq": "09"
}
eqinteger

Filter by exact day match (01-31)

Filter by day of month (01-31)

{
  "eq": 1
}

Response

OK

Example response

{
  "merchant": {
    "code": "M-1234-4321",
    "name": "GMS Demo Merchant",
    "status": "ACTIVE",
    "contractPackage": "Corporate"
  },
  "turnoverGroups": [
    {
      "code": "CT-1234-4321",
      "name": "E-Commerce"
    }
  ],
  "paymentMethodGroups": [
    {
      "tag": "ONLINEBANKING",
      "name": "Domestic Payment methods",
      "sequence": 1,
      "paymentMethodBrands": [
        {
          "id": 1,
          "name": "iDeal",
          "sequence": 1,
          "paymentMethods": [
            {
              "id": 10,
              "name": "iDeal",
              "direction": "DEBIT",
              "collecting": true,
              "paymentType": "SALE",
              "amount": {
                "value": 100,
                "currency": "EUR"
              },
              "costs": {
                "value": 3000,
                "currency": "EUR",
                "vatPercentage": 21
              },
              "releaseDate": "2024-06-04",
              "turnoverDate": "2024-06-04",
              "transactions": 5,
              "uniquePayers": 3
            }
          ]
        }
      ]
    }
  ]
}