Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Payment Terminals

Update a local payment terminal

Update the paying team, id tag, name, and price limit of a local payment terminal.<br>Required scope: payment-terminals:write

put/api/v1/payment-terminals/local/{terminalId}

Path parameters

terminalIdinteger required

Request body

payingTeamIdinteger required
idTagstring required
idTagPrefixboolean required
namestring required
priceLimitnumber nullable

Response

Updated local payment terminal

idstring required

Id of this terminal. NOTE: This is a String

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

The team this terminal belongs to

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

Example response

{
  "id": "payter_123",
  "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"
}