at.hobex.pos.ecr.zvt

Class ZVTClient

java.lang.Object

at.hobex.pos.ecr.ECRBase

at.hobex.pos.ecr.zvt.ZVTClient

public class ZVTClient
extends ECRBase

This class provides business methods for transactions over the ZVT Protocol (hobex derivative). For Further information see ZVT Specification

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 credit card terminal.

The answer from the payment terminal is then passed to the ZVTResponse class which parses the response and creates a ZVTResponse object. In the ZVT environment it is not possible to generate own receipts by calling Response.GenerateReceipt(). It will return the receipt delivered by the payment terminal (for further information see logon()).

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

Since:

1.3

Author:

Nicolai Rechberger

Constructor Summary

Constructors

Constructor and Description
ZVTClient() Constructor for an ZVTClient-Object object.
ZVTClient(java.lang.String comPort) Constructor to create an ZVTClient-Object which communicates via serial communication with default values - baud rate (=9600), stop bit (=2), Timeouts (t3=5000ms, t4=180000ms) and Config-Byte BE
ZVTClient(java.lang.String host, int port) Constructor to create an ZVTClient-Object which communicates via TCP/IP with default values - timeouts (t3=5000ms, t4=180000ms), Config-Byte BE and force registration false
ZVTClient(java.lang.String comPort, int baudRate, int stopBits) Constructor to create an ZVTClient-Object which communicates via serial communication with default values - timeouts (t3=5000ms, t4=180000ms), Config-Byte BE and force registration false
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4) Constructor to create an ZVTClient-Object which communicates via TCP/IP with default Config-Byte BE and force registration false
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, byte configByte) Constructor to create an ZVTClient-Object which communicates via TCP/IP with default value force registration false
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, byte configByte, boolean forceRegistration) Constructor to create an ZVTClient-Object which communicates via TCP/IP
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, byte configByte, boolean forceRegistration, int delayBetweenCommands) Constructor to create an ZVTClient-Object which communicates via TCP/IP
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4) Constructor to create an ZVTClient-Object which communicates via serial communication with default Config-Byte BE and force registration false
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, byte configByte) Constructor to create an ZVTClient-Object which communicates via serial communication with default Config-Byte BE and force registration false
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, byte configByte, boolean forceRegistration) Constructor to create an ZVTClient-Object which communicates via serial communication
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, byte configByte, boolean forceRegistration, int delayBetweenCommands) Constructor to create an ZVTClient-Object which communicates via serial communication
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, java.lang.String configByte) Constructor to create an ZVTClient-Object which communicates via serial communication with default value force registration false
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, java.lang.String configByte, boolean forceRegistration) Constructor to create an ZVTClient-Object which communicates via serial communication
ZVTClient(java.lang.String comPort, int baudRate, int stopBits, int timeout3, int timeout4, java.lang.String configByte, boolean forceRegistration, int delayBetweenCommands) Constructor to create an ZVTClient-Object which communicates via serial communication
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, java.lang.String configByte) Constructor to create an ZVTClient-Object which communicates via TCP/IP with default value force registration false
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, java.lang.String configByte, boolean forceRegistration) Constructor to create an ZVTClient-Object which communicates via TCP/IP
ZVTClient(java.lang.String host, int port, int timeout3, int timeout4, java.lang.String configByte, boolean forceRegistration, int delayBetweenCommands) Constructor to create an ZVTClient-Object which communicates via TCP/IP

Method Summary

