PayFacto API v1.3.9 (STP Installer) - STPI/STP - Client Installation Guide

PayFacto API v1.3.9 (STP Installer) - STPI-STP - Client Installation Guide

Contents

📝 Before You Begin 🔑 1 - Access to STP Installer 📄 2 - Get a License 💾 3 - Install and Configure the STPI Client ⚙️ 4 - Set Up STPI Client As a Service ✅ 5 - Make Sure the Service is Started ⚠️ Legal Notice

📝

Before You Begin

The following steps are the main tasks to complete to ensure that the STPI Client is correctly installed on your system:

Ensure you have the latest STP Installer and installation guide provided by the PayFacto Integration team.
If your payment processor is NOT PayFacto, get a license token from the PayFacto Integration team.
Configure STPI properties file to meet your system requirements.
Set up the STPI Client as a service on your system.
Make sure the STPIClient service has started.

🔑

1 - Access to STP Installer

If you do not have the latest STP Installer, please contact the PayFacto Integration team at integration@payfacto.com.m

ℹ️

Note: The source document lists this email address as integration@payfacto.com.m — the trailing “.m” appears to be a typo in the original document. Reproduced verbatim here; please confirm the correct address (likely integration@payfacto.com) before publishing.

📄

2 - Get a License

If you require a license (only if your payment processor is NOT PayFacto), please contact the PayFacto Integration team at integration@payfacto.com.

💾

3 - Install and Configure the STPI Client

The STPI Client is included as a part of the windows installer (e.g.: STPISecure1.3.9.exe).
NOTE: Version 1.3.9 is the current version number.
Make the required changes to the gateway_sm.properties file.
Run the STPI client to enter the token information.

3.1 - Install the STPI Client

To install the STPI Client, locate and run the installation file. Follow the instructions on screen to complete the installation process.

ℹ️

NOTE: If you change the default installation location, take note of the selected location for later steps.

3.2 - Configure the gateway_sm.properties File

The following table lists all the properties contained in the gateway_sm.properties file (default installation location is [drive letter]:\Program Files (x86)\Terminal Management Concepts\STPISecure\STPIClient). Use the table to identify the properties that need modification and make the required change(s).

