Skip to main content
POST
/
v1
/
terminals
Create
curl --request POST \
  --url https://api.ecrypt.com/v1/terminals \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "registrationCode": "<string>",
  "nickname": "<string>",
  "deviceId": "<string>",
  "configuration": {
    "promptTip": true,
    "tipAmounts": [
      123
    ],
    "promptCvv": true,
    "promptPostalCode": true,
    "promptAmountConfirmation": true,
    "promptSignature": true,
    "keyCard": true
  }
}
'
{
  "requestId": "000000000000000000000",
  "terminals": [
    {
      "id": "<string>",
      "make": "<string>",
      "model": "<string>",
      "serialNumber": "<string>",
      "nickname": "<string>",
      "status": "<string>"
    }
  ],
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Authorization by x-api-key inside request's header

Body

registrationCode
string
required

Registration code is listed on your powered up terminal. This is a 6 character code.

Minimum string length: 1
nickname
string
required

Terminal nickname will be displayed on the terminal, and in the console.

Required string length: 1 - 20
Pattern: ^[0-9A-Za-z _-]*$
deviceId
string | null

Device identifier is on the back of your terminal. This is an 8 character code. Required for Canadian processing.

configuration
object

Response

object | null

OK

requestId
string
default:000000000000000000000
required
Required string length: 1 - 100
terminals
(object | null)[] | null
errors
(object | null)[] | null