Modifier and Type	Method and Description
Response	abort() Aborts an already started command on the payment terminal.
void	addListener(IntermediateStatusInformationListener listener) If in the logon() requests the intermediate status information it is necessary to add a listener to receive the status information.
ZVTResponse	batchTotals(int client) Command to force the terminal to send an overview about the stored turnover sum (ZVTResponse.getAmount() holds the turnover sum).
Response	cancel(double amount, java.lang.String receiptNo) Starts a cancel/refund of the last transaction if it is available.
Response	cancel(double amount, java.lang.String receiptNo, int client) Starts a cancel/refund of the last transaction if it is available.
Response	cancel(java.lang.String currency, double amount, java.lang.String receiptNo) Starts a cancel/refund of the last transaction if it is available.
Response	cancel(java.lang.String currency, double amount, java.lang.String receiptNo, int client) Starts a cancel/refund of the last transaction if it is available.
ZVTResponse	cancel(java.lang.String currency, double amount, java.lang.String txId, java.lang.String receiptNo, int client) Starts a cancel/refund of the last transaction if it is available.
ZVTResponse	capture(java.lang.String currency, double amount, java.lang.String originalTxId, int client) This command executes capture/booking of the total amount for a Pre-Authorization/Reservation.
ZVTResponse	capture(java.lang.String currency, double amount, java.lang.String txId, java.lang.String originalTxId, int client) This command executes capture/booking of the total amount for a Pre-Authorization/Reservation.
Response	CheckAgeVerification(double amount) Explanation
ZVTResponse	closeBatch(int client) The payment terminal transfer the stored turnover to the host and clears the turnover on the payment terminal (ZVTResponse.getAmount() holds the turnover sum).
void	closeCommunication() Deprecated.
ZVTResponse	diagnosis() Forces the terminal to send a diagnostic message to the host.
Response	logoff() Resets the terminal configuration from the logon() command to default.
Response	logon() Init the communication to the payment terminal.
void	openCommunication() Deprecated.
Response	pointsCollect(java.lang.String txID, java.lang.String currency, double bonusPointsEquivalentAmount, java.lang.String reference, int client) Method to transform the given amount into the equivalent bonus points.
ZVTResponse	preauth(java.lang.String txId, java.lang.String currency, double amount, java.lang.String reference, int client) Starts a Pre-Authorization/Reservation.
ZVTResponse	preauthCancel(java.lang.String currency, double amount, java.lang.String originalTxId, int client) This command cancels a capture of the Pre-Authorization/Reservation
ZVTResponse	preauthCancel(java.lang.String currency, double amount, java.lang.String txId, java.lang.String originalTxId, int client) This command cancels a capture of the Pre-Authorization/Reservation
ZVTResponse	purchase(double amount, AgeTags currentAgeCheck) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(double amount, java.math.BigDecimal cashback) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(double amount, int currentAgeCheck) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(double amount, int currentAgeCheck, java.lang.String reference) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(double amount, java.lang.String reference, AgeTags currentAgeCheck) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(double amount, java.lang.String reference, double cashback) Triggers a purchase/authorization transaction with cashback
ZVTResponse	purchase(java.lang.String txId, java.lang.String currency, double amount, double tip, java.lang.String reference, int client, boolean forceMotoTransaction) Triggers a purchase/authorization transaction.
ZVTResponse	refund(java.lang.String txId, java.lang.String originalTxId, java.lang.String currency, double amount, java.lang.String reference, int client) Starts a refund transaction.
void	removeListener(IntermediateStatusInformationListener listener) If you don't want to get further intermediate status information it is possible to remove already attached listener from the notification queue.
ZVTResponse	repeatReceipt() To get the last receipt from the payment terminal if it is available.
ZVTResponse	status() Starts an status enquire to request the terminal status.
Response	voucherBalance(java.lang.String txID, java.lang.String reference, int client) Method to get the remaining balance of the loyalty card.For remaining balance see Response.getBonusPointsEquivalentAmount()
Response	voucherLoad(java.lang.String txID, java.lang.String currency, double amount, java.lang.String reference, int client) Credit amount to the loyalty card.
Response	voucherPay(java.lang.String txID, java.lang.String currency, double amount, java.lang.String reference, int client) Start a transaction with amount to debit from the loyalty card.

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

abort, batchTotals, capture, capture, capture, closeBatch, connectionStatus, getCurrency, getLastTransactionId, getTecsClient, getTransactionDetails, getZVTClient, moto, moto, moto, moto, moto, moto, moto, newTransactionId, openSystemMenu, pointsCollect, preauth, preauth, preauth, preauth, preauthCancel, preauthCancel, preauthCancel, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, purchase, refund, refund, refund, refund, refund, restartPaymentApplication, setLanguage, setSSLSocketFactory, startCTLSCardRead, startCTLSCardRead, stopCTLSCardRead, voucherBalance, voucherLoad, voucherPay

Methods inherited from class java.lang.Object

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

Constructor Detail

ZVTClient

public ZVTClient()

