Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Transactions » EFT/ACH Transactions »

View a EFT/ACH Batch

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

Request Fields

Field Name Type Required Description
action String Yes batchEFTView
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
batchesEFT - XML structure
batchEFT - 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.
amountWithdrawals Decimal The total withdrawals amount in the batch.
amountDeposits Decimal The total amount of deposits 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
transactionsEFT - XML structure
transactionEFT - XML structure
id Integer The transaction ID.
dateCreated String The date the transaction was created.
statusAuth String Approved/Denied.
user String The customer's name.
transactionType String The transaction type (Purchase, Pre-auth, Capture, Refund).
amount Decimal The transaction amount.
approvalCode String The approval code.
test Integer 1 or 0. Whether or not the transaction is processed as test. 
responseMessage String Approved/Denied.


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.
0 - Batch Not Found The batch was not found.

Code Samples

Sample Batch EFT View XML

<?xml version="1.0"?>
        <settledResponseMessage>SETTLED - OK</settledResponseMessage>
        <dateOpened>2017-06-22 16:59:52</dateOpened>
        <dateClosed>2017-06-23 12:00:02</dateClosed>
            <nickname>ACH Demo</nickname>
                <dateCreated>2017-06-23 12:00:02</dateCreated>
                <user>Helcim System</user>
                <responseMessage>SETTLED - OK</responseMessage>
                <dateCreated>2017-06-22 16:59:52</dateCreated>
                <user>Jason Beyer</user>

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