Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Payment Terminals

Create a local payment terminal

Create a local (offline) payment terminal owned by the given team.<br>Required scope: payment-terminals:write

post/api/v1/payment-terminals/local

Request body

teamIdinteger required

The team that owns the local payment terminal.

payingTeamIdinteger required

The team that pays for charges started on this terminal.

idTagstring required

The id tag (or prefix) used to authorize charges on this terminal.

idTagPrefixboolean required

If true, the id tag is treated as a prefix (any tag starting with this value is accepted).

namestring required

Display name of the local payment terminal.

priceLimitnumber double nullable

Optional spending limit (in the team's currency) per charge.

Example request

{
  "teamId": 19,
  "payingTeamId": 19,
  "idTag": "ABC123",
  "name": "Office Garage Reader",
  "priceLimit": 20
}

Response

Local payment terminal created

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