Transactions through Helcim.js and the Payment API

Learn how to retrieve or manage transactions processed through Helcim.js in the Payment API.

As a legacy payment gateway solution, Helcim.js creates and returns legacy transaction id values that cannot be used through the Helcim V2 API. As an example, refunding a Helcim.js payment through Payment API, expects a different transactionId value than the one returned by Helcim.js.

Retrieving the updated V2 API transactionId value would be required if:

  • You want to refund or reverse transactions processed through Helcim.js.
  • You want to capture any Helcim.js pre-authorized transactions through the Payment API.
  • You want to retrieve any Helcim.js payments through the Card Transaction API.

To retrieve this value, we recommend calling the Collect Card Transaction endpoint with relevant query parameters to filter returned transactions down to the correct one. This could include a combination of values returned by Helcim.js, such as the date, cardHolderName, amount and cardToken for the transaction.

Based on this the V2 API will return a transaction object with a transactionId that can be used through all Payment API endpoints.

 {
    "transactionId": 25133280,
    "dateCreated": "2024-04-24 16:14:41",
    "cardBatchId": 3509924,
    "status": "APPROVED",
    "user": "Helcim System",
    "type": "purchase",
    "amount": 456,
    "currency": "CAD",
    "avsResponse": "X",
    "cvvResponse": "",
    "cardType": "MC",
    "approvalCode": "T3E3ST",
    "cardToken": "5c92996b7d573c1b15fc6e",
    "cardNumber": "5454545454",
    "cardHolderName": "Jessica Smith",
    "customerCode": "CST123457143",
    "invoiceNumber": "INV8792466",
    "warning": ""
  }