Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Services

Services:Browse

Get all services. If you do not supply a merchant we return the services that are available under your own merchant registration. If you supply a merchant you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.

get/v2/services

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

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

Response

OK

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "services": [
    {
      "code": "SL-1234-4321",
      "secret": "95c4ae0613c23435089dc0b480d98ce786a4e22a",
      "name": "Your Service",
      "description": "Selling clothing for woman, man and children. We are open 7 days a week!",
      "translations": {
        "translations": {
          "name": {
            "nl_NL": "...",
            "en_GB": "..."
          },
          "description": {
            "nl_NL": "...",
            "en_GB": "..."
          }
        }
      },
      "category": {
        "code": "CY-1234-4321",
        "name": "Pharmacy"
      },
      "mcc": 5999,
      "tradeName": {
        "code": "TM-1234-4321",
        "name": "TradeName"
      },
      "status": "ACTIVE",
      "integrationVersion": {
        "code": "PV-1234-4321",
        "name": "Via cashboard"
      },
      "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"
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}