Helcim Commerce API » Transactions »

List Terminals

This API call let's you create a list of available terminals. The response is an XML of the terminal search action.

Request Fields

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

Response Fields (XML)

Field Name	Type	Description
terminals	-	XML structure
terminal	-	XML structure
id	Integer	The terminal ID.
nickname	String	The terminal nickname.
currency	String	The currency of the terminal.
status	Integer	1 or 0. Whether or not the terminal is active.
batchSettleAuto	Integer	1 or 0. Whether the batches are set to auto settle.
settlementTime	Integer	The time the batch auto settles (24 hour clock).
acquirerNetwork	String	The acquirer network used by the terminal.

Errors

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

Response Code	Error Code	Message	Description
0	-	No results	No terminals available.

Code Samples

XML Sample Terminal Search Response

HTML HTML Form Sample

Sample Terminal Search Response XML

<?xml version="1.0"?>
<terminals>
    <terminal>
        <id>13</id>
        <nickname>Demo Terminal - CAD</nickname>
        <currency>CAD</currency>
        <status>1</status>
        <batchSettleAuto>1</batchSettleAuto>
        <settlementTime>4</settlementTime>
        <acquirerNetwork>Helcim (demo)</acquirerNetwork>
    </terminal>
    <terminal>
        <id>17</id>
        <nickname>Demo Terminal - USD</nickname>
        <currency>USD</currency>
        <status>1</status>
        <batchSettleAuto>1</batchSettleAuto>
        <settlementTime>10</settlementTime>
        <acquirerNetwork>Helcim (demo)</acquirerNetwork>
    </terminal>
    <terminal>
        <id>1004</id>
        <nickname>ACH Demo</nickname>
        <currency>CAD</currency>
        <status>1</status>
        <batchSettleAuto>1</batchSettleAuto>
        <settlementTime>12</settlementTime>
        <acquirerNetwork>Helcim (demo)</acquirerNetwork>
    </terminal>
</terminals>

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