v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Core Data

Categories

Get all categories that can be used to onboard new sales locations or check the Payment methods that are available for a specific category.

get/v2/categories

Query parameters

eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

Provides filtering based on category code.

{
  "eq": "CY-1234-5678",
  "neq": "CY-1234-5678"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that contain the given value

nlikestring

Get results that do not contain the given value

Provides filtering based on category name.

{
  "eq": "Retail",
  "neq": "Retail",
  "like": "Retail",
  "nlike": "Retail"
}

Response

OK

totalinteger nullable

The total items the collection contains

Example response

{
  "categories": [
    {
      "code": "CY-1234-4321",
      "name": "Electronic sales",
      "description": "Televisions, laptops, computer, network hardware",
      "sequence": 3,
      "available": true,
      "initialMCC": 2130,
      "initialRiskCategory": "LOW",
      "translations": {
        "...": {
          "nl_NL": "The Dutch translation",
          "en_GB": "The British translation",
          "nl_BE": "The Flemish translation",
          "fr_FR": "The French translation",
          "de_DE": "The German translation",
          "it_IT": "The Italian translation",
          "es_ES": "The Spanish translation"
        }
      },
      "paymentMethods": [
        {
          "id": "3",
          "name": "iDeal"
        }
      ],
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "total": 10
}