Registering Devices with the Smart Terminal API

Generate your unique device code used to pair your device with your existing point of sale system or software.

Once API mode is enabled, each Smart Terminal device associated with your Helcim business account will go through an automatic registration process with our system. This registration allows your devices to be paired with your existing third-party point of sale software and receive payment requests through the Smart Terminal API.

Device Registration Process

In order to begin the automatic registration process for your devices, you must first enable API mode in your Helcim account settings, as outlined here. If any devices are logged in when API mode is enabled, they will not begin this process until their next log in.

  • Log in to your Smart Terminal using your user PIN or email and password.
  • The Smart Terminal will then register with the Helcim system automatically.
  • The Helcim system will assign a unique code to the Smart Terminal device and this will be displayed in the Smart Terminal's UI while in API mode.
  • Once the registration process is completed, the Smart Terminal will establish a secure connection with our system before being ready to accept payments through the Smart Terminal API.

The code assigned to your Smart Terminal is used when pairing your devices with your point of sale system and is how the Helcim system knows which device to send requests to through the Smart Terminal API.

Smart Terminal API log out screen

Frequently Asked Questions

What happens if I enable API mode before I complete my initial Smart Terminal configuration?

If you have not yet completed the initial set up and Helcim app installation for your Smart Terminal device, or you receive a new or additional Smart Terminal device after integrating with the Smart Terminal API, it will prompt these set up processes in the same manner as any Smart Terminal set up.

The registration process for API mode is triggered on device log in, which is not possible until after this configuration is completed.