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