Terminals

Before creating a terminal, you must first authenticate.

Create Terminal

Creation a new Terminal under a Merchant location using this API endpoint:

POST/Locations/{locationId}/terminals

Path parameters

locationId*string

Body

application/jsontext/jsonapplication/*+json

idnullable string

creatednullable string (date-time)

updatednullable string (date-time)

cryptoPaymentGateways*array of CryptoGatewayUnencrypted (object)

cardPaymentGateways*array of CardGatewayUnencrypted (object)

namenullable string

descriptionnullable string

webhookUrlnullable string

isEnabled*boolean

Response

200

OK

Body

text/plainapplication/jsontext/json

login*string

password*string

terminal*all of

Request

JavaScriptCurlPython

const response = await fetch('/Locations/{locationId}/terminals', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "cardPaymentGateways": [
          {
            "apiCredentials": "text",
            "apiKey": "text",
            "externalProps": {
              "system": {}
            },
            "id": 0,
            "isEnabled": false,
            "optionIds": [
              "text"
            ],
            "paymentCurrencyIds": [
              0
            ],
            "paymentGatewayType": {},
            "paymentProcessorId": "text"
          }
        ],
        "cryptoPaymentGateways": [
          {
            "apiCredentials": "text",
            "apiKey": "text",
            "apiSecret": "text",
            "externalProps": {
              "system": {}
            },
            "id": 0,
            "isEnabled": false,
            "optionIds": [
              "text"
            ],
            "paymentCurrencyIds": [
              0
            ],
            "paymentGatewayType": {},
            "paymentProcessorId": "text"
          }
        ],
        "isEnabled": false
      }
    ]),
});
const data = await response.json();

Response

200

[
  {
    "login": "text",
    "password": "text",
    "terminal": {
      "id": "text",
      "created": "2024-12-30T15:24:27.385Z",
      "updated": "2024-12-30T15:24:27.385Z",
      "merchantId": "text",
      "merchantLocationId": "text",
      "paymentGateways": [
        {
          "id": 0,
          "paymentProcessorId": "text",
          "paymentGatewayType": {},
          "apiCredentials": "text",
          "publicSecurityKey": "text",
          "paymentCurrencyIds": [
            0
          ],
          "optionIds": [
            "text"
          ],
          "externalProps": {
            "system": {},
            "id": "text",
            "additionalData": {}
          },
          "isEnabled": false
        }
      ],
      "name": "text",
      "description": "text",
      "webhookUrl": "https://example.com",
      "webhookSecretEncrypted": "text",
      "isEnabled": false
    }
  }
]