Request Fields

Helcim.js will intercept your form data based on the respective HTML input elements field ID value, then send that information as a payload to the Helcim API to process either a Verify, Pre-Auth, or Purchase transaction depending on the selection in your Helcim.js configuration.

Below is a list of all fields that can be set as part of a Helcim.js implementation to be included in that request.



HTML input fields used to collect sensitive credit card information should not have an HTML field name, only an HTML field id.

This will allow the JavaScript to retrieve the values (using getElementById), but prevents the fields from being submitted back to the merchant server. Helcim.js will also attempt to mask sensitive data before submitting form.

General fields

Field NameTypeRequiredDescription
tokenStringYesThe Helcim.js configuration token.
languageStringNoThe language to display error messages in [en, fr, sp]. English is default.
testIntegerNoSet to "1" for test-mode. The Helcim.js configuration must also be set to test-mode.
amountDecimalNoThe transaction amount. Not required if Helcim.js is being used to tokenize credit card or bank account.
amountHashStringNoThe hashed amount. Required if Helcim.js configuration requires hashing protection.
currencyStringNoThree letter abbreviation of transaction's currency. CAD,USD.
amountShippingDecimalNoThe order's shipping amount.
amountTaxDecimalNoThe order's tax amount.
amountDiscountDecimalNoThe order's discount amount.
customerCodeStringNoThe customer code. Sending this will link the order and tokenized card to this customer.
orderNumberStringNoThe order number. Sending this will link transaction to this order.
commentsStringNoThe order comments.
g-recaptcha-responseStringNoThe response received from Google for ReCaptcha. This is required if ReCaptcha is enabled in the .JS config.
dontSubmitStringNoSet to "1" when using Helcim.js and you do not want to submit the form.
<input type="hidden" id="token" value="58ae1d44d7ac6959332969">
<input type="hidden" id="language" value="en">
<input type="hidden" id="test" value="1">
<input type="hidden" id="amount" value="100.00">
<input type="hidden" id="amountHash" value="sjkn29s8ngm382gbaj9172akaj29188ahjsj19182usnaksklk1212891279217whsahjash812712">
<input type="hidden" id="amountShipping" value="10.00">
<input type="hidden" id="amountTax" value="5.00">
<input type="hidden" id="amountDiscount" value="7.95">
<input type="hidden" id="customerCode" value="CST1000">
<input type="hidden" id="orderNumber" value="INV2020">
<input type="hidden" id="comments" value="Hello World">

Card fields

Field NameTypeRequiredDescription
cardTokenStringNoThe credit card token. Used if updating an existing credit card.
cardNumberIntegerYesThe credit card number; must not include any spaces or special characters.
cardExpiryIntegerYesThe credit card expiry, format: MMYY - Merchant can send either this field, or the individual cardExpiryMonth and cardExpiryYear fields.
cardExpiryMonthIntegerYesThe credit card expiry month, format: MM
cardExpiryYearIntegerYesThe credit card expiry year, format: YY or YYYY
cardCVVIntegerYes *The credit card security code (CVV/CVC). Can be 3 or 4 digits.
cardHolderNameStringYes *The cardholder name.
cardHolderAddressStringYesThe cardholder address (used for AVS).
cardHolderPostalCodeStringYesThe cardholder postal code (used for AVS).
<input type="hidden" id="cardToken" value="6dc57d55b60fce3f9c6a5d">
<input type="hidden" id="cardNumber" value="5454545454545454">
<input type="hidden" id="cardExpiry" value="1025">
<input type="hidden" id="cardExpiryMonth" value="10">
<input type="hidden" id="cardExpiryYear" value="25">
<input type="hidden" id="cardCVV" value="100">
<input type="hidden" id="cardHolderName" value="Jane Smith">
<input type="hidden" id="cardHolderAddress" value="123 Street South">
<input type="hidden" id="cardHolderPostalCode" value="90210">