Constructor for an ZVTClient-Object object. All required parameters are read from the hobex.properties file which is mandatory in this case.
Required parameters in hobex.properties for using the ZVT protocol:

com.host=COMX or 127.0.0.1
com.port=20007 (if TCP/IP else it can be empty)
com.timeout=180000 (timeout 4 in ms, timeout between ACK from terminal and completion of the command))
configByte=BE (set the terminal configuration, registration command is necessary)
forceRegistration=true (forces a registration command while instantiate the ZVTClient)
timeout3=5000 (timeout between command from ECR and ACK from terminal in ms)
baudRate=9600 serial connection baud rate
stopBits=2 serial connection - stop bits
delayBetweenCommands=0 (Forces a delay between two commands (delay in milliseconds!)


See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort)

Constructor to create an ZVTClient-Object which communicates via serial communication with default values - baud rate (=9600), stop bit (=2), Timeouts (t3=5000ms, t4=180000ms) and Config-Byte BE

Parameters:

comPort - Serial port (COM1...COMX)

ZVTClient

public ZVTClient(java.lang.String host,
                 int port)

Constructor to create an ZVTClient-Object which communicates via TCP/IP with default values - timeouts (t3=5000ms, t4=180000ms), Config-Byte BE and force registration false

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits)

Constructor to create an ZVTClient-Object which communicates via serial communication with default values - timeouts (t3=5000ms, t4=180000ms), Config-Byte BE and force registration false

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets the baud rate

stopBits - Sets the stop bits

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4)

Constructor to create an ZVTClient-Object which communicates via TCP/IP with default Config-Byte BE and force registration false

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 byte configByte)

Constructor to create an ZVTClient-Object which communicates via TCP/IP with default value force registration false

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 byte configByte,
                 boolean forceRegistration)

Constructor to create an ZVTClient-Object which communicates via TCP/IP

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 byte configByte,
                 boolean forceRegistration,
                 int delayBetweenCommands)

Constructor to create an ZVTClient-Object which communicates via TCP/IP

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

delayBetweenCommands - Forces a delay between two commands (delay in milliseconds!)

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4)

Constructor to create an ZVTClient-Object which communicates via serial communication with default Config-Byte BE and force registration false

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 byte configByte)

Constructor to create an ZVTClient-Object which communicates via serial communication with default Config-Byte BE and force registration false

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 byte configByte,
                 boolean forceRegistration)

Constructor to create an ZVTClient-Object which communicates via serial communication

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 byte configByte,
                 boolean forceRegistration,
                 int delayBetweenCommands)

Constructor to create an ZVTClient-Object which communicates via serial communication

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

delayBetweenCommands - Forces a delay between two commands (delay in milliseconds!)

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte)

Constructor to create an ZVTClient-Object which communicates via serial communication with default value force registration false

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte,
                 boolean forceRegistration)

Constructor to create an ZVTClient-Object which communicates via serial communication

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String comPort,
                 int baudRate,
                 int stopBits,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte,
                 boolean forceRegistration,
                 int delayBetweenCommands)

Constructor to create an ZVTClient-Object which communicates via serial communication

Parameters:

comPort - Sets serial port (COM1...COMX)

baudRate - Sets baud rate

stopBits - Sets stop bits

timeout3 - Sets timeout 3 in ms

timeout4 - Sets timeout 4 in ms

configByte - Sets Config-Byte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

delayBetweenCommands - Forces a delay between two commands (delay in milliseconds!)

See Also:

ConfigByte

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte)

Constructor to create an ZVTClient-Object which communicates via TCP/IP with default value force registration false

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte see ConfigByte

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte,
                 boolean forceRegistration)

Constructor to create an ZVTClient-Object which communicates via TCP/IP

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte see ConfigByte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

ZVTClient

public ZVTClient(java.lang.String host,
                 int port,
                 int timeout3,
                 int timeout4,
                 java.lang.String configByte,
                 boolean forceRegistration,
                 int delayBetweenCommands)

Constructor to create an ZVTClient-Object which communicates via TCP/IP

Parameters:

host - Terminal-IP

port - Terminal Port (default ZVT-Port: 20007)

timeout3 - Sets timeout 3 in milliseconds (default 5000ms)

timeout4 - Sets timeout 4 in milliseconds (default 180000ms)

configByte - Sets Config-Byte see ConfigByte

