Please note that merchants cannot send full card numbers via API unless they have obtained an exception.
IMPORTANT: Request Fields for the credit card payments API's.
General Fields
| Field Name |
Type |
Required |
Description |
| transactionType |
String |
Yes |
The type of transaction. Purchase. |
| accountId |
String |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| amount |
Decimal |
No |
The transaction amount. Not required if Helcim Commerce is being used to verify a credit card or settle a batch. |
| terminalId |
Integer |
No |
The terminal ID. If it is not entered the merchant's default terminal will be used. |
| currency |
String |
No |
The currency of the terminal. |
Full Credit Card Number Fields
| Field Name |
Type |
Required |
Description |
| cardNumber |
Integer |
Yes |
The credit card number; must not include any spaces or special characters. |
| cardExpiry |
Integer |
Yes |
The credit card expiry, format: MMYY. |
| cardCVV |
Integer |
Yes * |
The credit card security code (CVV/CVC). Can be 3 or 4 digits. |
| cardHolderName |
String |
No |
The cardholder name. |
| cardHolderAddress |
String |
No |
The cardholder address (used for AVS). |
| cardHolderPostalCode |
String |
No |
The cardholder postal code (used for AVS). |
Credit Card Token Fields
| Field Name |
Type |
Required |
Description |
| cardToken |
String |
No |
The credit card token. (Required when processing a transaction with the credit card token) |
| cardF4L4 |
String |
No |
The first 4 and last 4 digits of the credit card number. (Required when processing a transaction with the credit card token) |
Magnetic Stripe Data Fields
| Field Name |
Type |
Required |
Description |
| cardMag |
String |
Yes |
Credit card magnetic strip data. |
| serialNumber |
String |
Yes |
The terminal serial number. |
| cardMagEnc |
String |
Yes |
Credit card magnetic strip encrypted data. |
Customer Code
| Field Name |
Type |
Required |
Description |
| customerCode |
String |
No |
The customer code. Required when processing a transaction with a card token. |
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 Fields
| Field Name |
Type |
Required |
Description |
| amountShipping |
Decimal |
No |
The shipping cost. |
| amountTax |
Decimal |
No |
The tax amount. |
| shippingMethod |
String |
No |
The method of shipping. |
| taxDetails |
String |
No |
The tax name. |
Order Item(s) Fields
Order Information
NOTICE: 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. |
