Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Transactions » Card Transactions »

List Transactions

This API call let's you retrieve a list of transactions. The response is an XML of the available transactions.

Request Fields

Field Name Type Required Description
action String Yes transactionSearch
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
search Straing No Searches either amount, cardNumber, cardHolderName, approvalCode.
dateFrom String No YYYY-MM-DD
dateTo String No YYYY-MM-DD

Response Fields (XML)

Field Name Type Description
transactions - XML structure
transaction - XML structure
id Integer The transaction ID.
dateCreated String The date the transaction was created.
status String Approved/Denied.
user String The customer's name.
type String The transaction type (Purchase, Pre-auth, Capture, Refund).
amount Decimal The transaction amount.
approvalCode String The approval code.
avsResponse String Address verification response.
cvvResponse String Card verification value response.
test Integer 1 or 0. Whether or not the transaction is processed as test. 
responseMessage String Approved/Denied.
cardType String The credit card brand.
cardNumber String The credit card number (first 4 and last 4 digits only).
cardExpiry Integer The credit card expiry date.
cardHolderName String The credit card holder's name.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - No results No results found.

Code Samples

Sample Transaction Search Response XML

<?xml version="1.0"?>
<transactions>
    <transaction>
        <id>112230</id>
        <dateCreated>2017-06-30 15:39:56</dateCreated>
        <status>APPROVED</status>
        <user>Manon Ratelle</user>
        <type>PURCHASE</type>
        <amount>6.30</amount>
        <approvalCode>T6E6ST</approvalCode>
        <avsResponse>X</avsResponse>
        <cvvResponse></cvvResponse>
        <test>0</test>
        <responseMessage>APPROVED</responseMessage>
        <cardType>Visa</cardType>
        <cardNumber>4520********2145</cardNumber>
        <cardExpiry>1019</cardExpiry>
        <cardHolderName>MANON RATELLE</cardHolderName>
    </transaction>
    <transaction>
        <id>67194</id>
        <dateCreated>2017-05-26 13:42:24</dateCreated>
        <status>APPROVED</status>
        <user>Anthony Thomasson</user>
        <type>PURCHASE</type>
        <amount>52.50</amount>
        <approvalCode>T8E9ST</approvalCode>
        <avsResponse>X</avsResponse>
        <cvvResponse>M</cvvResponse>
        <test>0</test>
        <responseMessage>APPROVED</responseMessage>
        <cardType>MasterCard</cardType>
        <cardNumber>5454********5454</cardNumber>
        <cardExpiry>0122</cardExpiry>
        <cardHolderName></cardHolderName>
    </transaction>
    <transaction>
        <id>67179</id>
        <dateCreated>2017-05-26 13:37:48</dateCreated>
        <status>APPROVED</status>
        <user>Anthony Thomasson</user>
        <type>PURCHASE</type>
        <amount>4.95</amount>
        <approvalCode>T9E3ST</approvalCode>
        <avsResponse>X</avsResponse>
        <cvvResponse>M</cvvResponse>
        <test>0</test>
        <responseMessage>APPROVED</responseMessage>
        <cardType>MasterCard</cardType>
        <cardNumber>5454********5454</cardNumber>
        <cardExpiry>0119</cardExpiry>
        <cardHolderName></cardHolderName>
    </transaction>
</transactions>

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="action" value="transactionSearch">
<input type="hidden" name="search" value="45.99">
<input type="hidden" name="dateFrom" value="2017-08-10">
<input type="hidden" name="dateTo" value="2017-11-10">