Shift4 Interface Manual E7 - s4-myportal.s3.amazonaws.com · 1. The install will have created the folder “BOCFiles”. It contains the following files: • TIFSHIFT4.dll • TIFSHIFT4.cfg

© 2020 Shift4 Payments, LLC. All rights reserved. Version 1.7 External Use NDA Page 1 of 33

Shift4 E7 EMV Bridge Interface

Installation and Usage

Shift4 E7 EMV Bridge Interface Installation and Usage


Table of Contents INSTALLATION ...............................................................................................................................4

New In this version ........................................................................................................................4

Overview .......................................................................................................................................4

Files .......................................................................................................................................4

Communications ....................................................................................................................4

Communications ....................................................................................................................5

Limitations / Special considerations .......................................................................................5

Software installation .....................................................................................................................5

TIF File Distribution .......................................................................................................................5

BOC Tif Files ..................................................................................................................................5

BOC CAL Package ...........................................................................................................................5

Manual Workstation Tif Files .........................................................................................................6

POS Configurator ...........................................................................................................................6

Interfaces ......................................................................................................................................6

Tenders .........................................................................................................................................7

Tender configuration .............................................................................................................8

Service Charge ...............................................................................................................................13

Shift4 Tip ...............................................................................................................................13

Touchscreens ................................................................................................................................15

The Universal Transaction Gateway (UTG) Setup ...........................................................................17

The Express Tab .............................................................................................................................17

The API Interfaces Tab ...................................................................................................................17

Devices Tab ...................................................................................................................................18

[Option] Advanced Tab ..................................................................................................................18

Finish.............................................................................................................................................18

INTERFACE CONFIGURATION .........................................................................................................18

General Tab ...................................................................................................................................19

Tenders and Service Charges: ........................................................................................................20

UTG Tab ........................................................................................................................................20

Revenue Centers Tab .....................................................................................................................21

Access Token .................................................................................................................................22



Devices Tab ...................................................................................................................................24

Printing Tab ...................................................................................................................................25

Finished .........................................................................................................................................25

USAGE ...........................................................................................................................................27

Authorization ................................................................................................................................27

Re-Authorization ...........................................................................................................................30

Finalize ..........................................................................................................................................30

Sale ...............................................................................................................................................32

Refund ..........................................................................................................................................32

Reprint Chits..................................................................................................................................33

Existing check ........................................................................................................................33

Voids .............................................................................................................................................33

Referral .........................................................................................................................................33



INSTALLATION

New In this version 1. Amount prompts have been corrected for Sale and Refund. 2. The option Not to print the capture chit, and Not to print the tip line on the capture chit have been fixed. 3. The user now enters the total amount of an authorization, even on re-authorizations. Previously, a re-

authorization would increase the previous authorization by the amount entered by the user. This is now consistent with all other Bridge software.

4. Spaces have been added between tip, total, and some other lines. Previously, all empty spaces were removed before printing.

5. Options have been added to allow printing 2 copies of chits. 6. Authorizations can now be voided, if there are NO Shift4 payments on the check.

Overview

Files This interface is an E7 TIF interface. There are 2 files that must be copied to the BOH computer, and another 2 files that must be copied to each workstation. The Workstation files can be handled with a CAL package that is included in the installation. Finally, there is a windows service and configuration program that must be installed on an interface computer that is connected to the LAN with the BOH PC (this computer can be the BOH PC).

BOH = Back of House

BOC = Back of House Controller

The general table below shows the key files and where they must end up within the E7 system:

Workstations BOH PC Interface computer

TIFSHIFT4.dll (CE version) TIFSHIFT4.dll (Win32 version) Shift4Config.exe

TIFSHIFT4.cfg(CE version) TIFSHIFT4.cfg (Win32 version) Shift4_E7_Interface.exe

* Other supporting files

Communications

Workstations BOH PC Interface PC UTG

TIFSHIFT4.dll Shift4_E7_Interface.exe (tcp/ip socket) (https TLS 1.2)



Communications Within the E7 Configurator this interface requires configuration of several tenders, an Interface, and a number of touchscreen keys.

