---
title: "Update the settings of a Payter payment terminal"
method: PATCH
path: "/api/v1/payment-terminals/{paymentTerminalId}/settings"
tags: ["Payment Terminals"]
---

# Update the settings of a Payter payment terminal

`PATCH /api/v1/payment-terminals/{paymentTerminalId}/settings`

## Request

- Base URL: `https://partner-api.monta.com`
- URL: `https://partner-api.monta.com/api/v1/payment-terminals/{paymentTerminalId}/settings`
- Auth: HTTP bearer

Changes the settings of the `payter` terminal identified by `{type}_{id}` (e.g. `payter_123`). Only the fields sent are changed; omitted fields keep their value. Read the current settings from `payterSettings` on `GET /payment-terminals` or `GET /payment-terminals/{id}`.<br><br>*When changes reach the terminal*: nothing is pushed to the device. `maxReservationAmount`, `tapToStop`, `rfid` and `locale` apply from the next session. `touchscreen` and `startScreen` show the next time the idle screen is redrawn: right after a session, or within about 75 minutes on a terminal with no traffic.<br><br>*Bulk*: there is no bulk endpoint. To change many terminals, list them (filter on `hardwareModel` client-side, e.g. `apollo`) and call this endpoint once per terminal, staying within your rate limit.<br>Required scope: `payment-terminals:write`

## Path parameters

- `paymentTerminalId` string, required

## Request body

- PatchPayterSettings: Only the fields sent are changed.
  - `maxReservationAmount` number, nullable: Highest amount reserved on the card when a session starts, in the currency of the terminal's team. Must be 0 or more. Send `null` or `0` to remove the cap.
  - `locale` string, nullable: Language shown on the terminal, e.g. `da`. Send `null` to clear it.
  - `tapToStop` boolean, nullable: Tapping the card again stops the session.
  - `rfid` boolean, nullable: RFID cards can be used on the terminal.
  - `blockChargeWhenChargePointPrivate` boolean, nullable: Block payments on charge points that are set to private.
  - `touchscreen` boolean, nullable: Turn the touchscreen flow on or off. `apollo` terminals only; other models return 422.
  - `startScreen` 'on-language-selector' | 'on-charge-point-selector'

## Response `200`

Payment terminal with the updated settings

- PaymentTerminal
  - `id` string, required: Id of this terminal. **NOTE: This is a String**
  - `type` 'payter' | 'local' | 'nayax' | 'cpi' | 'other', required
  - `teamId` integer: The team this terminal belongs to
  - `payingTeamId` integer, nullable: The team charged for sessions started on this terminal. Only set for `local` terminals
  - `idTag` string, nullable: RFID token the charge point authorises with. Only set for `local` terminals
  - `chargePointIds` integer[], required: The charge points ids this terminal is assigned to
  - `serial` string, required: Serial number of the Payment Terminal
  - `name` string, required: Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant
  - `isConnected` boolean: Indicates if the terminal is connected or disconnected.
  - `connectedAt` string, date-time, nullable: Date this payment terminal did connect
  - `createdAt` string, date-time, required: Date this entity was created
  - `updatedAt` string, date-time, nullable: Date this entity was updated
  - `deletedAt` string, date-time, nullable: Date this entity was deleted
  - `hardwareModel` 'p6' | 'apollo' | 'unknown'
  - `payterSettings` PayterSettings
    - `maxReservationAmount` number, nullable: Highest amount reserved on the card when a session starts, in the currency of the terminal's team. `null` or `0` means no cap. Not the same as `priceLimit`, which only applies to `local` terminals.
    - `locale` string, nullable: Language shown on the terminal. `null` when none is set.
    - `tapToStop` boolean: Tapping the card again stops the session.
    - `rfid` boolean: RFID cards can be used on the terminal.
    - `blockChargeWhenChargePointPrivate` boolean: Block payments on charge points that are set to private.
    - `touchscreen` boolean, nullable: Touchscreen flow is on. Only set for `apollo` terminals.
    - `startScreen` 'on-language-selector' | 'on-charge-point-selector'

## Other responses

- `400`: The request is invalid
- `401`: Consumer with provided credentials was not found
- `403`: Operator doesn't have access to resource
- `404`: Entity with the provided id was not found
- `422`: Validation failed, e.g. a negative `maxReservationAmount`, an unknown `locale`, or `touchscreen`/`startScreen` sent for a terminal that is not an `apollo`

## Changes

- **2026-11-03** `0ca400461c52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/monta/apis/monta-partner-api/changes/api/v1/payment-terminals/:paymentTerminalId/settings/patch.md)

---

[API](https://skmtc.dev/monta/apis/monta-partner-api.md) - [All operations](https://skmtc.dev/monta/apis/monta-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/monta/apis/monta-partner-api/revisions/0ca400461c52?raw)