Request fields

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

❗️

IMPORTANT

Fields with 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 (getElementById), but prevent 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 Name

Type

Required

Description

token

String

Yes

The Helcim.js configuration token.

language

String

No

The language to display error messages in [en, fr, sp]. English is default.

test

Integer

No

Set to "1" for test-mode. The Helcim.js configuration must also be set to test-mode.

amount

Decimal

No

The transaction amount. Not required if Helcim.js is being used to tokenize credit card or bank account.

amountHash

String

No

The hashed amount. Required if Helcim.js configuration requires hashing protection.

currency

String

No

Three letter abbreviation of transaction's currency. CAD,USD.

amountShipping

Decimal

No

The order's shipping amount.

amountTax

Decimal

No

The order's tax amount.

amountDiscount

Decimal

No

The order's discount amount.

customerCode

String

No

The customer code. Sending this will link the order and tokenized card to this customer.

orderNumber

String

No

The order number. Sending this will link transaction to this order.

comments

String

No

The order comments.

g-recaptcha-response

String

No

The response received from Google for ReCaptcha. This is required if ReCaptcha is enabled in the .JS config.

dontSubmit

String

No

Set 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

cardToken

String

No

The credit card token. Used if updating an existing credit card.

cardNumber

Integer

Yes

The credit card number; must not include any spaces or special characters.

cardExpiry

Integer

Yes

The credit card expiry, format: MMYY - Merchant can send either this field, or the individual cardExpiryMonth and cardExpiryYear fields.

cardExpiryMonth

Integer

Yes

The credit card expiry month, format: MM

cardExpiryYear

Integer

Yes

The credit card expiry year, format: YY or YYYY

cardCVV

Integer

Yes *

The credit card security code (CVV/CVC). Can be 3 or 4 digits.

cardHolderName

String

Yes *

The cardholder name.

cardHolderAddress

String

Yes

The cardholder address (used for AVS).

cardHolderPostalCode

String

Yes

The 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 Name

Type

Requied

Description

billing_contactName

String

No

The the billing address contact name.

billing_businessName

String

No

The billing address business name.

billing_street1

String

No

The billing street address.

billing_street2

String

No

The billing street address.

billing_city

No

The billing city.

billing_province

String

No

The billing province.

billing_country

String

No

The billing country.

billing_postalCode

String

No

The billing postal code.

billing_phone

String

No

The billing phone number.

billing_fax

String

No

The billing fax number

billing_email

String

No

The billing email.

shipping_contactName

String

No

The shipping contact name.

shipping_businessName

String

No

The shipping business name.

shipping_street1

String

No

The shipping street address.

shipping_street2

String

No

The shipping street address.

shipping_city

String

No

The shipping city.

shipping_province

String

No

The shipping province.

shipping_country

String

No

The shipping country.

shipping_postalCode

String

No

The shipping postal code.

shipping_phone

String

No

The shipping phone number.

shipping_fax

String

No

The shipping fax number.

shipping_email

String

No

The 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 Name

Type

Required

Description

itemSKU#

Integer

Yes

The sku. Note that itemSKU# is required for each lineItem

itemDescription#

String

No

The item description.

itemSerialNumber#

String

No

The item serial number.

itemQuantity#

Decimal

No

Item quantity, must be at least one for item to be added.

itemPrice#

Decimal

No

The item price.

itemTotal#

Decimal

No

The 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">

Did this page help you?