Shift 4

Shift4 – Easy Inn Keeping Configuration

Architecture

Gracesoft’s EIK is on Gracesoft’s Cloud network with a local application (Angular) running on the browser. The application is accessed at https://apps.gracesoft.com/pmsui

Shift4’s device communicates with the UTG App which provides all the services for payments, refunds and other transactions.

For integration, UTG provides a HTTPS service running on port 277. The URL will be similar to https://127.0.0.1:277 or https://<localip>:277

We have a small custom application named Shift4Proxy which will be running the same system where the user logins and works on the EIK software for reservations. The proxy provides a web service on http://localhost:5000 to receive all transaction requests from EIK (browser) and forwards all requests to the UTG URL.

Steps to startup:

Start the UTG

1. Go to command prompt and go to folder Cd C:\Shift4\UTG2 and type utg2.exe -n

4. Install .NET Core  3.1 Hosting Bundle from:

https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-3.1.32-windows-hosting-bundle-installer

               Download and extract the zip archive file Shift4Proxy from

https://apps.gracesoft.com/PMSUI/Shift4/Shift4Proxy.zip

The appsettings.json file has configuration: UTGUrl which can be configured if needed.

Run the Shift4 Proxy

From the extracted folder run Shift4Proxy.exe and keep the window minimized.

To Process the Payment on EIk:

1.Create a new reservation.

2. Go to the billing page, under "Payment & Refunds", Choose account code, and Click “Process” button.

3. Once the card reader displays message “Amount ok?***.**, select “Yes”

4. After select “Yes”, ask customer to swipe the payment card.

1. After swipe the payment card, the message appears “Please select payment type “ , “Debit/Credit.

2. Select payment type “DEBIT/CREDIT”

3. After selects the payment type, the message appears “Authorizing..Please Wait” on terminal’s screen

4. Once the card successfully authorized, it displays the message as "Approved" on terminal's screen.

5. Simultaneously, in Easy Innkeeping, “Transaction successful” message will pop on the billing page and the separate line item will be created with the transaction Id.

 Authorize and Capture the amount:

1.Open the reservation>>billing>>Payments & Refunds, Choose account code, and Click “Authorize” button.

2. When card reader displays message “Amount ok?***.**,ask customer to select “Yes”

After customer select “Yes” *,ask customer to swipe the payment card.

 After customer swipe the payment card, the message appears “Please select payment type “ , “Debit/Credit".

Ask customer to select payment type “DEBIT/CREDIT”

After customer selects the payment type, the message appears “Authorizing Please Wait” on terminal’s screen.

After authorizing the payment card, message “Approved” appears on terminal’s screen.

In PMS, “Transaction successful” message will appear on the billing page.

Once the transaction is successful, the payment transaction line item will appear on the billing page.

To capture the authorized amount:

Click “Capture” button to capture the authorized amount.

Click the “Capture” button, enter the amount to capture on the “Amount” Textbox and then click “Process” button.

Once the amount has been processed, the “Transaction successful” alert will appear at the bottom of the billing page.

To Void the transaction:

1.Select the Transaction ID and click the “Void” button on the Billing page.

After clicking the “Void” button, the alert message will appear to ensure void the transaction as ”Are you sure to void the transaction?”.

By choosing “yes” option will void the transaction successfully by displaying the message at the bottom of the screen as, “Transaction voided successfully”

To Refund the amount

 Click the “Refund” button on the payment line item and enter the Refund amount.

Click “Refund” button under the “payments and Refunds” tab.

Now the another line item of refunded amount with transaction id will be showed in the invoice payment line item.