PApayarc
Terminal

Register a terminal with AWS IoT Core

This API Endpont allows the user to register a terminal with AWS IoT Core.

post/v3/terminal/register

Request

  • Base URL
    https://testpayarcconnectapi.payarc.net
  • URL
    https://testpayarcconnectapi.payarc.net/v3/terminal/register
  • Auth
    none required

Request body

serialNumberstring required

Serial number of the terminal

modelstring required

Model of the terminal

tenantIdstring required

12-digit merchant identifier (MID).

Response

Terminal Registered Successfully

terminalNamestring required

AWS IoT name associated with the terminal

certificatePemstring required

X.509 device certificate in PEM format

privateKeyPemstring required

Private key in PEM format

rootCaPemstring required

AWS IoT Root CA in PEM format

iotEndpointstring required

AWS IoT MQTT endpoint the terminal should connect to

certificateExpirationstring

Date in which the IoT Certificate expires

Example response

{
  "terminalName": "TERMINAL_0823316534",
  "iotEndpoint": "abcd12345678-ats.iot.us-east-1.amazonaws.com",
  "certificateExpiration": "2049-12-31T23:59:59Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.