Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » Card Payments »

Purchase Using Card Token

This API call let's you process a sale with a credit card token. The response is an XML of the processed sale.

Request Fields

Field Name Type Required Description
transactionType String Yes purchase
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
customerCode String Yes The customer code.
orderNumber String No The order number.
cardToken String Yes The credit card token.
cardF4L4 Integer Yes The credit card first 4 and last 4 digits.
cardF4L4Skip Integer Yes Set to "1" if you wish to skip the first-4 last-4 digit verification process. Not recommended.
amount Decimal Yes The transaction amount.
comments String No Optional comments.

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.


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 - Declined - Invalid Card Number Invalid Expiry Date The credit card number and/or expiry date was not entered or is invalid.
0 - Card F4L4 Does Not Match Card Token The first 4 and last 4 digits of the credit card do not match the data of the credit card token.
0 - Card Token Belongs to Another Customer ID The card token does not match the customer code.

Code Samples

Sample Purchase Using Credit Card Token Response XML

<?xml version="1.0"?>
        <cardHolderName>Aaron H.</cardHolderName>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="transactionType" value="purchase">
<input type="hidden" name="customerCode" value="12A1141">
<input type="hidden" name="orderNumber" value="1555ABC">
<input type="hidden" name="cardToken" value="53a7ac0b29dd48e2401fc7">
<input type="hidden" name="cardF4L4" value="54545454">
<input type="hidden" name="amount" value="100.00">
<input type="hidden" name="comments" value="Premium product">