Testing the Smart Terminal API

Step 1: Setting up a developer test account

To test your integration with the Smart Terminal API, you'll want to start by getting set up with a developer test account.

• Please connect with [email protected] and we would be happy to guide you through the process of getting a test environment up and running.
• Please let us know that you would like to integrate with the Smart Terminal API.
• If you have an existing Helcim account, please also provide your Helcim merchant ID number.

Step 2: Ordering your equipment

Helcim can provide a loan Smart Terminal device for testing your integration to the Smart Terminal API, or else you are welcome to purchase your Smart Terminal up front.

• After 3 months the device will need to be returned to Helcim.
• We will charge for the full price of the device if not returned, or if you decide to keep the device for ongoing use.

To request a loan Smart Terminal device, then please reach out to our Tier 2 Support team at [email protected] for more information.

Step 3: Receiving your equipment

Once you have received your loan Smart Terminal device, complete the device set-up and configuration as outlined in our Smart Terminal support documentation here.

• Configuring your test device before enabling API Mode will allow you to set device specific settings such as automatic receipt printing.

Step 4: Integrate and test

Once logged in and configured to your liking, you can begin your integration testing with the Smart Terminal API and your Helcim developer test account.

• Review the remaining Smart Terminal API developer documentation, starting with Turning Smart Terminal API Mode ON and OFF.

Step 5: Switching to production

After completing your integration and testing, switching to production is easy

• Change the api-token in your request headers for the Start A Purchase and Start A Refund endpoint to use the api-token for your production Helcim account.
• Change the api-token in your request headers for any other Helcim API endpoints to use the api-token for your production Helcim account.

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

🚧

New Helcim merchants

Please note that being provided with a developer test account is not confirmation that a new merchant to Helcim would be approved for processing. All businesses will go through a verification process when registering for any production Helcim account.

We recommend reading our Acceptable Use Policy for more information on restricted industries and business types in advance of integrating to the Helcim API.