v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Payment Terminals

Retrieve a single payment terminal

Required scope: payment-terminals:read

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

Path parameters

paymentTerminalIdstring required

Response

Payment Terminal with provided id

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