Billing and shipping fields

These fields can be used to set the customer's billing and shipping information, as well as the order's billing and shipping information.

Field NameTypeRequiredDescription
billing_contactNameStringNoThe the billing address contact name.
billing_businessNameStringNoThe billing address business name.
billing_street1StringNoThe billing street address.
billing_street2StringNoThe billing street address.
billing_cityNoThe billing city.
billing_provinceStringNoThe billing province.
billing_countryStringNoThe billing country.
billing_postalCodeStringNoThe billing postal code.
billing_phoneStringNoThe billing phone number.
billing_faxStringNoThe billing fax number
billing_emailStringNoThe billing email.
shipping_contactNameStringNoThe shipping contact name.
shipping_businessNameStringNoThe shipping business name.
shipping_street1StringNoThe shipping street address.
shipping_street2StringNoThe shipping street address.
shipping_cityStringNoThe shipping city.
shipping_provinceStringNoThe shipping province.
shipping_countryStringNoThe shipping country.
shipping_postalCodeStringNoThe shipping postal code.
shipping_phoneStringNoThe shipping phone number.
shipping_faxStringNoThe shipping fax number.
shipping_emailStringNoThe shipping email address.
<input type="hidden" id="billing_contactName" value="Jane Smith">
<input type="hidden" id="billing_businessName" value="ABC Business">
<input type="hidden" id="billing_street1" value="303 Avenue North">
<input type="hidden" id="billing_street2" value="Unit 1403">
<input type="hidden" id="billing_city" value="Calgary">
<input type="hidden" id="billing_province" value="Alberta">
<input type="hidden" id="billing_country" value="Canada">
<input type="hidden" id="billing_postalCode" value="T2H 1K7">
<input type="hidden" id="billing_phone" value="403-555-1234">
<input type="hidden" id="billing_fax" value="403-555-2233">
<input type="hidden" id="billing_email" value="[email protected]">
<input type="hidden" id="shipping_contactName" value="John Smith">
<input type="hidden" id="shipping_businessName" value="ABC Business USA">
<input type="hidden" id="shipping_street1" value="400 Street West">
<input type="hidden" id="shipping_street2" value="Unit 12">
<input type="hidden" id="shipping_city" value="Seattle">
<input type="hidden" id="shipping_province" value="WA">
<input type="hidden" id="shipping_country" value="USA">
<input type="hidden" id="shipping_postalCode" value="90221">
<input type="hidden" id="shipping_phone" value="814-555-1233">
<input type="hidden" id="shipping_fax" value="814-555-6633">
<input type="hidden" id="shipping_email" value="[email protected]">

Order items fields

Note that for all item variables replace "#" with a unique item number (starting at 1, and increasing by 1 for each unique item added).

Field NameTypeRequiredDescription
itemSKU#IntegerYesThe sku. Note that itemSKU# is required for each lineItem
itemDescription#StringNoThe item description.
itemSerialNumber#StringNoThe item serial number.
itemQuantity#DecimalNoItem quantity, must be at least one for item to be added.
itemPrice#DecimalNoThe item price.
itemTotal#DecimalNoThe item price x the quantity.
<input type="hidden" id="itemSKU1" value="SKU123">
<input type="hidden" id="itemDescription1" value="The First Item">
<input type="hidden" id="itemSerialNumber1" value="SN109102991">
<input type="hidden" id="itemQuantity1" value="2.00">
<input type="hidden" id="itemPrice1" value="5.00">
<input type="hidden" id="itemTotal1" value="10.00">

<input type="hidden" id="itemSKU2" value="SKU456">
<input type="hidden" id="itemDescription2" value="The Second Item">
<input type="hidden" id="itemSerialNumber2" value="SN1091209310293">
<input type="hidden" id="itemQuantity2" value="1.00">
<input type="hidden" id="itemPrice2" value="17.00">
<input type="hidden" id="itemTotal2" value="17.00">