Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » Card Payments »

Purchase (Sale)

This API call let's you process a sale. 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. 
amount Decimal Yes The amount of the transaction.
cardHolderName String No The cardholder names.
cardNumber Integer Yes The credit card number.
cardExpiry Integer Yes The credit card expiration date
cardCVV Integer No The credit card CVV (digits on back of credit card).
cardHolderAddress String No The card holder's address.
cardHolderPostalCode String No The card holder's postal code.
ecommerce Integer No Set to 1 to indicate that the transaction is e-commerce. If enabled, the Helcim Fraud Defender will provide further analysis.
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.


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.

Code Samples

Sample Transaction Type Purchase Response XML

<?xml version="1.0"?>

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="amount" value="12.99">
<input type="hidden" name="cardHolderName" value="John Smith">
<input type="hidden" name="cardNumber" value="5454545454545454">
<input type="hidden" name="cardExpiry" value="1020">
<input type="hidden" name="cardCVV" value="100">
<input type="hidden" name="cardHolderAddress" value="123 Home Street, Calgary, Alberta, Canada">
<input type="hidden" name="cardHolderPostalCode" value="T2H1K7">