Skip to content

Create Terminals

Creates a new terminal.

Verb PUT
Endpoint {base-url}/terminals
Max Page Size 50

Request Body

{
  "body": [
    {
      "terminalId": "1196023",
      "chargeKeyId": 180,
      "addedAt": "2015-08-12T15:32:30.643",
      "number": 9690,
      "isAvailable": false,
      "isActive": true,
      "machineId": 9690,
      "assignedAt": "2015-08-12T15:32:30.643",
      "deactivatedAt": null
    }
  ]
}

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

The ids of the created terminals.

Response Body

[
  1673
]

On Error

HTTP Code Error Code Definition
422 VALIDATION_ERROR A required field is missing or invalid (e.g. terminalId exceeds 50 characters, number is less than 1, addedAt is in the future).
403 DATA_ACCESS_VIOLATION One or more of the specified machines are associated with an organization you do not have access to.
403 DATA_ACCESS_VIOLATION One or more of the specified charge keys are associated with an organization you do not have access to.
404 MISSING_RECORD One or more of the specified machines could not be found.
404 MISSING_RECORD One or more of the specified charge keys could not be found.