forceRegistration - If true the api perform an ECRBase.logon() before a command to ensure that the expected behavior is carried out

delayBetweenCommands - Forces a delay between two commands (delay in milliseconds!)

Method Detail

abort

public Response abort()
               throws ECRException

Aborts an already started command on the payment terminal. NOT IMPLEMENTED YET!

Overrides:

abort in class ECRBase

Returns:

an instance of Response class.

Throws:

ECRException

addListener

public void addListener(IntermediateStatusInformationListener listener)

If in the logon() requests the intermediate status information it is necessary to add a listener to receive the status information.

Parameters:

listener - The intermediate status information listener to add in the notification queue.

batchTotals

public ZVTResponse batchTotals(int client)
                        throws ECRException

Command to force the terminal to send an overview about the stored turnover sum (ZVTResponse.getAmount() holds the turnover sum).

Overrides:

batchTotals in class ECRBase

Parameters:

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

cancel

public Response cancel(double amount,
                       java.lang.String receiptNo)
                throws ECRException,
                       ECRCommunicationException

Starts a cancel/refund of the last transaction if it is available. In the ZVT implementation the parameters are not necessary because it is not possible to cancel older transactions. To be sure that the expected transaction which will be canceled it you can send the receipt no of the last transaction. If the receipt no doesn't match the receipt no of the last transaction you will receive an error.

Overrides:

cancel in class ECRBase

Parameters:

amount - Not supported in ZVT Implementation

receiptNo - Receipt# of the last transaction Response.getReceiptNo()

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

cancel

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

Starts a cancel/refund of the last transaction if it is available. In the ZVT implementation the parameters are not necessary because it is not possible to cancel older transactions. To be sure that the expected transaction which will be canceled it you can send the receipt no of the last transaction. If the receipt no doesn't match the receipt no of the last transaction you will receive an error.

Overrides:

cancel in class ECRBase

Parameters:

amount - Not supported in ZVT Implementation

receiptNo - Receipt# of the last transaction Response.getReceiptNo()

client - Not supported in ZVT Implementation

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

cancel

public Response cancel(java.lang.String currency,
                       double amount,
                       java.lang.String receiptNo)
                throws ECRException,
                       ECRCommunicationException

Starts a cancel/refund of the last transaction if it is available. In the ZVT implementation the parameters are not necessary because it is not possible to cancel older transactions. To be sure that the expected transaction which will be canceled it you can send the receipt no of the last transaction. If the receipt no doesn't match the receipt no of the last transaction you will receive an error.

Overrides:

cancel in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Not supported in ZVT Implementation

receiptNo - Receipt# of the last transaction Response.getReceiptNo()

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

cancel

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

Starts a cancel/refund of the last transaction if it is available. In the ZVT implementation the parameters are not necessary because it is not possible to cancel older transactions. To be sure that the expected transaction which will be canceled it you can send the receipt no of the last transaction. If the receipt no doesn't match the receipt no of the last transaction you will receive an error.

Overrides:

cancel in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Not supported in ZVT Implementation

receiptNo - Receipt# of the last transaction Response.getReceiptNo()

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

Returns:

an instance of Response class.

Throws:

ECRException

ECRCommunicationException

cancel

public ZVTResponse cancel(java.lang.String currency,
                          double amount,
                          java.lang.String txId,
                          java.lang.String receiptNo,
                          int client)
                   throws ECRException

Starts a cancel/refund of the last transaction if it is available. In the ZVT implementation the parameters are not necessary because it is not possible to cancel older transactions. To be sure that the expected transaction which will be canceled it you can send the receipt no of the last transaction. If the receipt no doesn't match the receipt no of the last transaction you will receive an error.

Specified by:

cancel in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Not supported in ZVT Implementation

txId - Not supported in ZVT Implementation

receiptNo - Receipt# of the last transaction Response.getReceiptNo()

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

capture

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

This command executes capture/booking of the total amount for a Pre-Authorization/Reservation. In the ZVT implementation only amount and

Overrides:

capture in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Amount to capture

originalTxId - from former preauth to capture the amount from this preauth (if not send, merchant must enter number manually on terminal)

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

capture

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

This command executes capture/booking of the total amount for a Pre-Authorization/Reservation. In the ZVT implementation only amount and

Overrides:

