Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » EFT/ACH Payments »

EFT/ACH Settle

This API call let's you settle a EFT/ACH batch. The response is an XML of the settled batch.

Request Fields

Field Name Type Required Description
transactionEFTType String Yes settle
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
terminalId Integer Yes The terminal ID.

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
transactionEFTId Integer The transaction ID.
transactionType String The transaction type (purchase, settle, refund, pre-auth, capture).
date String The date of the transactions
time String The time of the transaction.
amount Decimal The amount of the transactions.
currency String The transaction currency.
approvalCode String The approval code.
bankAccountType String The bank account type (CHK, SAV).
bankAccountCorporate String The type of account (CHK-chequing, SAV-savings).
bankAccountToken String The bank account token.
bankAccountFinancialNumber String The bank account financial number.
bankTransitNumber String The bank account transit number.
bankAccountNumber String The bank account transit number.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Transaction ID The transaction ID was invalid or not entered.

Code Samples

Sample TransactionEFTType Settle Response HTML

<?xml version="1.0"?>
<message>
    <response>1</response>
    <responseMessage>SETTLED - OK</responseMessage>
    <notice></notice>
    <transaction>
        <transactionEFTId>209</transactionEFTId>
        <transactionType>SETTLE</transactionType>
        <date>2017-07-07</date>
        <time>12:45:05</time>
        <amount></amount>
        <currency>CAD</currency>
        <approvalCode></approvalCode>
        <bankAccountType></bankAccountType>
        <bankAccountCorporate></bankAccountCorporate>
        <bankAccountToken></bankAccountToken>
        <bankFinancialNumber></bankFinancialNumber>
        <bankTransitNumber></bankTransitNumber>
        <bankAccountNumber></bankAccountNumber>
    </transaction>
</message>

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="transactionEFTType" value="settle">
<input type="hidden" name="terminalId" value="1004">