Integrate payment/card terminal

You are able to use a IQ4docs payment terminal (usually a card terminal) to post account amounts to user accounts. With a card posting terminal, the costs are posted in a manner similar to an ATM and the card is required (e.g. Eurocard) along with the PIN for the card. The amount paid is then credited to the user account.

A device with the Embedded Client and a payment terminal is required for the payment process. One payment terminal can be used by several photocopiers. For this purpose, a workflow for payment with the payment terminal must be created. Please note the following steps.

The payment terminal must be addressable via the network using an IP address or hostname. It must support the ZVT protocol. Please refer to the operating instructions of the payment terminal for information on how to set up the payment terminal.

The ZVT protocol does not provide for its own encryption of data. So please make sure to encrypt the network connection separately.

The payment terminal must communicate with the TerminalComService. The following values must therefore be the same for the payment terminal and the TerminalComService. Please refer to the operating instructions of the payment terminal to find out how to make the settings in the payment terminal. To make the settings in the TerminalComService, modify the following entries in the LocalService.config of the TerminalComService:

Specify the port with which the TerminalComService and the terminal communicate. 20007 is the default value - it is also used if the entry below is missing (enable the port in firewalls if necessary).

  • <add key="TerminalPort" value="20007" />

Enter the password for the terminal in encrypted form. In unencrypted form, the password must be exactly 6 characters long and only contain numbers. To encrypt the password, use the command line program EncryptPassword.exe which is located in the installation directory of the TerminalComService.
Call example: EncryptPassword.exe 012345 <Enter>.

  • <add key="TerminalPassword" value="MzAyMDEw" />

The payment terminal must be assigned to the device. To do this, create a user-defined field on the device, see Create User-Defined Fields For Devices.

Use this field (e.g. terminalhost - this name is already in use in the standard workflow) to enter the IP address or the hostname of the payment terminal in the detailed data record of the device.

After entering the value, resend the device configuration to the device (click the Configure Devices drop-down list below the list of devices and select Set Up Device For IQ4docs).

Now create a workflow for the payment operation. To do this, select the workflow type External and assign a name, for example, Credit Account, see also Create, rename and delete workflow. The workflow appears in the workflow editor.

In the workflow settings, specify that the workflow is to be used as a OneClick workflow.

The workflow must be designed as a OneClick workflow, otherwise it cannot be started.

The workflow template must now be modified in a few places to make it into an executable workflow. Edit the following modules.

This module checks whether the device from which the workflow is started is assigned to a card terminal, i.e. whether the user-defined field is filled in (see Assign payment terminal to a device).

To do this, set the following settings in the yes output of the module:

  • System variable: The user-defined field for the card terminal
  • Comparison operator: Not equal
  • Comparison value: <leave empty> (this means the system checks whether the content of the field is not equal to empty).

Specify the following settings in the Card Terminal module (see also Card Terminal module):

  • User-defined device field for hostname/IP of the card terminal: Enter the name of the user-defined field here, see Assign payment terminal to a device.
  • Archive folder for receipts: Enter the complete path for storing the posting receipts here. These are stored in PDF format.

At this point the workflow should be executable. You should still make the following setting:

Select amount: Define here which amounts can be posted. Note that the variable values must be numeric (monetary amounts without currency codes).

If you change the variable name, please note that it is already in use in the modules Card Terminal, Display Message on Device: Posting Successful, and Notification: E-Mail Posting Successful (see also Interview Selection Module).

Specify the workflow here on which the receipt or error receipts are printed. The default setting is Standard Print Workflow (see also Start Print module).

If necessary, also enter a cost center to which the amount of the transaction is to be posted (see Card Terminal module).