Property with Default Value (if applicable)	Modify?	Modification Description / Usage
`stpi.websocket`	No
`stpi.websocket.ssl`	No
`stpi.websocket.port`	No
`stpi.license.type`	No
`stpi.license.popup`	No
`lic.server.ip`	No
`lic.server.port`	No
`lic.truststore.password`	No
`verifone.vgi`	No
`stpi.message.encryption`	No
`pos.close.check`	No
`stpi.server.ip`	No
`stpi.server.ip2`	No
`stpi.server.timeout=20000`	No
`stpi.server.port=3456`	No
`stpi.server.eod.pollinterval=30000`	No
`stpi.server.client=0`	No
`stpi.client.ip=true`	No
`stpi.client.service.port=9999`	No
`stpi.client.ip.print.nooflines=20`	No
`stpi.client.changepos=1`	Based on POS Type	The default value for this property is 1 when using POS Type 4. Modify only if you are using a different POS Type.
`stpi.client.system.tray=1`	No
`Stpi.client.clerk.track2=0`	No
`pos.type=4`	No
`stpi.pos.type5`	No
`pos.server.ip=127.0.0.1`	Yes	POS Server IP Address. Modify only if the POS Server is running on a different machine than the STPI Client. If the POS Server and STPI Client are running on the same machine, leave the default value of 127.0.0.1.
`pos.server.ip2=127.0.0.1`	Yes	Backup IP address for the POS Server. Typically, the value is the same as the POS Server IP Address.
`pos.server.port=5656`	Based on POS	Port number used by the POS server for listening. The default value is 5656. If you are using Maitre’D, you shouldn’t need to modify this value. Modify only if your POS server uses a different port, change the value to match the server requirement.
`pos.read.timeout=60000`	No
`pos.listen.port=4999`	Yes	The default value for this property is 4999. Modify only if you are using POS Type 3.
`pos.tender.debit=0` `pos.tender.mcrd=1` `pos.tender.visa=2` `pos.tender.diners=3` `pos.tender.discover=4` `pos.tender.amex=5` `pos.tender.jcb=6` `pos.tender.pl=7` `pos.tender.cash=8` `pos.tender.gift=9` `pos.tender.cup=10`	Based on POS Type	You should not need to change the default values for these properties. Modify only if the default settings do not correspond with POS Type 1, and POS Type 3 settings.
`pos.termid=1`	No
`pos.servicetype=TS`	No
`pos.pass.tk2.apply.pay=1`	No
`pos.version=14`	No
`pos.long.query=0`	No
`pos.server.database.port=1433`	No
`pos.server.database.instance.name="SQLMACHINE1"`	No
`pos.server.database.connection.type=1`	No
`pos.server.mode=2`	Only for DEV	The default value is 2 for production (SSL mode). Changing the value to 1 disables SSL mode and should only be used for DEV environments.
`pos.clerk.conv.number=1`	No
`pos.refund.amount.positive=0`	No
`pos.refund.enable`	No
`pos.params.enable=1`	Only for FDMS	Generally, you should not need to modify the default value (1) of this property. Modify only if you need to disable (value = 0) properties used for FDMS only.
`pos.params.tip`	No	FDMS only
`pos.params.table`	No	FDMS only
`pos.params.check`	No	FDMS only
`pos.params.passToServer`	No	FDMS only
`pos.params.passToCustomer`	No	FDMS only
`pos.params.merchantReceipt`	No	FDMS only
`pos.params.debug`	No	FDMS only
`pos.params.tipOnTax`	No	FDMS only
`pos.param.loyalty=`	No	FDMS only
`pos.param.filter=`	No	FDMS only
`pos.param.cash=`	No	FDMS only
`pos.params.ip`	No	FDMS only
`pos.params.url`	No	FDMS only
`pos.params.port`	No	FDMS only
`pos.params.pos`	No	FDMS only
`pos.params.tip.preset1`	No	FDMS only
`pos.params.tip.preset2`	No	FDMS only
`pos.params.tip.preset3`	No	FDMS only
`pos.params.settingPassword`	No	FDMS only
`pos.params.promptTimer`	No	FDMS only
`pos.param.autosettle=2000`	No	FDMS only
`pos.bar.change=1`	No
`pos.response.limit=0`	No
`stpi.newserver.client=0`	No
`stpi.Server.clientID`	No
`stpi.Server.clientSecret`	No
`alertEmailAddress=,`	Yes	Add the email addresses you want to receive alerts in case of licensing-related issues. If you are adding multiple email addresses, separate each one with a comma (,).
`checkTime=00:00:00`	No
`TBLPMPT=1` `CHKPMPT=0` `CSHTENDER=0` `SERIALTYP=0` `PREAUTH=0` `REFUND=0` `POLLING=0` `POLLINTERV=60` `APPLYPAY=1` `FALLBACK=0` `SPLITTENDER=1` `TBLSORT=1` `CARDMASK=1` `ADVRCPT=1` `TIPAPPRLINE=0` `CVRTCHKNUM=0` `TBLNAME=0` `PORTNUM=9999` `NAMEADR=0` `PRIMHOST=127.0.0.1` `SECHOST=127.0.0.1` `SECPORT=9999` `TIPREPORT=0` `TIPENTRY=1` `TIPTYPE=2` `TIPPERCENT=15` `DECLINBEEP=1` `ADMPROTECT=1` `RESTTYPE=3` `TIPENHANCED=0` `TIPCALCULATOR=0` `TIPPERCENT1=10` `TIPPERCENT2=15` `TIPPERCENT3=20`	No	Used only for parameter download on Moneris.

3.3 – Run the STPI Client for the First Time

In the installation location, double-click run.bat; the default installation location is [drive letter]:\Program Files (x86)\Terminal Management Concepts\STPISecure\STPIClient\.

