---
title: "Terminals:Update"
method: PATCH
path: "/v2/terminals/{terminalCode}"
tags: ["Terminal"]
---

# Terminals:Update

`PATCH /v2/terminals/{terminalCode}`

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

## Path parameters

- `terminalCode` string, required

## Request body

- TerminalTerminalInput — The payload for updating a terminal.
  - `serviceCode` string, nullable — The service code for the terminal.
  - `name` string, nullable — The name of the terminal.
  - `description` string, nullable — The description of the terminal.
  - `enableRefunds` boolean, nullable — Enable the ability to refund on this terminal.
  - `refundEnabled` boolean, nullable

## Response `200`

OK

- TerminalTerminalOutput — The full details of a terminal, including hardware, and contract.
  - `code` string — The terminal identifier.
  - `name` string, nullable — The name of the terminal.
  - `attribution` string, 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.
  - `merchant` TerminalTerminalOutputMerchant — The merchant linked to a terminal.
    - `code` string — The merchant id of your company starting with M.
    - `name` string — Merchant state
    - `status` 'ACTIVE' | 'INACTIVE' — The name of your merchant.
    - `incorporationCountry` string — The incorporationCountry field represents the country in which the entity is legally registered or incorporated.
  - `service` TerminalTerminalOutputService — The service linked to a terminal.
    - `code` string — The code of your service. You can find the service code here: https://my.pay.nl/programs/programs
    - `status` 'ACTIVE' | 'BLOCKED' | 'TO_BE_CHECKED' — The state of the service
    - `name` string — The name of your service.
    - `mcc` integer, nullable — The Merchant Category Code (mcc) of this service.
    - `contactPhone` string, nullable — The primary contact phone number.
    - `contactEmail` string, nullable — The primary contact email address.
  - `tradeName` TradeName
    - `code` string — An identifier for this TradeName
    - `name` string — A registered TradeName
  - `description` string, nullable — The terminal description.
  - `enableRefunds` boolean — Indicates whether refunds are enabled for this terminal.
  - `hardwareCode` string, nullable — The hardware code of the terminal.
  - `serialNumber` string, nullable — The serial number of the terminal.
  - `terminalTypeCode` string, nullable — The terminal type code.
  - `terminalType` string, nullable — The terminal type.
  - `supplier` TerminalTerminalOutputTerminalSupplier — The supplier of the terminal hardware.
    - `id` integer — The terminal supplier id
    - `name` string, nullable — The terminal supplier name
    - `terminalid` string, nullable — The terminal identifier
  - `ecrProtocol` 'BT' | 'WEB' | 'null', nullable — The ECR protocol.
  - `terminalServer` TerminalTerminalOutputTerminalServer — The connected terminal server configuration.
    - `code` string — The connected terminal server code.
    - `name` string, nullable — The connected terminal server name.
  - `contractStartDate` string, date-time — The terminal contract start date.
  - `contractEndDate` string, date-time — The terminal contract end date.
  - `paymentTypes` string[] — The terminal payment types.
  - `terminalBrands` TerminalTerminalOutputTerminalBrand[] — The terminal brands.
    - `id` integer — The terminal brand identifier
    - `name` string — The name of the terminal brand
    - `image` string — Image belonging to the terminal brand
    - `acquirer` string, nullable — The terminal acquirer
    - `acquirerTid` string, nullable — The terminal acquirer TID
    - `acquirerMid` string, nullable — The terminal acquirer MID
    - `acquirerChecksum` string, nullable — The terminal acquirer checksum
    - `paymentTypes` string[], nullable — The terminal payment types
    - `createdAt` string, date-time, nullable — The date and time at which this entity was created in ISO-8601 (ATOM) notation
    - `createdBy` string, nullable — The reference to an account or token whom created the entity
    - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation.
    - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity
    - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.
    - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity
  - `location` AddressOutput — A physical address.
    - `code` string — The address code identifier.
    - `streetName` string — The name of the street.
    - `streetNumber` string — The street number.
    - `zipCode` string — A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.
    - `city` string — The name of a city.
    - `countryCode` string — The country code consisting of 2 uppercase letters.
  - `settings` TerminalTerminalOutputSettings — The terminal settings, such as refund policy and ticket configuration.
    - `refund` TerminalTerminalOutputSettingsRefund — The refund settings of a terminal, including whether refunds are allowed and the applied policy.
      - `allowed` boolean, nullable — Indicator if refunds are allowed for transactions made with this terminal.
      - `policyId` string, nullable — The identifier of the active policy.
      - `policyData` object — The data of the active policy.
    - `ticketFooter` object — The data that is used for the footer of the ticket.
    - `ticketHeader` object — The data that is used for the header of the ticket.
  - `createdAt` string, date-time, nullable — The date and time at which this entity was created in ISO-8601 (ATOM) notation
  - `createdBy` string, nullable — The reference to an account or token whom created the entity
  - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation.
  - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity
  - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.
  - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `422` — Unprocessable entity
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)