Within the Shift4Config.exe program, most of the interface parameters must be set to match both the E7 configuration AND the UTG configuration.

Limitations / Special considerations 1. Tips must be added manually before the payment occurs. That is, after an Auth, but before a Capture or Sale. 2. Manual Auth/Sale is not supported. 3. At this time, Referrals are not supported.

Software installation 1. Before installing, confirm you have the corresponding installer to match the E7 version. 2. On the chosen Interface computer (which can be the BOH computer), run the installation file and install the

interface into the location C:\Shift4Interface. 3. Copy the Win32 TIF files to the correct location on the BOH computer. 4. Copy the Workstation TIF files to the correct location on each Workstation. 5. Configure the E7 Configurator settings. 6. Configure UTG. 7. Configure the Shift4 Interface settings. 8. Test transactions.

TIF File Distribution

BOC Tif Files 1. The install will have created the folder “BOCFiles”. It contains the following files:

• TIFSHIFT4.dll • TIFSHIFT4.cfg

2. Copy these files to the E7 “Bin” folder on the BOC. Normally, this is located here:

• C:\Program Files (x86)\MICROS\e7\Bin

BOC CAL Package 1. The install will have created the folder “CAL”. It contains the following files:

• Shift4\ • Setup.dat




2. Copy the Shift4 folder to the appropriate E7 “Cal\Packages” folder on the BOC. This may be located in several different places, depending on your installation. You can use Windows Service Manager to determine the “MICROS CAL Service” is running. Often (not always) it is in this location: C:\Program Files (x86)\MICROS\CalServer\

3. The Shift4 folder should be copied to the packages folder for your workstation models.

• For example: C:\Program Files (x86)\MICROS\CalServer\WS5a\Packages\Shift4

4. Edit the file “PackageList.dat” (located in the same folder as the Shift4 folder from 3.)

• Add the line: Shift4 to the end of the file.

5. Save the file.

Manual Workstation Tif Files If the CAL solution does not work properly, you can manually copy the files to each workstation.

1. The install will have created the folder “CAL”. It contains the following files:

• Shift4\

o Setup.dat o TIFSHIFT4.dll o TIFSHIFT4.cfg

2. Copy the files:


to the E7 “Bin” folder on each workstation. Normally, this is located here: \cf\micros\e7\Bin

POS Configurator Go into the POS Configurator, and log in with a manager or Micros login.

Interfaces 1. Go to Interfaces. 2. Add an interface Record. Use the settings in the following screen shots.



• Number – Interface Number. • Name – The Interface Name. • Interface Code – The Interface Code is added when the bridge interface is installed via the file TifShift4. • Node – Server/BOH name. • Set the timeout to be 120. If you want to set it lower for initial testing, that’s fine, but live use requires

120. • Set the TCP Server Name to be the IP address of the Interface Computer on which you ran the install file. • Set the Port Number to be an open tcp port, NOT one that is already in use by another interface or

process.

Tenders Add 1 Auth tender, and 1 or more “Payment” Tenders. They are all payment types in the configurator.

The Auth tender will always be $0.00. It will not necessarily require being added to reports.

The other tenders will be identical to the Auth tender (except for their names) and will be for non-zero payment amounts. These tenders must be configured to appear on reports. If you take 4 types of credit cards, you should create 4 Shift4 Payment tenders. For example, for Visa, create a “Shift4 Visa” tender, for Amex, create a “Shift4 Amex” tender. These are NOT credit card tenders in Micros.

Follow the screen shots below for setup information on the Auth and Shift4 Payment tenders.

Note: All of these tenders will have at least these items set:



Reference Required: Un-Checked

Charge Tip: Left empty

Interface: Shift4Bridge

Tender configuration (Set the names as needed)



• Set the printing options as needed for your site. • Disable Tender Rounding.



• Do not set a charge tip.



• Set the print options as needed.



• Add / Select the Shift4 Bridge interface you added above.



Service Charge Add 1 Service Charge. This will be used to manually add tips to the check. Follow the screen shots below for setup information on the Auth and Shift4 Payment tenders.

