Touch > Tools > Basic Tools > Terminal Settings > Interface List

 

Description

 

The Interface List option is used to Interface SwiftPOS with Third Party Software.

 

To Be Considered

 

1. Note : The number of Interfaces added CANNOT exceed one Third Party Tab and one Value Added Service.
2. SwiftPOS is ePAY certified.
3. SwiftPOS also supports Blackhawk.

 

---

POS Interfaces

 

 

This screen is accessed from here.

 

• Add New - Select to open the Add New Interface screen and select from the drop down list one of the following:
   
• Loyalty System
• Reservations System
• Sales Export
• Tab System
• Value Added Service
• Web Server

• Edit - Select to edit the selected interface 
• Remove - Select to remove the selected Interface. When selected the following prompt will be displayed to ensure the mandatory entry of the Daily Code:
   

 

---

Loyalty System

 

 

This screen is accessed from here and here.

 

• Loyalty System - Select from the drop down list one of the following:
   

 

WorldSmart Smart Retail Settings

 

These are as per the screen above.

 

• Link Media - Add Links for the Worldsmart Media Types to link to the Media Types in SwiftPOS Back Office.  If a media other than these is used, it will default to Cash.

 

ThorLink Settings

 

 

This screen is accessed from here.

 

Order WebHooks Settings

 

 

This screen is accessed from here.

 

Talkbox Settings

 

 

This screen is accessed from here.  For more information ...

 

3rd Party Vouchers Settings

 

 

This screen is accessed from here.

 

Third Party Voucher Loyalty Redemption (API)

 

Ticket 19580.

SwiftPOS Voucher API that will allow 3rd party Voucher systems to integrate with SwiftPOS. You can view the API with the following details:

 

url: http://webstores.swiftpos.com.au:8010
username: vouchers
password: swiftpos

To setup this feature you will need to create a loyalty interface in SwiftPOS Touch, as per the screenshot above.

 

Now you will need to print some Barcodes that follow the following format.  The test API echoes back certain details contained within the Barcode so that the API doesn't have to hold any state and works for everyone's SwiftPOS Vouchers:

All Voucher Barcodes used for testing should be exactly 10 digits in length
1.  The first 2 digits are used for masking.  I use 99.
2.  The next 3 digits determine the SwiftPOS Voucher to map to.
3.  The next 1 digit determines if the Voucher from/to dates should be valid (1 = Valid, 0 = Invalid).
4.  The next 1 digit determines if the Voucher has already been used or not (1 = Used, 0 = Not Used).
5.  The next 3 digits determine the 3rd party Voucher ID (I use 001 most of the time).

Example 1 (valid, unused Voucher mapped to Voucher ID 17 in SwiftPOS): https://voucher.com/9901710001

Example 2 (valid, already used Voucher mapped to Voucher ID 9 in SwiftPOS): https://voucher.com/9900911001

The Company Name at the beginning would also form part of the masking in SwiftPOS.

 

Please note that the above details are used for testing the integration internally only.  This has absolutely nothing to do with how the API will function when implemented by a 3rd party.  You will need to make up some Barcodes that work with your back office database's Vouchers and print them out.

Next setup a Barcode scanner with a card mask as per the following screenshot:
 

 

Assuming that you've already setup some Vouchers you should now be able to start testing them.  You should have printed enough different combinations of Barcodes that you can test for the various outcomes such as successful redemption, invalid from/to dates, incorrect Voucher ID, already used, etc.

 

Thirsty Camel Hump Club (TCHC)

 

 