capture in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Amount to capture

txId - Not supported in ZVT Implementation

originalTxId - from former preauth to capture the amount from this preauth (if not send, merchant must enter number manually on terminal)

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

CheckAgeVerification

public Response CheckAgeVerification(double amount)

Explanation

See Also:

ConfigByte

closeBatch

public ZVTResponse closeBatch(int client)
                       throws ECRException

The payment terminal transfer the stored turnover to the host and clears the turnover on the payment terminal (ZVTResponse.getAmount() holds the turnover sum).

Overrides:

closeBatch in class ECRBase

Parameters:

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

closeCommunication

@Deprecated
public void closeCommunication()

Deprecated.

CloseCommunication is deprecated, use logoff() instead!

Overrides:

closeCommunication in class ECRBase

diagnosis

public ZVTResponse diagnosis()
                      throws ECRException

Forces the terminal to send a diagnostic message to the host.

Overrides:

diagnosis in class ECRBase

Returns:

ZVTResponse

Throws:

ECRException

logoff

public Response logoff()

Resets the terminal configuration from the logon() command to default.

Overrides:

logoff in class ECRBase

See Also:

ECRBase.logon()

logon

public Response logon()

Init the communication to the payment terminal. Triggers the registration command. With the registration command it is possible to set up different configurations on the payment terminal depending on the ConfigByte. Also it triggers an extended response from the payment terminal after a purchase to get more detail information about the card holder verification method (PIN, NFC, signature).

Overrides:

logon in class ECRBase

See Also:

ConfigByte

openCommunication

@Deprecated
public void openCommunication()

Deprecated.

OpenCommunication is deprecated, use logon() instead!

Overrides:

openCommunication in class ECRBase

See Also:

logon()

pointsCollect

public Response pointsCollect(java.lang.String txID,
                              java.lang.String currency,
                              double bonusPointsEquivalentAmount,
                              java.lang.String reference,
                              int client)
                       throws ECRException

Method to transform the given amount into the equivalent bonus points.

Overrides:

pointsCollect in class ECRBase

Parameters:

txID - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

bonusPointsEquivalentAmount - Bonus Points equivalent amount

reference - Not supported in ZVT Implementation

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

preauth

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

Starts a Pre-Authorization/Reservation. In the ZVT implementation only amount is required. The other parameters are not necessary. See overloaded method ECRBase.preauth(double).

Overrides:

preauth in class ECRBase

Parameters:

txId - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

amount - Amount to pre-authorize

reference - Not supported in ZVT Implementation

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

See Also:

ECRBase.capture(double, String), ECRBase.preauthCancel(double, String)

preauthCancel

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

This command cancels a capture of the Pre-Authorization/Reservation

Overrides:

preauthCancel in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Amount to cancel

originalTxId - from former preauth to capture the amount from this preauth (if not send, merchant must enter number manually on terminal)

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

preauthCancel

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

This command cancels a capture of the Pre-Authorization/Reservation

Overrides:

preauthCancel in class ECRBase

Parameters:

currency - Not supported in ZVT Implementation

amount - Amount to cancel

txId - Not supported in ZVT Implementation

originalTxId - from former preauth to capture the amount from this preauth (if not send, merchant must enter number manually on terminal)

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            AgeTags currentAgeCheck)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

currentAgeCheck - Age req. for this purchase

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            java.math.BigDecimal cashback)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

cashback - Amount to Cashback (money withdraw) important: cashback has to be float variable

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            int currentAgeCheck)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

currentAgeCheck - Age req. for this purchase

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            int currentAgeCheck,
                            java.lang.String reference)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

reference - Sends a reference number to the payment terminal. In the terminal software the optional setting 'reference' must be activated to use the reference number in the back-office! If it is activated in terminal software the reference is also printed on the receipt. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%&!\"$%&\/=?:,;{[]}~<>|

currentAgeCheck - Age req. for this purchase

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            java.lang.String reference,
                            AgeTags currentAgeCheck)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

reference - Sends a reference number to the payment terminal. In the terminal software the optional setting 'reference' must be activated to use the reference number in the back-office! If it is activated in terminal software the reference is also printed on the receipt. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%&!\"$%&\/=?:,;{[]}~<>|

currentAgeCheck - Age req. for this purchase

Returns:

