This API call lets you process a preauthorization with a card token. The response is an XML of the processed preauthorization.
Request Fields
| Field Name |
Type |
Required |
Description |
| transactionType |
String |
Yes |
preauth |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| amount |
Decimal |
Yes |
The amount of the transaction. |
| cardToken |
String |
Yes |
The Helcim Commerce credit card token. |
| cardF4L4 |
Integer |
Yes |
The credit card number. |
| cardF4L4Skip |
Integer |
No |
1 or 0. If set to 1, then cardF4L4 field is not required. |
| orderNumber |
String |
No |
The order number. |
| comments |
String |
No |
Optional comments. |
| billing_contactName |
String |
No |
The billing contact name. |
| billing_businessName |
String |
No |
The billing 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 address. |
| 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. |
| amountShipping |
Decimal |
No |
The shipping cost. |
| amountTax |
Decimal |
No |
The total tax amount. |
| shippingMethod |
String |
No |
The shipping method. |
| taxDetails |
String |
No |
The tax name. |
| itemSKU# |
Integer |
No |
The sku. NOTICE: For all item variables replace "#" with a unique item number (starting at 1, and increasing by 1 for each unique item added). |
| 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 multiplied by the quantity. |
| ipAddress |
String |
No |
IP Address of the customer making the transaction. |
Response Fields (XML)
| Field Name |
Type |
Description |
| message |
- |
XML structure |
| response |
Integer |
1 or 0. Whether the transaction was approved or declined. |
| responseMessage |
String |
Result of transaction (Approved/Denied). |
| notice |
String |
Error/warning message from Helcim. |
| transaction |
- |
XML structure |
| transactionId |
Integer |
The transaction ID. |
| type |
String |
The transaction type (purchase, refund, pre-auth, capture). |
| date |
String |
The date of the transactions |
| time |
String |
The time of the transaction. |
| cardHolderName |
String |
The card holder's name. |
| amount |
Decimal |
The amount of the transactions. |
| currency |
String |
The currency of the transaction. |
| cardnumber |
String |
The credit card number (first 4 and last 4 digits only). |
| cardToken |
String |
The credit card token. |
| expiryDate |
Integer |
The credit card expiry date. |
| cardType |
String |
The credit card type (Visa, Mastercard, Amex, Discovery). |
| avsResponse |
String |
The address verification response. |
| cvvResponse |
String |
The CVV verification response. |
| approvalCode |
String |
The approval code. |
| orderNumber |
String |
The order number. |
| customerCode |
String |
The customer code. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Invalid Amount |
The transaction amount was not entered. |
| 0 |
- |
Invalid Card Token |
The credit card token was not entered or is invalid. |
| 0 |
- |
Card F4L4 Does Not Match Card Token |
The first four/last four digits of the credit card do not match the card token or are missing. |
