Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Transactions » Card Transactions »

View a Batch

This API call let's you retrieve the details of a specific batch. The response is an XML of the available batch information.

Request Fields

Field Name Type Required Description
action String Yes batchView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
batchNumber Integer Yes The batch number.
terminalId Integer Yes The terminal ID.

Response Fields (XML)

Field Name Type Description
batches - XML structure
batch - XML structure
batchNumber Integer The batch number.
countTotal Integer The total number of transactions in the batch.
countNet Integer The net number of transactions in the batch.
amountSales Decimal The total sales amount in the batch.
amountRefunds Decimal The total amount of refunds in the batch.
amountNet Decimal The net amount of revenue in the batch.
settled Integer 1 or 0. Whether the batch is settled or not.
settledResponse String OK or --. Whether or not the batch was settled without error or not.
settledResponseMessage String Confirmation of action taken.
hostSync String OK or --. Whether or not the batch was settled without error or not. 
dateOpened String Date the batch was opened.
dateClosed String Date the batch was closed.
terminal - XML structure
id Integer The terminal ID.
nickname String The terminal nickname.
currency String The currency of the batch.
batchSettleTime String The scheduled time for settling the batch.
terminal - XML Structure
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 - Invalid batch number or terminal ID The batch number and/or terminal ID is invalid, or not entered.

Code Samples

Sample Batch View Response XML

