Helcim Logo Support & Tutorials

© Copyright 2006-2019 Helcim Inc.

All Rights Reserved.

Legacy Platforms » Helcim Virtual Terminal » Helcim Gateway API » Request Variables »

Optional Variables

This also requires the minimum required variables to be sent.

Name Type Description
test 1/numeric Sets whether this is a test or not. Any value other than 1 will assume this is a real transaction.
cardholderName 100/alpha Name on card.
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)
Shipping Information
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.
Order Information
NOTICE: For all item variables replace "#" with a unique item number (1 or higher).
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.
itemId# 50/alpha Item SKU.
itemDescription# 255/alpha Item description.
itemQuantity# 4,2/decimal Item quantity, must be at least one for item to be added.
itemPrice# 10,2/decimal Item price per each.
itemTotal# 10,2/decimal Item price X quantity.
shippingAmount 10,2/decimal Total shipping amount.
taxAmount 10,2/decimal Total tax amount.
allowZeroAmount 1/numberic Allows a zero-dollar transaction to be processed so that a card-token can be generated.
transactionIndicator 1/numberic *Only use when sending a recurring card-token payment using your internal recurring system. Value should be set to 2.