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. 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. |
| 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. |
Credit Card Fields
| Field Name |
Type |
Required |
Description |
| cardToken |
String |
Yes |
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). |
Bank Account (EFT/ACH) Fields
| Field Name |
Type |
Required |
Description |
| bankAccountToken |
String |
Yes |
The bank account token. Used if updating an existing bank account. |
| bankAccountType |
String |
Yes |
The bank account type. Must be "CHK" for checking/chequing or "SAV" for saving account. |
| bankAccountCorporate |
String |
Yes |
Must be "P" for personal, or "C" for corporate. |
| bankTransitNumber |
Integer |
Yes |
The bank account transit number. Must be 9-digits (USA) or 5-digits (Canada) |
| bankAccountNumber |
Integer |
Yes |
The bank account number - Must be at least 6-digits |
| bankFirstName |
String |
Yes |
The bank account holder's first name. |
| bankLastName |
String |
Yes |
The bank account holder's last name. |
| bankCompanyName |
String |
No |
The bank account holder's company name. |
| bankStreetAddress |
String |
Yes |
The bank account holder's street address. |
| bankCity |
String |
Yes |
The bank account holder's city. |
| bankProvince |
String |
Yes |
The bank account holder's state or province. |
| bankCountry |
String |
Yes |
The bank account holder's country. |
| bankPostalCode |
String |
Yes |
The bank account holder's zip or postal code. |
Billing and Shipping Information
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 |
Required |
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 |
String |
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. |
Order Item(s) Fields
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 |
No |
The sku. |
| 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. |