Shift4 Tip





Touchscreens There are several keys used in this interface. You can place them on whatever screens work for the site.

In this example, we have placed them all on 1 screen for convenience.

• Auth • Capture • Sale • Refund • Reprint

The Refund key MUST be placed on a screen that is only accessible to a Manager who can do the following:

• Ring Negative Checks • Direct Void • Pay Negative Checks

All keys are defined like this:

Function: Inquire > Shift4 Bridge

Value: The Shift4 function (Shift4 Auth for example)



Authorize

• Inquire > Shift4 Bridge > Shift4 Auth

This function performs the basic credit card authorization.

Final

• Inquire > Shift4 Bridge > Shift4 Capture

This function performs the basic Capture to complete the payment based on an existing authorization.

Sale

• Inquire > Shift4 Bridge > Shift4 Sale

This function performs the basic Auth/Capture in one function to complete the payment. This would be used in a quick service environment or other similar situation.

Refund

• Inquire > Shift4 Bridge > Shift4 Refund

This function performs a refund onto the card. This is used only with a Negative check, and care must be taken to be sure any user who can access this function has all required privileges in the 3700.

Reprint Chits

• Inquire > Shift4 Bridge > Shift4 Reprint

This function attempts to reprint the last chits that were printed for a specific transaction.

Void

• Voids do not have a separate key. When a Sale or Capture is voided, the interface will process the void.



The Universal Transaction Gateway (UTG) Setup 1. Go to Start > All Programs > Shift4 Payments > Universal Transaction Gateway > UTG (v2) TuneUp

The Express Tab 1. Station Name = REST 2. Serial = This will be supplied by Shift4 on the UTG Config Sheet under Serial Number: 3. Host Address = Micros Server IP Address (example: 192.168.100.250) 4. Location = Zip Code 5. Api Serial Number and Password = Leave these blank

The API Interfaces Tab 1. Select Add, then REST 2. Host Address = Micros Server/BOH IP Address (example: 192.168.100.250) 3. Port = This must be 277 4. Select Generate Certificate and fill in the appropriate information

• Common Name = Micros Bridge • Friendly Name = DBA name from the UTG Configuration Sheet • Organization = Restaurant name with location if multiples • Email Address = Sites main contact email (owner, GM, etc.) • Locality = City • State/Province = ST • Country = US • DNS Tab – In the DNS box, you need to add two things: • Micros Server/BOH IP Address (on the first line) • localhost (on the second line) Please be aware that you are typing the WORD ‘localhost’ not using the

actual localhost I.P on this line • CA SelfSigned / Intermediate – Select the following items:

o SelfSigned o CRT o Server Authentication o Client Authentication o 4098 bit o **MAKE SURE Embed Key in unchecked**

Enter a password and make sure you keep this somewhere safe for your records (you will also need this for the next couple of steps after the certificate is generated).

Click on Generate – This will prompt you for the folder where the certificate and key will be saved. Save it to C:\Shift4\. After about 30 seconds, you should see SUCCESS at the bottom, then Exit.

Certificate File – Browse to C:\Shift4\ and select the *.crt file within (you will need to change to see All Files, as it defaults to *.cer).

5. Certificate Password – Enter the password that you created above.



6. Private Key File – Browse C:\Shift4\yes and select the *.key file within (you will need to change to see All Files, as it defaults to *.cer).

7. Private Key Password – Enter the password that you created above. 8. Select OK.

Devices Tab 1. Select Add, then fill in the appropriate PinPad info:

• Device Name = PinPad-101 (where 101 matches the Workstation name - WS6-101, etc.). • Device Type = Select the appropriate type (we normally use Ingenico iPP320 RBA). • API Terminal ID = This will be supplied by Shift4 on the UTG Config Sheet. • Connection = This will normally be Direct TCP/IP. • IP Address = PinPad IP Address (example: 192.168.100.1) – If the workstation is 192.168.100.101, • Port = 12000 if you are using the default on the iPP320. • Manual Card Entry = Enable MCE. • Select Disabled for CVV Code, Street Number, and Zip Code. • Source Serial = This will be supplied by Shift4 on the UTG Config Sheet as Serial Number: • Select Contactless Enabled and Bypass Amount OK.