ZVTResponse

Throws:

ECRException

purchase

public ZVTResponse purchase(double amount,
                            java.lang.String reference,
                            double cashback)
                     throws ECRException

Triggers a purchase/authorization transaction with cashback

Parameters:

amount - Amount to purchase

reference - Sends a reference number to the payment terminal. In the terminal software the optional setting 'reference' must be activated to use the reference number in the back-office! If it is activated in terminal software the reference is also printed on the receipt. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%&!\"$%&\/=?:,;{[]}~<>|

cashback - Amount to Cashback (money withdraw)

Returns:

ZVTResponse

Throws:

ECRException

purchase

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

Triggers a purchase/authorization transaction. In the ZVT implementation only amount is required and reference is a optional parameter. The other parameters are not necessary. See overloaded methods ECRBase.purchase(double).

Specified by:

purchase in class ECRBase

Parameters:

txId - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

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

tip - Not supported in ZVT Implementation

reference - Sends a reference number to the payment terminal. In the terminal software the optional setting reference must be activated to use the reference number in the back-office! If it is activated in terminal software the reference is also printed on the receipt. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%&!\"$%&\/=?:,;{[]}~<>|

client - Not supported in ZVT Implementation

forceMotoTransaction - not used in ZVT implementation

Returns:

ZVTResponse

Throws:

ECRException

refund

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

Starts a refund transaction. In the ZVT implementation only amount is required. The other parameters are not necessary. See overloaded method ECRBase.refund(double).

Overrides:

refund in class ECRBase

Parameters:

txId - Not supported in ZVT Implementation

originalTxId - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

amount - Amount to refund

reference - Sends a reference number to the payment terminal. In the terminal software the optional setting 'reference' must be activated to use the reference number in the back-office! If it is activated in terminal software the reference is also printed on the receipt. A maximum of 20 alphanumeric characters with the following special characters are allowed for the reference! -_+*#.()/%&!\"$%&\/=?:,;{[]}~<>|

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

removeListener

public void removeListener(IntermediateStatusInformationListener listener)

If you don't want to get further intermediate status information it is possible to remove already attached listener from the notification queue.

Parameters:

listener - The intermediate status information listener to remove from the notification queue.

repeatReceipt

public ZVTResponse repeatReceipt()
                          throws ECRException

To get the last receipt from the payment terminal if it is available.

Overrides:

repeatReceipt in class ECRBase

Returns:

ZVTResponse

Throws:

ECRException

status

public ZVTResponse status()
                   throws ECRException

Starts an status enquire to request the terminal status. Returns the Status ZVTResponse.getResponseCode(), ZVTResponse.getResponseText() also the current terminal software version (ZVTResponse.getSWVersion()).

Overrides:

status in class ECRBase

Returns:

ZVTResponse

Throws:

ECRException

voucherBalance

public Response voucherBalance(java.lang.String txID,
                               java.lang.String reference,
                               int client)
                        throws ECRException

Method to get the remaining balance of the loyalty card.For remaining balance see Response.getBonusPointsEquivalentAmount()

Overrides:

voucherBalance in class ECRBase

Parameters:

txID - Not supported in ZVT Implementation

reference - Not supported in ZVT Implementation

client - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException

voucherLoad

public Response voucherLoad(java.lang.String txID,
                            java.lang.String currency,
                            double amount,
                            java.lang.String reference,
                            int client)
                     throws ECRException

Credit amount to the loyalty card. For remaining balance see Response.getBonusPointsEquivalentAmount()

Parameters:

txID - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

amount - Amount to credit to the loyalty card

reference - Not supported in ZVT Implementation

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

Returns:

ZVTResponse

Throws:

ECRException

voucherPay

public Response voucherPay(java.lang.String txID,
                           java.lang.String currency,
                           double amount,
                           java.lang.String reference,
                           int client)
                    throws ECRException

Start a transaction with amount to debit from the loyalty card. For remaining balance see Response.getBonusPointsEquivalentAmount()

Overrides:

voucherPay in class ECRBase

Parameters:

txID - Not supported in ZVT Implementation

currency - Not supported in ZVT Implementation

amount - Amount to credit to the loyalty card

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 - Not supported in ZVT Implementation

Returns:

ZVTResponse

Throws:

ECRException