at.hobex.pos.ecr.tecs

Class TecsClient

java.lang.Object

at.hobex.pos.ecr.ECRBase

at.hobex.pos.ecr.tecs.TecsClient

Direct Known Subclasses:

SmartPOSClient

public class TecsClient
extends ECRBase

This class provides business methods for transactions via the Tecs system.

The methods in this class act as an API for any POS software such that simple method calls trigger the desired business function and return the response from the Tecs system. For this reason the transaction information is stored in an TecsECR object and then sent to the Tecs server.

The answer string from the Tecs system is then passed to the TecsResponse class which parses the response string and creates a Response object. In the TecsClient environment it is possible to generate own receipts by calling Response.GenerateReceipt().

For examples and further information see at.hobex.pos.ecr.tecs

Constructor Summary

Constructors

Constructor and Description
TecsClient() Default constructor using default values from configuration
TecsClient(java.lang.String Tid, java.lang.String Password) Constructor for setting tid and password manually.
TecsClient(java.lang.String TID, java.lang.String Password, java.lang.String Host, int Port, int Timeout, boolean SSL) Constructor for setting with communication parameters.
TecsClient(java.lang.String TID, java.lang.String Password, java.lang.String Host, int Port, int Timeout, boolean SSL, java.lang.String Language) Constructor for setting all configurable parameters manually except currency and merchant header.
TecsClient(java.lang.String TID, java.lang.String Password, java.lang.String Host, int Port, int Timeout, boolean SSL, java.lang.String Language, java.lang.String Currency) Constructor for setting all configurable parameters manually except merchant header
TecsClient(java.lang.String TID, java.lang.String Password, java.lang.String Host, int Port, int Timeout, boolean SSL, java.lang.String Language, java.lang.String Currency, java.lang.String[] MerchantHeader) Constructor for setting all configurable parameters manually.

Method Summary

Modifier and Type	Method and Description
Response	abort(java.lang.String txId) Aborts an already started purchase transaction Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!
Response	batchTotals(int client) Command to force the terminal to send an overview about the stored turnover sum.
Response	cancel(java.lang.String currency, double amount, java.lang.String txId, java.lang.String originalTxId, int client) This method cancels a transaction.
Response	capture(java.lang.String currency, double amount, java.lang.String txId, java.lang.String originalTxId, int client) Used for capturing a preauthorization request with the default currency.
Response	closeBatch(int client) Triggers an end of day / close message.
Response	connectionStatus() Query the connection status of the terminal if terminal supports.
Response	diagnosis() Forces the terminal to send a diagnostic message to the host.
java.lang.String	getMessage()
Response	getTransactionDetails(java.lang.String originalTxId) Returns all transaction data from a previous transaction.
Response	openSystemMenu() Opens the System configuration menu if the terminal supports this feature Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!
Response	preauth(java.lang.String txId, java.lang.String currency, double amount, java.lang.String reference, int client) This method performs a preauthorization.
Response	preauth(java.lang.String txId, java.lang.String currency, double amount, java.lang.String reference, int client, java.lang.String cardToken)
Response	preauthCancel(java.lang.String currency, double amount, java.lang.String txId, java.lang.String originalTxId, int client) This method cancels a pre authorization.
Response	purchase(java.lang.String txId, java.lang.String currency, double amount, double tip, java.lang.String reference, int client, boolean forceMotoTransaction) This method performs a purchase request with currency, amount, reference and client ID to set.
Response	purchase(java.lang.String txId, java.lang.String currency, double amount, double tip, java.lang.String reference, int client, boolean forceMotoTransaction, java.lang.String cardToken)
Response	reconciliation() Triggers an reconciliation message.
Response	refund(java.lang.String txId, java.lang.String originalTxId, java.lang.String currency, double amount, java.lang.String reference, int client) This method performs a refund on a POS device.
Response	refund(java.lang.String txId, java.lang.String originalTxId, java.lang.String currency, double amount, java.lang.String reference, int client, java.lang.String cardToken)
Response	restartPaymentApplication() Restart the payment application of the terminal if terminal supports.
Response	status() Get the status of the device