This screen is accessed from here.  For more information ... Use the Card Mask Entry (#901) POS Key to enable the entry/scanning of a TCHC Account.

 

NSW Stimulus Vouchers

 

 

This screen is accessed from here.

 

• Business ID - Enter the Business ID provided by the NSW Government once a Site/Venue has registered to participate in the NSW Stimulus Voucher program. For How To information and NSW Government information.
   

 

---

Reservations System

 

 

This screen is accessed from here.

 

• Reservation System - Select from the drop down list:
   
• 02 - ResDiary - Select to open and edit the settings. For more information ...

 

---

Sales Export

 

 

This screen is accessed from here. Configure the settings with the appropriate details provided.

 

• Type - Select from the drop down list:
   
• CDC - Select to open and configure the DXC settings screen to interface with CDC \ DSS \ DXC Product Blocking at POS.
• RIP Global - Select to open and configure the RIP Global settings screen to interface with the RIP Global App.
• SLYP - Select to configure the Slyp Interface settings.

 

DXC Settings

 

 

This screen is accessed from here. Used to configure the settings required, to transmit CDC related Sales data via an authenticated API to the DSS Central Platform, with the appropriate details provided.

 

Credentials entered above can be generated via the PLB Portal. These will need to be configured in every Location Master POS Terminal at the venue where the cards are going to be used.  Note : Credentials will expire after 12 months.

 

Noteworthy

 

• Reporting Enabled - Ensure this option is selected. Once enabled transactions relating to CDC cards will be sent to the host server.
• Product Level Blocking - Ensure this option is selected.
• API URL - Ensure this is set to https://centralplatform.plbpos.com/api/transactions.
• Card Prefixes - Displays/Enter the prefixes of the CDC issued cards. These are to be entered in a CSV format. For example: 438875, 50773899

 

For more information ...

 

RIP Global Settings

 

 

This screen is accessed from here. Configure the settings with the appropriate credentials provided by RIP Global.

 

Noteworthy

 

• Merchant Name - Displays/Set the name of the Merchant. The value entered here is discretionary, however it is recommended to enter the SwiftPOS site's business name. Note : This will assist Customers viewing their RIP Global Transactions to easily identify from where the Transaction originated.
• Currency Code - Displays/Set the Currency Code. Currently the only supported (by RIP Global) currency is NZD.
• RIP PLU : Displays/Set the PLU of the configured string PLU required. When specified here it will be included in sales that have had a RIP Global Card Mask match. Once included the sale will be considered a candidate for exporting to RIP Global. Note : Any sale that does not include this PLU will not be exported to RIP Global. 

 

For more information ...

 

 

SLYP Interface Settings

 

* Denotes fields are mandatory

 

This screen is accessed from here.

 

Noteworthy

 

• General - Enter the details provided by SLYP (in MySlyp website).
• Address - Enter the Address details for the Store
• Contact - Enter the Contact Details for the Store
• Opening Hours - Enter the Opening Hours for the Store
• Store Description - Description of the Store.

 

Operation

 

1. Transactions need to be paid by card in some way.
2. The data is passed on to Slyp. 
3. SLYP coordinate with the banks on their end (At the moment they may only be working with NAB?)
4. The receipt is passed to the customer via the bank, i.e. via the banking app.
5. If Customers use Tyro Pay@Table, and they all pay say $50 each, it only gives them the option to all make payments towards the balance. There is no option to split the bill. Even if they have paid in full, you still have to go back to the POS Terminal to close the table.
6. At this point in time we would have all the card numbers that were used in the sale and send that to Slyp.

 

Example of a SLYP receipt

 

 

---

Tab System

 

Note : Tables can NOT be finalised to Third Party Tabs.

 

• Tab System - Select from the drop down list one of the following:
   

 

OneTab Settings

 

 

This screen is accessed from here.

 

• Merchant ID - Enter your Merchant ID as provided by OneTab.
   
• System URL - Not Used
   
• Username - Not Used
   
• Password - Not Used
   
• Poll (secs) - Recommended to set to between 15 & 30 seconds depending on network and internet speed.
   
• Media ID - Displays/Enter the default Media Type ID to be used to process the payment in the SwiftPOS Back Office.
   
• Tab Master - Displays/Enter the Terminal ID of the Table Tracking Master Terminal.

 

Clipp Settings

 

 

• Merchant ID - Not Used
   
• System URL - This needs to be the location of the Clipp adapter service. Usually http://localhost:8081
   
• Username - CLIPP
   
• Password - Password comes from the Adapter Key in the Clipp pos adapter. This is a 10 digit alphanumeric key
   
• Poll (secs) - Recommended to set to 1 second.
   
• Media ID - Displays/Enter the default Media Type ID to be used to process the payment in the SwiftPOS Back Office.
   
• Tab Master - Displays/Enter the Terminal ID of the Table Tracking Master Terminal.

 

---

Value Added Service

 

• VAS Type - Select from the drop down list one of the following:
   

 

PcTouch Settings

 

 

This screen is accessed from here. For Setup/Operation information click here.

 

ePAY Settings

 

 

This screen is accessed from here. For Setup/Operation information click here.

 

• Primary URL - Displays/Enter the URL Link provided. If XML is being used, use the following:
   
• For single sites - https://serv001.au.epayworldwide.com:40075
• For multi sites - https://serv001m.au.epayworldwide.com:40075
   
• Backup URL - Displays/Enter the backup URL Link. If XML is being used, use the following:
   
• https://serv002.au.epayworldwide.com:40075

 

Cullinan Settings

 

 

This screen is accessed from here. For Setup/Operation information click here.

 

• Primary URL - Displays/Enter the URL Link provided.
   
• Shop ID - Displays/Enter the Shop ID provided.
   
• Terminal ID - Displays/Enter the Terminal ID provided.
   
• Additional Settings - Select to open the Additional Settings screen.
   
• MoneyGram Codes
   
• Send Product Code - Displays/Enter the Send Product Code provided.
• Receive Product Code - Displays/Enter the Receive Product Code provided.
• Refund Product Code - Displays/Enter the Refund Product Code provided.
   
• Third Party Settings
   
• Product Code Length - Select from the drop down list the length of the Product Code as required by Cullinan.

 

Note :  The following POS Keys will need to be added to the appropriate Keyboard Layout using the Keyboard Designer in the SwiftPOS Back Office:

1. For MoneyGram - VAS Money Transfer (#162) POS Key.
2. For Third Party Products (for example, Trailer Hire) - VAS Products (#160) POS Key.

 

Metcash Settings

 

 

This screen is accessed from here and is used to set the Media for Metcash Gift Cards and EFTPOS. For more information ...

 

---

Web Server

 

 

This screen is accessed from here and here and is used to configure the settings required for the Web Server.

 

• Server Type - Select from the drop down list one of the following:

 

• POS API - Select to ensure the POS API is used. The POS API is used to ensure OrderAway Waiter sends/retrieves orders/sales to/from the SwiftPOS Touch Terminal.  Note : This Interface along with an entry for the Gateway Client Service will be automatically added if they do not exist when the OrderAway Location (this SwiftPOS Touch Terminal is in) is Activated.
   
• Port - Defaults to 33300. Note : If the default value is changed then consideration will need to be given to the fact that the new value entered here will also have to be reflected in the setting RestfullSwiftPOSAdaptor-TwaBaseUrl configured in Venue Manager's > Connect > Adaptor Settings.
• Return Receipt Text - Select to ensure that the SwiftPOS Touch Receipt information (at the time an OrderAway Waiter order/sale is finalised in OrderAway Waiter) is returned in a text form.
• Return Receipt Image - Select to ensure that the SwiftPOS Touch Receipt information (at the time an OrderAway Waiter order/sale is finalised in OrderAway Waiter) is returned in the form of an image file.
• Open Port for All Users - Select to ensure that all users regardless of their authorisation level (Admin rights) can run the selected Server Type. In this case POS API. By adding this option it ensures Apps are running with the highest authorisation level if required. For example, POS API requires Admin level authorisation, then make sure the required windows users are placed in the Administrative group. Application titles will append (Administrator) to the end to indicate the mode.
• URLs - Displays the URLs that need to be provided to the Client/Provider when configuring a new Web Server. Note : These will automatically be populated when the interface is added. Also, to confirm that a connection has been established with POS API, copy the first URL listed (for example, http://???:33300/touchapi/v1/diagnostic) into a browser and it should return diagnostic information such as: {"LocalDateTime":"2022-09-14T11:21:45.366073+10:00","Version":"10.21.58.43","Messages":["Primary Receipt Printer: Online","Kitchen Printer: Online","Order Printer: NotFound","KVS 1: Enabled","KVS 2: Disabled","KVS 9: Disabled","KVS 11: Disabled","KVS 12: Disabled","KVS 13: Disabled","NetPOS: Online"]}. If a This site can't be reached or Unable to connect or any other similar response is returned then there is an issue with the settings configured.

 

Note : Leaving the SwiftPOS Touch Terminal Settings screen open and NOT exiting it will generate an error in OrderAway Waiter.

 

---

Related Topics

 

1. POS Configuration Index
2. POS Operation
3. POS Operation Index
4. POS Touch Toolbar and Tools
5. Reseller Help - For Clipp Tab information
6. Terminal Settings

 

---