2. Select OK and repeat as many times as necessary for each PinPad.

[Option] Advanced Tab (If the D:\ drive was used for installation)

1. Select Trace Configuration and make sure the directory within is D:\Shift4\UTG2\Trace\, then OK. 2. Select Splunk Configuration and make sure the directory within is D:\Shift4\Splunk\, then OK.

Finish Once you have verified all the data is accurate across all of the above tabs, select the Save button, and TuneUp will close.

INTERFACE CONFIGURATION You need to enter the configuration settings that will be used by the interface. This is done through the Shift4Config program, which is located in the \Shift4Interface folder where it was installed.

1. Run the Shift4Config.exe program



General Tab

Postal Code The site’s postal code.

Log Verbosity 1 = low, 9 = much too much

Interface Port The tcp port you selected for this Interface in EMC.

Micros Interface Timeout The timeout you selected for this Interface in EMC less 2 seconds.

UTG Timeout The timeout that the interface will wait for a response once a request has been sent to UTG. Generally, set this to be 2 seconds less than the Micros Interface Timeout.

UTG Invoice Wait Delay In Production, set this to 1 or 2 seconds. On a test platform, use 3, 4, or 5 seconds.



Tenders and Service Charges: Authorization Tender The object number of the Authorization Tender you created in Configurator.

Visa Tender The object number of the Shift4 Visa Tender you created in Configurator.

Other Tenders The object numbers of the other Shift4 Payment Tenders you created in Configurator.

If you are not using some methods of payment, do not create them in Configurator, and enter 0 here.

UTG Tab

Enter each UTG instance installed at the site that this interface will use. Although this integration can support multiple UTG instances, it is difficult to imagine a situation where you will ever need more than 1.

UTG Number 1

URL:Port The URL and port. In <URL>:<Port> format.

URL = https://192.168.2.1 and port 5009 would be:

https://192.168.2.1:5009



Revenue Centers Tab

Enter the settings for the revenue center and its assigned UTG.

Number The Revenue Center Object Number. Read only.

Name The Revenue center name. Read only.

UTG Number 1 – 5, depending on the UTG Screen.

Access Token This will be filled in automatically when you use the Token Exchange function.

Header Enter any custom header lines you want on the Shift4 chits.

Trailer Enter any custom trailer lines you want on the Shift4 chits. This may conflict with custom print trailers; particularly tip suggestion SIM trailers that are included.

Token Exchange Press this to do a token exchange. You will need the site’s Authorization Key to run this.



Access Token

This is done through the Shift4Config program. The other settings must be completed. Repeat this for each Revenue Center/Merchant Account.

1. Run the Shift4Config.exe program. 2. Go to Revenue Centers. 3. Select the Revenue center on the left.

4. Press Token Exchange on the right.



5. Confirm that the UTG URL is correct. 6. Enter or copy/paste the Auth Token that you were provided by Shift4 for this Revenue Center. 7. Press Request Token Exchange. This may take a few seconds. 8. When finished, if there was no error, the Access Token will be saved to the main form under the selected

Revenue Center. 9. Be sure to select “Save” on the Revenue Center tab. 10. Repeat for each revenue center.



Devices Tab

Enter each Ingenico device that this interface will use, and its assigned workstation and UTG.

Device ID (API TID) The API Terminal ID value provided on your Shift4 Configuration Sheet. This number will be entered with no leading 0's. The Device ID in the bridge interface has to match what the API TID is showing as in LTM and UTG.

Workstation Number/Name The workstation Number and name. This will be 1 – 6.

UTG Number The UTG Instance number from the UTG Tab.



Printing Tab

Do not print Capture chit This will suppress printing of the Capture chit after a Capture. However, it will still be available for the reprint function.

Do not print Tip Line on Capture chit This will suppress printing of the tip line on a Capture chit after a Capture.

Signature on Device Check this if you are using Signature Capture UTG Devices.

