Terminals

Physical terminals for payments

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

areaIdstring[]OptionalExample: ["les","w37"]

Responses

200

Returns a TerminalCollection

application/json

_totalnumberRequired

get/terminals

GET /apis/v2/terminals HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a TerminalCollection

{
  "items": [
    {
      "id": "text",
      "createdDate": "2026-01-01T00:00:00.000Z",
      "displayName": "text",
      "stripeReader": {
        "id": "text"
      },
      "area": {
        "id": "text"
      },
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringRead-onlyRequired

createdDatestring · date-timeRead-onlyRequired

displayNamestringRequired

registrationCodestringWrite-onlyRequired

serialNumberstringWrite-onlyRequired

_linksobjectRequired

Responses

201

Returns a Terminal

application/json

idstringRead-onlyRequired

createdDatestring · date-timeRead-onlyRequired

displayNamestringRequired

registrationCodestringWrite-onlyRequired

serialNumberstringWrite-onlyRequired

_linksobjectRequired

post/terminals

POST /apis/v2/terminals HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "displayName": "text",
  "registrationCode": "text",
  "serialNumber": "text",
  "area": {
    "id": "text"
  },
  "_links": {}
}

201

Returns a Terminal

{
  "id": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "displayName": "text",
  "stripeReader": {
    "id": "text"
  },
  "area": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

terminalIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns a Terminal

application/json

idstringRead-onlyRequired

createdDatestring · date-timeRead-onlyRequired

displayNamestringRequired

registrationCodestringWrite-onlyRequired

serialNumberstringWrite-onlyRequired

_linksobjectRequired

get/terminals/{terminalId}

GET /apis/v2/terminals/{terminalId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a Terminal

{
  "id": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "displayName": "text",
  "stripeReader": {
    "id": "text"
  },
  "area": {
    "id": "text"
  },
  "_links": {}
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

terminalIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns a Terminal

application/json

idstringRead-onlyRequired

createdDatestring · date-timeRead-onlyRequired

displayNamestringRequired

registrationCodestringWrite-onlyRequired

serialNumberstringWrite-onlyRequired

_linksobjectRequired

post/terminals/{terminalId}/cancel-action

POST /apis/v2/terminals/{terminalId}/cancel-action HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a Terminal

{
  "id": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "displayName": "text",
  "stripeReader": {
    "id": "text"
  },
  "area": {
    "id": "text"
  },
  "_links": {}
}