Methods inherited from class at.hobex.pos.ecr.ECRBase

abort, batchTotals, cancel, cancel, cancel, cancel, capture, capture, capture, capture, closeBatch, closeCommunication, getCurrency, getLastTransactionId, getTecsClient, getZVTClient, logoff, logon, moto, moto, moto, moto, moto, moto, moto, newTransactionId, openCommunication, pointsCollect, pointsCollect, preauth, preauth, preauth, preauth, preauthCancel, preauthCancel, preauthCancel, preauthCancel, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, refund, refund, refund, refund, refund, repeatReceipt, setLanguage, setSSLSocketFactory, startCTLSCardRead, startCTLSCardRead, stopCTLSCardRead, voucherBalance, voucherBalance, voucherLoad, voucherPay, voucherPay

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TecsClient

public TecsClient()

Default constructor using default values from configuration

TecsClient

public TecsClient(java.lang.String Tid,
                  java.lang.String Password)

Constructor for setting tid and password manually. Connection parameters will be loaded from configuration.

Parameters:

Tid - String representation of terminal identification number for the POS device.

Password - String representation of password for selected POS device.

TecsClient

public TecsClient(java.lang.String TID,
                  java.lang.String Password,
                  java.lang.String Host,
                  int Port,
                  int Timeout,
                  boolean SSL)

Constructor for setting with communication parameters.

Parameters:

TID - String representation of terminal identification number for the POS device.

Password - String representation of password for selected POS device.

Host - String representation of the host's IP address.

Port - Port number of the host's socket as String.

Timeout - Communication timeout in milliseconds.

SSL - Boolean value for secure socket layer communication. "true" enables SSL communication, "false" disables it.

TecsClient

public TecsClient(java.lang.String TID,
                  java.lang.String Password,
                  java.lang.String Host,
                  int Port,
                  int Timeout,
                  boolean SSL,
                  java.lang.String Language)

Constructor for setting all configurable parameters manually except currency and merchant header.

Parameters:

TID - String representation of terminal identification number for the POS device.

Password - String representation of password for selected POS device.

Host - String representation of the host's IP address.

Port - Port number of the host's socket as String.

Timeout - Communication timeout in milliseconds

SSL - Boolean value for secure socket layer communication. "true" enables SSL communication, "false" disables it.

Language - String set the Terminal and Receipt language (DE, EN, ..)

TecsClient

public TecsClient(java.lang.String TID,
                  java.lang.String Password,
                  java.lang.String Host,
                  int Port,
                  int Timeout,
                  boolean SSL,
                  java.lang.String Language,
                  java.lang.String Currency)

Constructor for setting all configurable parameters manually except merchant header

Parameters:

TID - String representation of terminal identification number for the POS device.

Password - String representation of password for selected POS device.

Host - String representation of the host's IP address.

Port - Port number of the host's socket as String.

Timeout - Communication timeout in milliseconds

SSL - Boolean value for secure socket layer communication. "true" enables SSL communication, "false" disables it.

Language - String set the Terminal and Receipt language (DE, EN, ..)

Currency - Set the terminal currency (if it is supported by the terminal)

TecsClient

public TecsClient(java.lang.String TID,
                  java.lang.String Password,
                  java.lang.String Host,
                  int Port,
                  int Timeout,
                  boolean SSL,
                  java.lang.String Language,
                  java.lang.String Currency,
                  java.lang.String[] MerchantHeader)

Constructor for setting all configurable parameters manually. Especially used if you store your configuration in a separate container.

Parameters:

TID - String representation of terminal identification number for the POS device.

Password - String representation of password for selected POS device.

Host - String representation of the host's IP address.

Port - Port number of the host's socket as String.

Timeout - Communication timeout in milliseconds

SSL - Boolean value for secure socket layer communication. "true" enables SSL communication, "false" disables it.

Language - String set the Terminal and Receipt language (DE, EN, ..)

Currency - Set the terminal currency (if it is supported by the terminal)

MerchantHeader - Header for the payment receipt. Every field contains a line for the receipt header ([0] = "hobex Ag", [1] = "Tel: +43662-2255-0", ...)

