Turning API mode on and off

Helcim gives you the flexibility to choose how you interact with our systems. You can enable API mode to allow your existing software to communicate directly with compatible Helcim devices through the Payment Hardware API, or disable it to utilize the built in Helcim point-of-sale application.

How to manage API mode

To change your API mode setting, you must have Administrator privileges. You can manage this setting within your Helcim account while logged in through a web browser, or directly on the device.

🚧

Important note

Enabling API mode applies to all compatible Helcim devices linked to your account. This means the built-in Helcim point-of-sale (POS) system will no longer be accessible and should be replaced by your custom integration on these devices.

Switch API mode on or off

Follow the preferred set of instructions below to manage how your payment hardware connects to your account.

Through your Helcim account

1. Log in to your Helcim account through a web browser.
2. Click All Tools in the top left corner.
3. Click Settings.
4. Click Point-of-Sale under Tools.
5. Toggle API mode ON or OFF based on your preference.

Once API mode is enabled, your devices will begin the registration process. If logged in on your device, please log out and then back in for this change to take effect.

On your payment hardware

1. Log in to your compatible Helcim payment hardware.
2. Tap More in the bottom right corner.
3. Tap Settings.
4. Tap Merchant account settings.
5. Tap Smart Terminal API mode.
6. Toggle API mode ON or OFF based on your preference.

Once API mode is enabled, your devices will begin the registration process. If logged in on your device, please log out and then back in for this change to take effect.

Common questions

Does API mode work with in-person Fee Saver?

Yes, API mode works with our Fee Saver feature. If you use this feature, your compatible Helcim devices in API mode will automatically calculate and show the surcharge amount and screen to your customers during checkout.

Will my existing device settings still work?

Yes. Even in API mode, your devices will follow your previous settings, such as:

• Automatically printing receipts.
• Printing a merchant copy for your records.

To change your device settings in API mode tap the Options button in the top left corner of the payment screen.

What if I only want API mode on some of my devices?

Currently, API mode applies to every compatible payment hardware device on your account. If you want to keep some devices on the standard Helcim point-of-sale system, we recommend opening a second Helcim account for those specific devices. You can sign up for an additional account on our website.

What happens when I turn API mode off?

Once you disable API mode, the standard Helcim point-of-sale system returns to your devices after being restarted. Any requests sent from your software to the Payment Hardware API will be declined with an error response. You can view our guide on errors and error handling to learn more about these responses.

Will my devices keep their device codes if I toggle the API mode setting?

Yes. Your payment hardware stores its unique device code in its hardware settings. If you turn API mode off and then turn it back on later, your existing codes will still work.