MOmonta
Payment Terminals

Update the settings of a Payter payment terminal

Changed on

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

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

Path parameters

paymentTerminalIdstring required

Request body

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

localestring nullable

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

tapToStopboolean nullable

Tapping the card again stops the session.

rfidboolean nullable

RFID cards can be used on the terminal.

blockChargeWhenChargePointPrivateboolean nullable

Block payments on charge points that are set to private.

touchscreenboolean nullable

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

startScreen'on-language-selector' | 'on-charge-point-selector'

Example request

{
  "maxReservationAmount": 50,
  "locale": "da",
  "tapToStop": true,
  "rfid": true,
  "touchscreen": true
}

Response

Payment terminal with the updated settings

idstring required

Id of this terminal. NOTE: This is a String

type'payter' | 'local' | 'nayax' | 'cpi' | 'other' required
teamIdinteger

The team this terminal belongs to

payingTeamIdinteger nullable

The team charged for sessions started on this terminal. Only set for local terminals

idTagstring nullable

RFID token the charge point authorises with. Only set for local terminals

chargePointIdsinteger[] required

The charge points ids this terminal is assigned to

serialstring required

Serial number of the Payment Terminal

namestring required

Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant

isConnectedboolean

Indicates if the terminal is connected or disconnected.

connectedAtstring date-time nullable

Date this payment terminal did connect

createdAtstring date-time required

Date this entity was created

updatedAtstring date-time nullable

Date this entity was updated

deletedAtstring date-time nullable

Date this entity was deleted

hardwareModel'p6' | 'apollo' | 'unknown'

Example response

{
  "id": "payter_123",
  "payingTeamId": 1234,
  "idTag": "04A1B2C3D4E5F6",
  "serial": "XYZ123-DF-123",
  "name": "MyPaymentTerminal 042",
  "isConnected": true,
  "connectedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z",
  "payterSettings": {
    "maxReservationAmount": 50,
    "locale": "da",
    "tapToStop": true,
    "rfid": true,
    "touchscreen": true
  }
}

Changes