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.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.

Error Code	Message	Description
-	Invalid Amount	The transaction amount was not entered.
-	Declined - Invalid Card Number Invalid Expiry Date	The credit card number and/or expiry date was not entered or is invalid.
-	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.
-	Card Token Belongs to Another Customer ID	The card token does not match the customer code.

Code Samples

XML Sample Purchase Using Credit Card Token Response

HTML HTML Form Sample

Sample Purchase Using Credit Card Token Response XML

<?xml version="1.0"?>
<message>
    <response>1</response>
    <responseMessage>APPROVED</responseMessage>
    <notice></notice>
    <transaction>
        <transactionId>120973</transactionId>
        <type>purchase</type>
        <date>2017-07-06</date>
        <time>11:39:39</time>
        <cardHolderName>Aaron H.</cardHolderName>
        <amount>12.99</amount>
        <currency>CAD</currency>
        <cardNumber>5454********5454</cardNumber>
        <cardToken>53a7ac0b29dd48e2401fc7</cardToken>
        <expiryDate>0919</expiryDate>
        <cardType>MasterCard</cardType>
        <avsResponse>X</avsResponse>
        <cvvResponse></cvvResponse>
        <approvalCode>T1E1ST</approvalCode>
        <orderNumber>TestOrderNumber</orderNumber>
        <customerCode>12A1141</customerCode>
    </transaction>
</message>

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">