MOmonta
Payment Terminals

Retrieve a single payment terminal

Changed on

Required scope: payment-terminals:read

get/api/v1/payment-terminals/{paymentTerminalId}

Request

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

Path parameters

paymentTerminalIdstring required

Response

Payment Terminal with provided id

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

  • 0ca400461c52Revision changes
    • warning

      added the new cpi enum value to the //// response property for the response status

    • warning

      added the new nayax enum value to the //// response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status