<?xml version="1.0"?>
<batches>
    <batch>
        <batchNumber>103</batchNumber>
        <countTotal>13</countTotal>
        <countNet>13</countNet>
        <amountSales>4380.05</amountSales>
        <amountRefunds>0.00</amountRefunds>
        <amountNet>4380.05</amountNet>
        <settled>1</settled>
        <settledResponse>OK</settledResponse>
        <settledResponseMessage>SETTLED - OK</settledResponseMessage>
        <hostSync>IN-SYNC</hostSync>
        <dateOpened>2017-06-30 12:20:33</dateOpened>
        <dateClosed>2017-07-01 04:00:01</dateClosed>
        <terminal>
            <id>13</id>
            <nickname>Demo Terminal - CAD</nickname>
            <currency>CAD</currency>
            <batchSettleTime>4:00am</batchSettleTime>
        </terminal>
        <transactions>
            <transaction>
                <id>114237</id>
                <dateCreated>2017-07-01 04:00:01</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>SETTLE</type>
                <amount>0.00</amount>
                <approvalCode></approvalCode>
                <avsResponse></avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>SETTLED - OK</responseMessage>
                <cardType></cardType>
                <cardNumber></cardNumber>
                <cardExpiry>0000</cardExpiry>
                <cardHolderName></cardHolderName>
            </transaction>
            <transaction>
                <id>112808</id>
                <dateCreated>2017-07-01 03:00:04</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>PURCHASE</type>
                <amount>68.25</amount>
                <approvalCode>T4E1ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>Visa</cardType>
                <cardNumber>4242********4242</cardNumber>
                <cardExpiry>0629</cardExpiry>
                <cardHolderName>Mark Calloway</cardHolderName>
            </transaction>
            <transaction>
                <id>112804</id>
                <dateCreated>2017-07-01 03:00:03</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>PURCHASE</type>
                <amount>68.25</amount>
                <approvalCode>T4E4ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>1127</cardExpiry>
                <cardHolderName>Steve Austin</cardHolderName>
            </transaction>
            <transaction>
                <id>112800</id>
                <dateCreated>2017-07-01 03:00:02</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>PURCHASE</type>
                <amount>12.00</amount>
                <approvalCode>T6E1ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>0120</cardExpiry>
                <cardHolderName>name</cardHolderName>
            </transaction>
            <transaction>
                <id>112796</id>
                <dateCreated>2017-07-01 03:00:02</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>PURCHASE</type>
                <amount>12.00</amount>
                <approvalCode>T7E3ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>Visa</cardType>
                <cardNumber>4520********3118</cardNumber>
                <cardExpiry>0318</cardExpiry>
                <cardHolderName>SVETLANA LEVINA</cardHolderName>
            </transaction>
            <transaction>
                <id>112792</id>
                <dateCreated>2017-07-01 03:00:01</dateCreated>
                <status>APPROVED</status>
                <user>Helcim System</user>
                <type>PURCHASE</type>
                <amount>1260.00</amount>
                <approvalCode>T9E5ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>0120</cardExpiry>
                <cardHolderName>name</cardHolderName>
            </transaction>
            <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>112204</id>
                <dateCreated>2017-06-30 15:25:01</dateCreated>
                <status>APPROVED</status>
                <user>Aaron Hamilton</user>
                <type>PREAUTH</type>
                <amount>1.00</amount>
                <approvalCode>T9E9ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>0919</cardExpiry>
                <cardHolderName>Aaron H</cardHolderName>
            </transaction>
            <transaction>
                <id>112200</id>
                <dateCreated>2017-06-30 15:22:06</dateCreated>
                <status>APPROVED</status>
                <user>Aaron Hamilton</user>
                <type>PURCHASE</type>
                <amount>1.00</amount>
                <approvalCode>T1E8ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>0827</cardExpiry>
                <cardHolderName>Aaron Hamilton</cardHolderName>
            </transaction>
            <transaction>
                <id>112152</id>
                <dateCreated>2017-06-30 15:01:18</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>CAPTURE</type>
                <amount>2100.00</amount>
                <approvalCode>T7E8ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>112150</id>
                <dateCreated>2017-06-30 15:01:10</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PREAUTH</type>
                <amount>2100.00</amount>
                <approvalCode>T2E1ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>112094</id>
                <dateCreated>2017-06-30 14:21:27</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PURCHASE</type>
                <amount>500.00</amount>
                <approvalCode>T1E8ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>112085</id>
                <dateCreated>2017-06-30 14:19:37</dateCreated>
                <status>APPROVED</status>
                <user>Radu Georgescu</user>
                <type>PURCHASE</type>
                <amount>10.00</amount>
                <approvalCode>T5E5ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse>M</cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5454********5454</cardNumber>
                <cardExpiry>0118</cardExpiry>
                <cardHolderName></cardHolderName>
            </transaction>
            <transaction>
                <id>112080</id>
                <dateCreated>2017-06-30 14:18:49</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PURCHASE</type>
                <amount>47.25</amount>
                <approvalCode>T5E4ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>112070</id>
                <dateCreated>2017-06-30 14:16:51</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>CAPTURE</type>
                <amount>5.00</amount>
                <approvalCode>T7E7ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>112068</id>
                <dateCreated>2017-06-30 14:16:46</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PREAUTH</type>
                <amount>5.00</amount>
                <approvalCode>T7E2ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>111981</id>
                <dateCreated>2017-06-30 13:39:02</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>CAPTURE</type>
                <amount>290.00</amount>
                <approvalCode>T1E4ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>111893</id>
                <dateCreated>2017-06-30 12:47:15</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PREAUTH</type>
                <amount>243.60</amount>
                <approvalCode>T9E3ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
            <transaction>
                <id>111845</id>
                <dateCreated>2017-06-30 12:20:31</dateCreated>
                <status>APPROVED</status>
                <user>Rodolfo Ferro Casagrande</user>
                <type>PREAUTH</type>
                <amount>129.15</amount>
                <approvalCode>T7E2ST</approvalCode>
                <avsResponse>X</avsResponse>
                <cvvResponse></cvvResponse>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
                <cardType>MasterCard</cardType>
                <cardNumber>5524********9032</cardNumber>
                <cardExpiry>0518</cardExpiry>
                <cardHolderName>NICOLAS BEIQUE</cardHolderName>
            </transaction>
        </transactions>
    </batch>
</batches>

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="batchView">
<input type="hidden" name="terminalId" value="13">
<input type="hidden" name="batchNumber" value="103">