Print 2 Auth Chits (and all Print 2 Chits options)

Unchecked, 1 copy of the chit will print. Checked, 2 copies will print

Line Feeds between chits After the first chit is printed, the printer will advance this many lines before the paper cut. Normally 5 is normal set, but set it as desired

Finished 1. File > Save

When you are done, and all saved, use Windows Service Manager to start the service: Shift4 E7 Bridge Interface.



If the service was not installed during installation, try: Admin > Install Service.



USAGE

Authorization Start a check, and ring up some items. Do NOT do this with a $0 balance check.

1. Press the Shift4 Auth Key. 2. You will be prompted for an amount. Enter the amount, or press Enter to use the Total Due. You can enter

more than the Total due.

3. After pressing Enter, go to the Ingenico Device.

You will be prompted to confirm the amount on the device, and then you will be prompted to insert the card.

Confirm the amount, and insert the card as needed.



4. If successful, the Auth info will be stored on the check and the auth chit(s) will print.

The tender reference on the check will contain several important numbers.

523XXX….XX3332 123 will be the Invoice number, and the 4354 will the rightmost part of a masked card number.

Auth Amount: 10.00 10.00 will be the total amount authorized. In an incremental auth, it will always be the running total, not the incremental amount.

5. If not successful, an informative message will be displayed.



6. You should get a printed chit that will look something like this:

Beaches Header

Authorization

APPROVED

Table: 65

Server: 1 Samantha

Check: 9905

Time: 03/18/19 05:01:37

Amount: 6.50

Card Type: DISCOVER

Card: XXXXXXXXXXXX3429

Invoice: 0000000003

Token: 3429bjy64htpqj22

Device: 0001

Response: APPROVED

ENTRY METHOD: SWIPED

TAC Default: DC4000A800

TAC Denial: 0010000000

TAC Online: DC4004F800

Amount 6.50

Tip __________________

Total __________________

________________________________

Signature

*** CUSTOMER COPY ***



Re-Authorization 1. Repeat the Auth process using a larger amount. Always enter the total amount to authorize.

Finalize 1. Add the tip to the check manually. The tip cannot be added as part of the payment. 2. Press the Shift4 Capture key.

You will be prompted for the amount. Enter the total payment amount and press Enter. If you just press Enter without entering an amount, the Capture will assume the Total Due on the check.



3. A list of authorizations available on the check will be displayed.

4. Select one of the authorizations, and press the Enter/OK key. 5. If successful, the appropriate Tender will be added to the check, as shown below. 6. Note that this will make the Authorization unavailable for use again. If you void the payment and wish to use

the card again, a new auth must be done.



Sale The Sale function does a one-stop payment. It will only put the Sale tender on the check and not an Auth. Follow the same flow as the Auth, and results in a payment just like a Capture.

Refund 1. To do a refund to a card, create a Negative Check. Then press the Refund key. 2. Follow the same process as the Auth.

The Refund function does a one-stop refund. It will only put the Sale tender on the check and not an Auth. Follow the same basic flow as the Sale and Final, but you will not be prompted to select from existing Authorizations.

The Refund will not prompt for a tip amount. The payment will be for the amount you enter, and it will not figure out or add a tip.



Reprint Chits

Existing check 1. Pickup a check with a Shift4 transaction. 2. Press “Reprint Chits” 3. You will be prompted to enter the Invoice Number. This is the 10 digit “Key” or “Invoice” number from a

previous chit or Micros check. 4. If a saved chit is still available, it will reprint. Chits are generally available for 24 hours.

Voids 1. Authorizations cannot be voided. 2. Refunds cannot be voided. 3. For a Final or Sale, pickup the check, 4. Select the payment to void and press the Micros Void key.

Referral In some instances, an Authorization or a Sale will not be approved or declined, but will be referred to a voice phone number. When this occurs, it will be treated as a declined transaction on the E7.

Shift4 Interface Manual E7 - s4-myportal.s3.amazonaws.com · 1. The install will have created the folder “BOCFiles”. It contains the following files: • TIFSHIFT4.dll • TIFSHIFT4.cfg

Documents