Registering Devices with the Payment Hardware API

Helcim makes it easy to connect your compatible devices to your custom software. Once you enable API mode, every one of your compatible Helcim devices will automatically register with our system so they can receive payment requests through the Payment Hardware API.

Device registration process

To start the registration process, you must first turn on API mode in your Helcim account settings. If any devices are already logged in when you change this setting, they will not start the process until the next time someone logs in.

Follow these steps to register your payment hardware:

1. Log in to your compatible Helcim devices using your user PIN or your email and password.
2. The devices will register with the Helcim system automatically.
3. Helcim will assign a unique code to each piece of payment hardware. You will see this code on the screen of the devices while they are in API mode.
4. The payment hardware will then create a secure connection with our system.

The code shown on your device is very important. You will use this code to pair your payment hardware with your point-of-sale system. This is how the Helcim system knows exactly which device should receive your payment request.

Common questions

What if I enable API mode before I finish setting up my devices?

If you are setting up new payment hardware for the first time, or if you add more compatible Helcim devices later, you will still need to follow the standard initial setup. This includes installing the Helcim app and configuring your basic settings.

The registration for the Payment Hardware API only happens when a user logs in. You cannot log in until the initial configuration is complete.

Do I need a new device code every time I use the API?

No. Once your payment hardware is registered with our system, it will remember its unique code. You only need to register the devices once unless you manually reset them or remove them from your account.

How many devices can I register?

We want to help your business grow. You can register as many compatible Helcim devices as you need for your business. Each piece of payment hardware will receive its own unique code for easy tracking.