Update the settings of a Payter payment terminal

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}.

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.

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.
Required scope: payment-terminals:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Only the fields sent are changed.

number | null

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.

string | null

Language shown on the terminal, e.g. da. Send null to clear it.

boolean | null

Tapping the card again stops the session.

boolean | null

RFID cards can be used on the terminal.

boolean | null

Block payments on charge points that are set to private.

boolean | null

Turn the touchscreen flow on or off. apollo terminals only; other models return 422.

string | null
enum

First screen of the touchscreen flow. apollo terminals only; other models return 422.

Allowed:
Responses

422

Validation failed, e.g. a negative maxReservationAmount, an unknown locale, or touchscreen/startScreen sent for a terminal that is not an apollo

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json