After run.bat starts, a command prompt (DOS) window opens and the Merchant Info window appears, as shown in the following example:

Complete the fields with the requested information:

If your payment processor is PayFacto, enter PayFacto in the Merchant Token field. If your payment processor is NOT PayFacto, obtain a token from the PayFacto Integration team.
Enter your location Zip/Postal code in the Store ZIP/Postal Code field.
Enter your location identifier in the Store Identifier field.

Click OK to submit the information in the Merchant Info window.

Close the command prompt (DOS) window by clicking the X in the top right corner of the window.

⚙️

4 - Set Up STPI Client As a Service

After configuring the gateway_sm.properties file, you need to:

Remove any previously installed STPI Client
Overview of Service Batch Files
Install STPIClientServiceXX.bat
Run this to install the TGI Client as a service.

ℹ️

Note: The source document refers to the “TGI Client” in this bullet point, while the rest of the document consistently uses “STPI Client”. TGI was the product’s former name before it was rebranded to STPI — this appears to be a leftover reference from the source document. Reproduced verbatim; please confirm before publishing.

⚠️

IMPORTANT: If you are configuring a DEV environment, do not install STPI as a service.

4.1 - Remove Any Previous Version of the STPIClient Service

When a new version of the STPI Client needs to be installed, the previous installation must be removed.

ℹ️

NOTE: If this is the first time you are installing the STPI Client, you can skip this step as there is no previous version installed.

To remove an existing instance of the STPIClient service, run RemoveSTPIClientService32.bat or RemoveSTPIClientService64.bat (depending on your version of Windows). The RemoveSTPIClientServiceXX.bat files are found in the [drive letter]:\Program Files (x86)\Terminal Management Concepts\STPISecure\STPIClient\Install_As_Service\STPI InstallAsService\winXX folder

Double-click the appropriate version of the RemoveSTPIClientServiceXX.bat file to remove the STPI Client service.

4.2 – Install the STPIClient As a Service

After you remove the previous version of the STPIClient, you need to install the latest version, using the following procedure:

Select the appropriate folder based on your version of Windows (32bit or 64bit) found in [drive letter]:\Program Files (x86)\Terminal Management Concepts\STPISecure\STPIClient\Install_As_Service\STPI InstallAsService\.

Double-click the InstallSTPIClientServiceXX.bat (based on your version of Windows).

On the screen that appears, click the Browse ( … ) button in the Path field, locate the STPI Client folder and select run.bat.

Make sure you select All Files from the list.

After you select run.bat, click the Install service button.

4.3 - StartSTPIClientServiceXX.bat

After installing the STPIClient as a service, you need to start the service. To start the STPIClient service, run StartSTPIClientService32.bat or StartSTPIClientService64.bat (depending on your version of Windows). The StartSTPIClientServiceXX.bat files are found in the [drive letter]:\Program Files (x86)\Terminal Management Concepts\STPISecure\STPIClient\Install_As_Service\STPI InstallAsService\winXX folder.

✅

5 – Make Sure the Service is Started

After installing and starting the service you need to confirm that the service is running, as explained in the following procedures.

Access System Services on Windows XP

Click on Start.

Click on Run.

In the run window type services.msc and click OK.

Access System Services on Windows Vista, 7 or 10

Click on Start.

Type services.msc in the search field.

Press the Enter key or click on services.msc in the Programs area of the search results.

The Services Menu

On the list of services, locate StpiClient.

Make sure that:

The service Status column is Running.
If it isn’t, right-click and select Start from the popup menu.
The Startup Type column is set to Automatic.
If it isn’t, right click and select Properties from the popup menu and change the Startup Type to Automatic.

⚠️

Legal Notice

⚠️

This document and the information within are the property of PayFacto Payments Inc. (“PayFacto”) and may only be used for the purpose for which they are intended and supplied. Reproduction of this document or use of the information within, in whole or in part, is strictly prohibited without the express written consent of PayFacto. PayFacto reserves the right to revise this document and to periodically make changes to the content hereof, without obligation of PayFacto to notify any person or organization of such revision or changes.