Testing the Payment Hardware API

Helcim is here to help you build a seamless checkout experience. This guide will walk you through getting the right tools to test your integration and ensure your software works perfectly with compatible Helcim devices.

Step 1: Setting up a developer test account

To test your integration with the Payment Hardware API, you should start by setting up a developer test account, if you do not already have one.

Please connect with our team at [email protected]. We are happy to help you get a test environment up and running. When you reach out, let us know you want to integrate with the Payment Hardware API. If you already have an existing Helcim account, please include your Helcim merchant ID number with your request.

Step 2: Ordering your equipment

We want to make testing easy. Helcim can provide loaner payment hardware for your integration testing, or you can choose to purchase your compatible Helcim devices up front.

If you choose a loaner, the payment hardware needs to come back to us after three months. If the devices are not returned, or you decide to keep them for your business, we will charge the full price of the equipment.

To request loaner payment hardware, please email our Tier 2 Support team at [email protected] for more details.

Step 3: Receiving your equipment

Once you receive your compatible Helcim devices, complete the setup and configuration steps. You can find these steps in our support documentationhere. You will have access to your devices settings while it is in API mode, so you can change any settings that you might have pre-configured without needing to switch back to the Helcim POS mode.

Step 4: Turn API mode on

Once you have logged in and configured your devices, you can turn on API mode in your Helcim account settings. API mode will switch all compatible Helcim devices from the standard Helcim POS to API mode, allowing them to accept payments from your third-party software.

Step 4: Integrate and test

Now that you are logged in and your devices are ready, you can start testing the Payment Hardware API with your developer test account. Check out the rest of our documentation to learn more.

Step 5: Switching to production

After you finish testing your integration, switching to production is a simple process:

• Update the API token in your request headers for the "Start a purchase" and "Start a refund" endpoints to use your production account API token.
• Update the API token for any other Helcim API endpoints that you are using to match your production account.

If you do not yet have a production Helcim account, you can register for one through our website www.helcim.com.

🚧

Note for new merchants

Having a developer test account does not mean a business is automatically approved for a production account. Every business goes through a verification process when they sign up with a Payments Provider. We recommend reviewing our Acceptable Use Policy (AUP) to see if your business type has any restrictions before you start your integration.