Programmatic revenue share

For seamless attribution of revenue share for partner transactions flowing through your API integration, you will be required to tag all transactions with a unique partner-token in the header of your requests.

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.

The partner token is provided during the onboarding process, post contract finalization. If you have not yet registered as a Helcim partner and completed your onboarding, you can use the test values below while you work on that.

Adding your unique partner-token

Adding your partner token to your request header is critical for ensuring you receive programmatic rev share for payments processed through your integration.

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.

partner-token: "f29104118c0d65"

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

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.