Method Detail

abort

public Response abort(java.lang.String txId)
               throws ECRException,
                      ECRCommunicationException

Aborts an already started purchase transaction Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!

Overrides:

abort in class ECRBase

Parameters:

txId - Original transaction ID

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.6

batchTotals

public Response batchTotals(int client)
                     throws ECRException,
                            ECRCommunicationException

Command to force the terminal to send an overview about the stored turnover sum. Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at)!

Overrides:

batchTotals in class ECRBase

Parameters:

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

cancel

public Response cancel(java.lang.String currency,
                       double amount,
                       java.lang.String txId,
                       java.lang.String originalTxId,
                       int client)
                throws ECRException,
                       ECRCommunicationException

This method cancels a transaction.

Specified by:

cancel in class ECRBase

Parameters:

currency - Currency for transaction, ISO-4217 currency code (alphabetic) e.g. EUR

amount - Amount of transaction

txId - unique Transaction Identifier see ECRBase.newTransactionId()

originalTxId - original transaction id of the transaction to be canceled

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

capture

public Response capture(java.lang.String currency,
                        double amount,
                        java.lang.String txId,
                        java.lang.String originalTxId,
                        int client)
                 throws ECRException,
                        ECRCommunicationException

Used for capturing a preauthorization request with the default currency.

Overrides:

capture in class ECRBase

Parameters:

currency - ISO-4217 Currency codes (alphabetic) e.g. EUR.

amount - Amount to capture, must be lower than amount of the original transaction.

txId - unique Transaction Identifier see ECRBase.newTransactionId()

originalTxId - original transaction id of the transaction to be capture

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response.

Throws:

ECRException

ECRCommunicationException

See Also:

Response

closeBatch

public Response closeBatch(int client)
                    throws ECRException,
                           ECRCommunicationException

Triggers an end of day / close message. Force the payment terminal to send the turnover to the host. Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at)!

Overrides:

closeBatch in class ECRBase

Parameters:

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.6

connectionStatus

public Response connectionStatus()
                          throws ECRException,
                                 ECRCommunicationException

Query the connection status of the terminal if terminal supports. Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at)!

Overrides:

connectionStatus in class ECRBase

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.3

diagnosis

public Response diagnosis()
                   throws ECRException,
                          ECRCommunicationException

Forces the terminal to send a diagnostic message to the host. Updates the terminal parameter and returns different additional information: Response.getHost(), Response.getNetworkMedia(), Response.getSwVersion(), Response.getPackageVersion(), Response.getTerminalIpAddress(), Response.getTerminalSubnetMask(), Response.getTerminalGateway(), Response.getMacAddress(), Response.getSerialNo() Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!

Overrides:

diagnosis in class ECRBase

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.3

getMessage

public java.lang.String getMessage()

getTransactionDetails

public Response getTransactionDetails(java.lang.String originalTxId)
                               throws ECRException,
                                      ECRCommunicationException

Returns all transaction data from a previous transaction. The transaction ID of the desired transaction must be sent.

Overrides:

getTransactionDetails in class ECRBase

Parameters:

originalTxId - TransactionID of the referenced former transaction

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

See Also:

Response

openSystemMenu

public Response openSystemMenu()
                        throws ECRException,
                               ECRCommunicationException

Opens the System configuration menu if the terminal supports this feature Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!

Overrides:

openSystemMenu in class ECRBase

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

See Also:

Response

preauth

public Response preauth(java.lang.String txId,
                        java.lang.String currency,
                        double amount,
                        java.lang.String reference,
                        int client)
                 throws ECRCommunicationException,
                        ECRException

This method performs a preauthorization. This kind of transaction usually needs a cancel or capture afterwards.

Overrides:

preauth in class ECRBase

Parameters:

txId - Transaction Identifier

currency - ISO-4217 currency code (alphabetic) e.g. EUR

amount - amount of preauthorization

reference - reference number, usually a matching number for your environment. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%!\"$%\/=?:,;{[]}~<>|

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

See Also:

Response, ECRBase.capture(String, double, String), ECRBase.cancel(String, double, String)

