Guides
helcim.com

Integration Partner Program

Suggest Edits

The Integration Partner Program enables Helcim partners to receive revenue share on each transaction processed by a referred merchant through an integration with Helcim that is provided and maintained by a Partner.

To become a partner and start earning revenue for merchants you refer to Helcim, you can sign up through the Integration Partners page on our website.

This program applies exclusively to technical integrations built to Helcim’s V2 API or HelcimPay.js.

  • This includes Payment API, Smart Terminal API, Recurring API, and HelcimPay.js integrations.

For seamless attribution of Partner transactions flowing through the API integration, Partners will be required to tag all transactions with a unique partner-token provided during the onboarding process, post contract finalization.

The unique partner-token is crucial to ensure correct attribution of all transactions that are processed through the Partner Technical Integration and will be linked to the monthly profit share calculations at the close of every month.

With the launch of the Integration Partner Program, Helcim will not have the functionality to reconcile retroactively any missed transactions on account of incorrect tagging.

Getting started with your integration

To learn more about integrating with the Helcim V2 API, or HelcimPay.js, you can visit the following pages in our developer documentation.

Step 1: Creating a test account

To get started we’ll want to set you up with a developer test account, so that you can test your integration to the Helcim API.

You can connect with the Helcim Tier 2 Support team or the Partnership Team when you’re ready to get started and we will get you set up with a test account and assist you with integrating to Helcim.

Step 2: Adding your unique partner-token

Adding your partner token to your request is critical for ensuring programmatic rev share for payments processed through your integration are attributed to your business correctly.

Include your partner token in the request header for all payment requests you send to the Payment API, or in your HelcimPay.js Initialize requests.

  • partner-token: Provided by your Partnership Specialist to be included in the header of all API requests.

📘

Test partner-token value

If you would like to begin testing your integration and use of a partner-token before you have finalized your Partner onboarding with our team, then you can utilize the following test partner-token in your request headers.

Step 3: Validate your partner-token was received

Validating that the Helcim system received your request and attributed it to your partner token is as simple as reviewing the header of the API response that you received.

  • Review the header of the response you receive from Helcim.
  • They will contain an is-valid-partner-token parameter that will have a value or 1 or 0.
    • If is-valid-partner-token is 1, you have successfully added the partner token to your request.
    • If is-valid-partner-token is 0, there is an error with your the partner token in your request.

Connected account registrations and webhooks

In addition to obtain revenue share for payments processed with the partner-token in the header of the request, Helcim partners can also utilize our connected account registrations and webhooks to streamline the referral and registration process for referred merchant.

Updated 8 days ago