Pairing Devices with your Third-Party System

Helcim makes it simple to connect your existing point-of-sale software to compatible Helcim devices. To do this, you will store a unique device code in your system, which allows the Payment Hardware API to send requests to the correct piece of payment hardware.

How pairing works

Every time you register a new payment hardware in API mode on your account, our system creates a unique device code. This code stays the same even if the devices are turned off or go into sleep mode. This code is displayed on the screen of your payment hardware after registering.

To complete the pairing, you should copy this code and save it within your own software database. Your software must be able to access and send this code with every request made through the Payment Hardware API. This ensures our system knows exactly which of your compatible Helcim devices should light up to take a payment.

Steps to pair your hardware

1. Register your hardware: Make sure the automatic registration process is finished for each piece of payment hardware linked to your Helcim account.
2. Store the code: Save the unique device code values in your system so your software can use them later.
3. Verify the connection: Click the Continue button to proceed to the Ready to take payment screen and then send a payment to test the connection. You can also add a "ping" feature to your integration using the Send a Ping Event endpoint.

When you send a ping, the specific devices associated with that code will show a message on their screen. This is a great way to prove that your software and your payment hardware are talking to each other correctly.

Once you have paired your devices and confirmed the connection, you can click the continue button on the screen. Your payment hardware is now ready to accept payments through the Payment Hardware API.

📘

Pro Tip: If you have multiple devices, we recommend naming them in your software (e.g., "Front Counter" or "Garden Patio") alongside their device codes to help your staff pick the right one for each sale.

Device validation

Your payment security is important to us, so we ensure that only payment hardware linked to your specific Helcim business account can be paired with your software.

If you try to use a device code that does not exist, or one that belongs to a different business, the Payment Hardware API will return an error. This protection ensures your transactions are always sent to the right place and keeps your business data safe.