preauth

public Response preauth(java.lang.String txId,
                        java.lang.String currency,
                        double amount,
                        java.lang.String reference,
                        int client,
                        java.lang.String cardToken)
                 throws ECRCommunicationException,
                        ECRException

Throws:

ECRCommunicationException

ECRException

preauthCancel

public Response preauthCancel(java.lang.String currency,
                              double amount,
                              java.lang.String txId,
                              java.lang.String originalTxId,
                              int client)
                       throws ECRException,
                              ECRCommunicationException

This method cancels a pre authorization.

Overrides:

preauthCancel in class ECRBase

Parameters:

currency - Currency for transaction, ISO-4217 currency code (alphabetic) e.g. EUR

amount - Amount of transaction

txId - unique Transaction Identifier see ECRBase.newTransactionId()

originalTxId - original transaction id of the transaction to be canceled

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

purchase

public Response purchase(java.lang.String txId,
                         java.lang.String currency,
                         double amount,
                         double tip,
                         java.lang.String reference,
                         int client,
                         boolean forceMotoTransaction)
                  throws ECRException,
                         ECRCommunicationException

This method performs a purchase request with currency, amount, reference and client ID to set.

Specified by:

purchase in class ECRBase

Parameters:

txId - unique Transaction Identifier see ECRBase.newTransactionId()

currency - Currency for transaction, ISO-4217 currency code (alphabetic) e.g. EUR

amount - Amount to purchase/transaction amount (exclusive TIP)

tip - Amount of TIP

reference - Reference number, usually a matching number for your environment. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%!\"$%\/=?:,;{[]}~<>|

client - Client-Id used for multi-merchant-terminals, usually/default 1.

forceMotoTransaction - triggers a MOTO transaction if the terminal and terminal configuration supports

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

purchase

public Response purchase(java.lang.String txId,
                         java.lang.String currency,
                         double amount,
                         double tip,
                         java.lang.String reference,
                         int client,
                         boolean forceMotoTransaction,
                         java.lang.String cardToken)
                  throws ECRException,
                         ECRCommunicationException

Throws:

ECRException

ECRCommunicationException

reconciliation

public Response reconciliation()
                        throws ECRException,
                               ECRCommunicationException

Triggers an reconciliation message. Force the payment terminal to send the reconciliation data. Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at)!

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.3

refund

public Response refund(java.lang.String txId,
                       java.lang.String originalTxId,
                       java.lang.String currency,
                       double amount,
                       java.lang.String reference,
                       int client)
                throws ECRException,
                       ECRCommunicationException

This method performs a refund on a POS device.

Overrides:

refund in class ECRBase

Parameters:

txId - unique Transaction Identifier see ECRBase.newTransactionId()

originalTxId - TransactionID of the referenced former transaction

currency - Currency for transaction, ISO-4217 currency code (alphabetic) e.g. EUR

amount - Amount of transaction

reference - Reference # for transaction. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%!\"$%\/=?:,;{[]}~<>|

client - Client-Id used for multi-merchant-terminals, usually/default 1.

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

See Also:

Response

refund

public Response refund(java.lang.String txId,
                       java.lang.String originalTxId,
                       java.lang.String currency,
                       double amount,
                       java.lang.String reference,
                       int client,
                       java.lang.String cardToken)
                throws ECRException,
                       ECRCommunicationException

Throws:

ECRException

ECRCommunicationException

restartPaymentApplication

public Response restartPaymentApplication()
                                   throws ECRException,
                                          ECRCommunicationException

Restart the payment application of the terminal if terminal supports. Please note that this works not for terminals in pinpad mode (communicate via tca.hobex.at or RestAPI)!

Overrides:

restartPaymentApplication in class ECRBase

Returns:

an instance of Response class.

Throws:

java.lang.UnsupportedOperationException - if the terminal type/implementation not supports this kind of command

ECRException

ECRCommunicationException

Since:

1.3

status

public Response status()
                throws ECRException,
                       ECRCommunicationException

Get the status of the device

Overrides:

status in class ECRBase

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

See Also:

Response