Upload Terminal Configuration

POST /v2/configuration/pos

Description

This endpoint allows a terminal to upload a block of configuration to the backend. The configuration will be saved (and overwrites any existing) for the terminal specified within the body.

Body

Example Body

{
    "terminalId": String,
    "configuration": String
}

Returns

The same blob that was saved to the repository or a an error and appropriate response code.

Example Response

{
    "terminalId": String,
    "configuration": String
}

Get Terminal Configuration

GET /v2/configuration/pos/{terminalId}

Description

Return the configuration blob for the terminal

Path Parameters

  • terminalId:  The ID of the terminal to retrieve the configuration for

Returns

The POS configuration blob or 404 if that terminal does not have any configuration.

Example Response

{
    "terminalId": String,
    "configuration": String
}

Get Terminal Configuration Only

GET /v2/configuration/pos/{terminalId}/configuration

Description

Return the configuration text from the configuration entry

Path Parameters

  • terminalId:  The ID of the terminal to retrieve the configuration for

Query Parameters

  • contentType:  Specify the return content-type header. The configuration is just stored as text and by default will be returned as 'text/plain'. You can override this using the query string.

Returns

The POS configuration string or 404 if that terminal does not have any configuration.

Example Response

String (configuration field is returned)

Enumeration Values for Hardware

The settings for hardware are encoded with enumerations. The following provides the key to those enumeration values.

Vendors

  • 0 - None
  • 1 - Epson
  • 2 - Boca
  • 3 - MagTek
  • 4 - SocketMobile
  • 5 - Ingenico

Printer Models

  • 0 - None
  • 1 - Boca Lemur 200dpi
  • 2 - Boca Lemur 300dpi
  • 3 - Epson TM-P20
  • 4 - Epson TM-T88v
  • 5 - Zebra imZ320
  • 6 - Epson TM-T88vi

Bluetooth Card Reader Models

  • 0 - None
  • 1 - uDynamo
  • 2 - dynaMAX
  • 3 - eDynamo

Scanner Models

  • 0 - None
  • 1 - SM 7Qi

EMV Reader Models

  • 0 - None
  • 1 - Ingenico IPP-350