Upgrading to Helcim V2 API
We’re transitioning to the new and improved Helcim API V2. The following guide outlines why you would want to upgrade and what's involved.
Why would you want to move to the new API? Our new API endpoints allow for faster transaction processing and response times, are fully RESTful and return responses as a JSON object to make it easier for you to integrate. They also provide improved connection stability, API logs for every request, and API tokens with simplified permissions.
If you don’t have an existing sandbox test account with Helcim and would like to test changes to your integration in a sandbox environment, then please connect with [email protected] and we would be happy to guide you through the process of getting your test environment up and running.
Ready to make the change?
WooCommerce merchants
If you're using the Helcim Payments plugin with WooCommerce, then the changes to upgrade to the V2 token are relatively straight forward.
Visit our Learn article on connecting Helcim with WooCommerce for instruction on generating your new token and updating your settings in WooCommerce.
API merchants
Step 1: Create your new V2 API tokens.
Create your V2 API tokens and set their permissions in the Integrations section of your Helcim account. For more information on creating a new API token, visit our support article here.
Any existing integrations can continue to process through your legacy token until you’re comfortable enough to make the switch. Your legacy API configurations can be accessed by clicking the Legacy API button in the top right corner of your Integrations section in your Helcim account.
Step 2: Update your integration endpoints.
For some endpoints, the format of your requests may have changed. You can use our API reference documents to see what request information to send for each endpoint in the language that you use.
Step 3: We are transitioning towards HelcimPay.js
Moving forward this would be our recommended endpoint for verifying and tokenizing card details, as we move away from the older Helcim.js endpoint.
With access to Helcim Fee Saver and improved performance, you can tokenize card details from your customers and then use those in transaction purchase or pre-authorization endpoints to process payments for your customers.
To learn more about using HelcimPay.js please visit our HelcimPay guide here.
Important things to note.
Some functions available in the legacy API are not yet available in the Version 2 API. This includes the ability to manage subscriptions and subscribers, products, or send email receipts.
With the release of our updated subscription manager, we will create updated endpoints for the Version 2 API.
If you have other functionality that would be helpful for your business or integration, then we would love to hear from you so that we can assess and add important solutions onto our roadmap.
Updated 5 months ago