Pairing devices with your third-party system

Pair your devices by storing your unique device codes and send transactions from your existing third-party point of sale system or software.

Smart Terminal devices are paired with your existing third-party software by storing the unique device code in your existing system, then optionally validating the code generated is correct through the Send a Ping Event endpoint.

The code generated is stored in the Smart Terminal's Hardware Settings and will remain consistent between power and sleep cycles. It should be copied and saved in your system, on your side of the integration.

This code should be sent with all applicable requests to devices through the Smart Terminal API. In order to connect your existing point of sale system with Helcim, it must have the capability of being configured to save or access these stored details from your system, to be sent in these requests.

Pair your devices with your third-party system

  • Ensure that the automatic registration process has been completed for each Smart Terminal device associated with your Helcim business account.
  • Store your device code values in your system for your point of sale software to access.
  • To ensure that you have recorded your device code correctly, you can optionally implement a ping process within your integration using the Send a Ping Event endpoint. This will send a ping to a specific paired device based on the code, which will be visible on the UI of the device to confirm and validate a successful connection.

Once a device has been paired with your system, you can click the continue button and the Smart Terminal device will be ready to accept payments through the Smart Terminal API.

Smart Terminal API ready to pair screen

Device validation

  • Only Smart Terminal devices that are associated with your Helcim business account can be paired with your existing point of sale software.
  • In the event that you enter a device code that does not exist, or that belongs to a Smart Terminal that is not registered to your business, the Smart Terminal API will return an error response.
Pinging a device with a deviceCode that is not registered for your account.

Pinging a device with a device code that is not registered for your account.