View an EFT or ACH Batch
The information in this article is for merchants using Helcim's Legacy System and does not apply to merchants who signed up for Helcim on or after June 1, 2020.
This API call lets 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.
| 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. |
| 0 | - | Invalid API Token1 | The API Token is invalid, or not entered. |
| 0 | - | Missing or Invalid Fields - Account ID | The Account ID is invalid, or not entered. |