Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Services

Service:Get

Retrieve a single service based on the given SL-code. Note that the request can only be successful when you have permission to access that service.

get/v2/services/{serviceId}

Path parameters

serviceIdstring required

Provide the SL-code of the service that you want to retrieve

Response

OK

codestring

The code of your service. You can find the service code here: https://my.pay.nl/programs/programs

secretstring

A 40 character secret

namestring

The name of the service

descriptionstring nullable

A short description of the service

translationsobject

Object containing all the translations with the property name in which the corresponds with a property on the object itself.

mccinteger nullable

The MCC identifier

testModeboolean

Whether or not the service is in test mode

status'ACTIVE' | 'BLOCKED' | 'TO_BE_CHECKED'

The status that the service has

reviewedAtstring date-time nullable
createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "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"
}