Optional Fields
This documentation is for the legacy Helcim.js 1.0. New merchants should refer to the Helcim.js version 2 documentation.
| Field Name | Type / Format | Description |
|---|---|---|
| amount | numeric | Amount, decimal place |
| dev | 1/numeric | Sets whether transactions are sent to the live (gateway.helcim.com) or dev environment (gatewaytest.helcim.com) |
| test | 1/numeric | Sets whether this is a test or not. Any value other than 1 will assume this is a real transaction. |
| preauth | 1/numeric | Sets whether the transaction should be pre-authorization (default is purchase). |
| submitDecline | 1/numeric | Sets whether the form should be submitted on a decline (default is =1). |
| cardholderName | 100/alpha | Name on card. |
| cardholderAddress | 255/alpha | Address of cardholder for address verification. |
| cardholderPostalCode | 50/alpha | Postal code/zip code of cardholder for address verification. |
| billingName | 100/alpha | Customer's billing name. |
| billingAddress | 255/alpha | Customer's billing address. |
| billingCity | 255/alpha | Customer's billing city. |
| billingProvince | 255/alpha | Customer's billing province or state. |
| billingPostalCode | 50/alpha | Customer's billing postal code or zip code. |
| billingCountry | 255/alpha | Customer's billing country. |
| billingPhoneNumber | 255/alpha | Customer's billing phone number. |
| billingEmailAddress | 255/alpha | Customer's billing email address (used for emailing a receipt to customer if feature is enabled) |
| shippingName | 100/alpha | Customer's shipping name. |
| shippingAddress | 255/alpha | Customer's shipping address. |
| shippingCity | 255/alpha | Customer's shipping city. |
| shippingProvince | 255/alpha | Customer's shipping province or state. |
| shippingPostalCode | 50/alpha | Customer's shipping postal code or zip code. |
| shippingCountry | 255/alpha | Customer's shipping country. |
| shippingPhoneNumber | 255/alpha | Customer's shipping phone number. |
| shippingEmailAddress | 255/alpha | Customer's shipping email address. |
| orderId | 50/alpha | Unique transaction identifier, transaction will fail if a duplicate order id is found. The order id will be automatically generated by the Gateway if this field is blank. |
| customerId | 50/alpha | Customer identifier. |
| comments | alpha | Any extra information from the cardholder or merchant. |
| shippingAmount | 10,2/decimal | Total shipping amount. |
| taxAmount | 10,2/decimal | Total tax amount. |