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
  }
}
'
import requests

url = "https://api.ecrypt.com/v1/terminals"

payload = {
"registrationCode": "<string>",
"nickname": "<string>",
"deviceId": "<string>",
"configuration": {
"promptTip": True,
"tipAmounts": [123],
"promptCvv": True,
"promptPostalCode": True,
"promptAmountConfirmation": True,
"promptSignature": True,
"keyCard": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
registrationCode: '<string>',
nickname: '<string>',
deviceId: '<string>',
configuration: {
promptTip: true,
tipAmounts: [123],
promptCvv: true,
promptPostalCode: true,
promptAmountConfirmation: true,
promptSignature: true,
keyCard: true
}
})
};

fetch('https://api.ecrypt.com/v1/terminals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ecrypt.com/v1/terminals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'registrationCode' => '<string>',
'nickname' => '<string>',
'deviceId' => '<string>',
'configuration' => [
'promptTip' => true,
'tipAmounts' => [
123
],
'promptCvv' => true,
'promptPostalCode' => true,
'promptAmountConfirmation' => true,
'promptSignature' => true,
'keyCard' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.ecrypt.com/v1/terminals"

payload := strings.NewReader("{\n \"registrationCode\": \"<string>\",\n \"nickname\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"configuration\": {\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.ecrypt.com/v1/terminals")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"registrationCode\": \"<string>\",\n \"nickname\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"configuration\": {\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ecrypt.com/v1/terminals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"registrationCode\": \"<string>\",\n \"nickname\": \"<string>\",\n \"deviceId\": \"<string>\",\n \"configuration\": {\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "000000000000000000000",
  "terminals": [
    {
      "id": "<string>",
      "make": "<string>",
      "model": "<string>",
      "serialNumber": "<string>",
      "nickname": "<string>",
      "status": "<string>"
    }
  ],
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}
{
"requestId": "000000000000000000000",
"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 | null

Response

object | null

OK

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