Common Use Cases

Helcim has a number of options for integrating payments into your website or application, depending on the complexity of your integration. These options include using HelcimPay.js to tokenize cards before processing through the Helcim API, or simply using HelcimPay to tokenize and process transactions in the same session.

🚧

For the majority of merchants integrating to Helcim payments, there will be a need to verify and tokenize card details.

This is done before processing purchase or preauthorization transactions through the Helcim API, as sending full card numbers is restricted for merchants who are not PCI-DSS SAQ-D compliant.

For those merchants who have been approved for processing with full card numbers, jump straight to the Process Capture Transaction with Full Card Numbers enabled use case.

HelcimPay.js end to end payment processing

HelcimPay is a simple way to integrate full end to end processing in your website or application, tokenizing card details and then processing purchase transactions in the same checkout session. This is a great option for solutions where transactions for products and services are confirmed and placed for immediate processing.

Quick Overview:

• You initialize HelcimPay with a paymentType of purchase
• HelcimPay responds with your checkoutToken and secretToken
• You call the function to render the HelcimPay modal with the returned checkoutToken
• The customer enters their card details directly into the HelcimPay modal and processes the payment
• HelcimPay verifies and tokenizes the card details, processes the transaction, and returns the outcome to you in the transaction response

For more information on integrating to HelcimPay, visit our Overview of HelcimPay.js documentation.

HelcimPay.js tokenization + Process Purchase Transaction

If your solution requires you to complete some additional tasks or verification before processing your purchase transactions, we would recommend using HelcimPay to tokenize and store card details, then calling the Process Purchase Transaction API endpoint with that card token to process your payment when ready.

Quick Overview:

• You initialize HelcimPay with a paymentType of verify
• HelcimPay responds with your checkoutToken and secretToken
• You call the function to render the HelcimPay modal with the returned checkoutToken
• The customer enters their card details directly into the HelcimPay modal and processes the verify transaction
• HelcimPay verifies and tokenizes the card details, and returns the cardToken to you in the transaction response
• You call the Process Purchase Transaction endpoint when ready to proceed

For more information on integrating to HelcimPay and our Payments API, visit our Overview of HelcimPay.js and Overview of Helcim API documentation.

HelcimPay.js preauthorization + Process Capture Transaction

If your solution requires flexibility when processing transaction amounts, we recommend using HelcimPay in conjunction with the Process Capture Transaction endpoints. This allows you to tokenize card details, as well as process a preauthorize transaction amount upfront through HelcimPay.js. Within the next 7 days you call the Process Capture Transaction endpoint with the relevant transactionId to capture all or part of the preauthorized amount. All preauthorized transactions will expire if not captured within 7 days.

Quick Overview:

• You initialize HelcimPay with a paymentType of preauth
• HelcimPay responds with your checkoutToken and secretToken
• You call the function to render the HelcimPay modal with the returned checkoutToken
• The customer enters their card details directly into the HelcimPay modal and processes the preauthorization
• HelcimPay verifies and tokenizes the card details, processes the preauthorization, and returns the cardToken and transactionId to you in the transaction response
• You call the Process Capture Transaction endpoint when ready to proceed

For more information on integrating to HelcimPay and our Payments API, visit our Overview of HelcimPay.js and Overview of Helcim API documentation.

Process Purchase Transaction with Full Card Numbers enabled

With full card numbers enabled, your solution can skip the tokenization process for Helcim API Payment endpoints and go straight to attempting to process a transaction. Successful transactions with full card numbers are still tokenized during this process and these tokens are still stored in your Helcim card vault for later use if needed.

Quick Overview:

• Your website or application calls the Process Purchase Transaction endpoint
• You transaction includes a cardData object, containing the cardNumber, cardExpiry, and cardCVV values
• The Helcim API verifies and tokenizes the card details, storing these in your card vault, and returns the outcome to you in the transaction response

For more information on integrating to the Helcim Payments API, visit our Overview of Helcim API documentation.