Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Terminal

Terminals:Update

Update a specific terminal linked to your account. You can update the name, description, and point of sale (service) for the terminal.

patch/v2/terminals/{terminalCode}

Path parameters

terminalCodestring required

Provide the TH-code of the terminal that you want to update

Request body

serviceCodestring nullable

The service code for the terminal.

namestring nullable

The name of the terminal.

descriptionstring nullable

The description of the terminal.

enableRefundsboolean nullable

Enable the ability to refund on this terminal.

refundEnabledboolean nullable

Example request

{
  "serviceCode": "SL-1234-4321",
  "name": "Terminal Shop.",
  "description": "POI: 5028314",
  "enableRefunds": true
}

Response

OK

codestring

The terminal identifier.

namestring nullable

The name of the terminal.

attributionstring nullable

The terminal attribution.

status'ACTIVE' | 'BLOCKED' | 'INACTIVE' | 'NEW' | 'REQUESTED_CONTRACT_LINK' | 'REQUESTED_TID' | 'null' nullable

The current status of the terminal.

connectionStatus'OFFLINE' | 'ONLINE' | 'null' nullable

The current connection status of the terminal.

descriptionstring nullable

The terminal description.

enableRefundsboolean

Indicates whether refunds are enabled for this terminal.

hardwareCodestring nullable

The hardware code of the terminal.

serialNumberstring nullable

The serial number of the terminal.

terminalTypeCodestring nullable

The terminal type code.

terminalTypestring nullable

The terminal type.

ecrProtocol'BT' | 'WEB' | 'null' nullable

The ECR protocol.

contractStartDatestring date-time

The terminal contract start date.

contractEndDatestring date-time

The terminal contract end date.

paymentTypesstring[]

The terminal payment types.

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": "TH-1234-4321",
  "name": "Terminal Shop.",
  "attribution": "PAY.nl* CompanyName",
  "status": "ACTIVE",
  "connectionStatus": "ONLINE",
  "merchant": {
    "code": "M-1234-4321",
    "name": "CompanyName",
    "status": "ACTIVE",
    "incorporationCountry": "NL"
  },
  "service": {
    "code": "SL-1234-4321",
    "status": "ACTIVE",
    "name": "Shop",
    "mcc": 5992,
    "contactPhone": "061111111",
    "contactEmail": "sandbox@pay.nl"
  },
  "description": "POI: 5028314",
  "enableRefunds": true,
  "hardwareCode": "TL-1234-4321",
  "serialNumber": "BHV3603",
  "terminalTypeCode": "TY-1234-4321",
  "terminalType": "YOMANI Base UNIT NFC",
  "supplier": {
    "id": 1,
    "name": "AtosWorldline",
    "terminalid": "123456789"
  },
  "ecrProtocol": "WEB",
  "terminalServer": {
    "code": "TS-1234-1234",
    "name": "4115ad3c-pin.pay.nl"
  },
  "contractStartDate": "2022-07-11",
  "contractEndDate": "2025-07-11",
  "paymentTypes": [
    "SALE",
    "REFUND"
  ],
  "terminalBrands": [
    {
      "id": 1009,
      "name": "MAESTRO",
      "image": "/terminal_brands/1009.svg",
      "acquirer": "AWL Europe",
      "acquirerTid": "123456",
      "acquirerMid": "123456",
      "acquirerChecksum": "123",
      "paymentTypes": [
        "SALE",
        "REFUND"
      ],
      "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"
    }
  ],
  "location": {
    "code": "CA-1234-4312",
    "streetName": "Delivery-Lane",
    "streetNumber": "70",
    "zipCode": "1234CD",
    "city": "Amsterdam",
    "countryCode": "NL"
  },
  "settings": {
    "refund": {
      "allowed": true,
      "policyId": "A",
      "policyData": {
        "refundTrxLimit": 100,
        "refundTrxAmount": 1000,
        "refundDayLimit": 50
      }
    },
    "ticketFooter": {
      "test": "hello!"
    },
    "ticketHeader": {
      "default": 55
    }
  },
  "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"
}