View an 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.

Errors

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

Error Code	Message	Description
-	Invalid batch number or terminal ID	The batch number and/or terminal ID is invalid, or not entered.
-	Batch Not Found	The batch was not found.
-	Invalid API Token1	The API Token is invalid, or not entered.
-	Missing or Invalid Fields - Account ID	The Account ID is invalid, or not entered.

View an EFT/ACH Transaction

List EFT/ACH Transactions

Send an EFT/ACH Transaction Receipt

Create an EFT/ACH Transaction PDF

Was this article helpful?

Click here if you return to the content

Code Samples

[XML] Sample Response - View an EFT/ACH Batch

<?xml version="1.0"?>
<batchesEFT>
    <batchEFT>
        <batchNumber>6</batchNumber>
        <countTotal>1</countTotal>
        <countNet>-1</countNet>
        <amountWithdrawals>0.00</amountWithdrawals>
        <amountDeposits>500.00</amountDeposits>
        <amountNet>-500.00</amountNet>
        <settled>1</settled>
        <settledResponse>OK</settledResponse>
        <settledResponseMessage>SETTLED - OK</settledResponseMessage>
        <hostSync>IN-SYNC</hostSync>
        <dateOpened>2017-06-22 16:59:52</dateOpened>
        <dateClosed>2017-06-23 12:00:02</dateClosed>
        <terminal>
            <id>1004</id>
            <nickname>ACH Demo</nickname>
            <currency>CAD</currency>
            <batchSettleTime>12:00pm</batchSettleTime>
        </terminal>
        <transactionsEFT>
            <transactionEFT>
                <id>108</id>
                <dateCreated>2017-06-23 12:00:02</dateCreated>
                <statusAuth>APPROVED</statusAuth>
                <user>Helcim System</user>
                <transactionType>SETTLE</transactionType>
                <amount>0.00</amount>
                <approvalCode></approvalCode>
                <test>0</test>
                <responseMessage>SETTLED - OK</responseMessage>
            </transactionEFT>
            <transactionEFT>
                <id>105</id>
                <dateCreated>2017-06-22 16:59:52</dateCreated>
                <statusAuth>APPROVED</statusAuth>
                <user>Jason Beyer</user>
                <transactionType>DEPOSIT</transactionType>
                <amount>500.00</amount>
                <approvalCode>483EFT</approvalCode>
                <test>0</test>
                <responseMessage>APPROVED</responseMessage>
            </transactionEFT>
        </transactionsEFT>
    </batchEFT>
</batchesEFT>

[HTML] HTML Form Sample

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

View an EFT/ACH Batch

Request Fields

Response Fields (XML)

Errors

Related Articles

Was this article helpful?