Terminals

Before creating a terminal, you must first authenticate.

Create Terminal

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

POST/Terminals

Authorization

oauth2

Header parameters

Body

application/jsontext/jsonapplication/*+json

idnullable string

creatednullable string (date-time)

updatednullable string (date-time)

merchantId*string

cryptoPaymentGateways*array of CryptoGatewayUnencrypted (object)

cardPaymentGateways*array of CardGatewayUnencrypted (object)

namenullable string

descriptionnullable string

webhookUrlnullable string

isEnabled*boolean

Response

200401403

Success

Body

text/plainapplication/jsontext/json

idnullable string

creatednullable string (date-time)

updatednullable string (date-time)

merchantId*string

paymentGateways*array of PaymentGateway (object)

namenullable string

descriptionnullable string

webhookUrlnullable string (uri)

webhookSecretEncryptednullable string

isEnabled*boolean

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "created": "2024-10-18T04:45:44.045Z",
  "updated": "2024-10-18T04:45:44.045Z",
  "merchantId": "text",
  "paymentGateways": [
    {
      "paymentProcessorId": "text",
      "paymentGatewayType": 0,
      "apiCredentials": "text",
      "publicSecurityKey": "text",
      "paymentCurrencyIds": [],
      "optionIds": [
        "text"
      ],
      "externalProps": {
        "system": 0,
        "id": "text"
      },
      "isEnabled": false
    }
  ],
  "name": "text",
  "description": "text",
  "webhookUrl": "https://example.com",
  "webhookSecretEncrypted": "text",
  "isEnabled": false
}

Example request body:

{
  "merchantId": "663d0161236bd8a202b82028",
  "cryptoPaymentGateways": [
    {
      "id": 1,
      "paymentProcessorId": "654846dhda35f02d28aed26a",
      "paymentGatewayType": 0,
      "apiCredentials": "123",
      "publicSecurityKey": "test",
      "paymentCurrencyIds": [
        1000,1007,1009,1001
      ],
      "optionIds": [
        "pp_show_merchant_logo"
      ],
      "externalProps": {
        "system": 1
      },
      "isEnabled": true,
      "apiKey": "string",
      "apiSecret": "string"
    }
  ],
  "name": "Sample Terminal",
  "isEnabled": true
}

Example response:

{
  "merchantId": "663d0161326bd8a202b82028",
  "paymentGateways": [
    {
      "id": 1,
      "paymentProcessorId": "654846dgda35f02d28aed26a",
      "paymentGatewayType": 0,
      "apiCredentials": "123",
      "publicSecurityKey": "test",
      "paymentCurrencyIds": [
        1000,
        1007,
        1009,
        1001
      ],
      "optionIds": [
        "pp_show_merchant_logo"
      ],
      "externalProps": {
        "system": 1
      },
      "isEnabled": true
    }
  ],
  "name": "Sample Terminal",
  "isEnabled": true,
  "id": "663d025e236bd9a202b82029",
  "created": "2024-05-09T17:05:34Z",
  "updated": "2024-05-09T17:05:34.9934927Z"
}