Oolio Pay
      Back to home
      1. swiftpos Help Guides
      2. Oolio Pay

      How To

      Oolio Pay

      This outlines the information and steps that are needed to familiarise oneself with, before and during the implementation of Oolio Pay at a swiftpos Venue using anyone of our recommended payment providers Adyen and Wpay.

      The content is targeted at Resellers and swiftpos Venue Administrators who have a sound knowledge of and experience with swiftpos. For further information or assistance, please contact your swiftpos Reseller or swiftpos Support.

       

      How To?      ▼

       

      Apply A Surcharge?      ▲ ▼

      How To?      ▲ ▼

      To configure Oolio Pay for Surcharges in TouchMini, do as follows:

      • In swiftpos BEFORE Adyen enables Surcharges
        • Ensure a pre-defined swiftpos Surcharge has been created. It must be configured as follows:
          • Give the Surcharge being configured and appropriate Name.
          • Ensure an Assigned PLU has been set in order to capture the Surcharge value being applied.
          • It must be Enabled and Web Enabled.
          • It must have an End date that ensures it is valid for sometime to come (like always).
          • The Auto Apply option must NOT be selected. This is because Adyen will determine if it is applied.
          • Also, a value or percentage must NOT be set. This is because Adyen's configuration will determine this.

       

      An example of a pre-defined Surcharge

      • Once the above has been completed, ensure Adyen enables Surcharging.

      What Are The Limitations?      ▲ ▼

      • The Surcharge is applied to ALL Items in the Order/Sale (irrespective of individual Items having Surcharges or Discounts applied to them). However, this means that when the Order/Sale is processed via the:
        • POS API (Recommended and used when the Submit orders directly to POS Terminal option is selected when a Location is activated) - When the Order/Sale is processed, the Surcharge amount returned by Adyen will be:
          • Distributed across all Items in the Order/Sale (with the exclusion of Item's (for example, String PLUs) with a zero value). The portion of the Surcharge amount allocated to each item will be based on each Item's sale value. Any rounding resulting from the distribution of the Surcharge will be added to the first Item's value in the Order/Sale. That is, the first Item being the first Item in the Order/Sale having a value greater than zero.
          • Appended to the Order/Sale and assigned to the configured Assigned PLU.

       

      Notes ...


      The distribution of the Surcharge amount across all Items is done to ensure Surcharge reporting can be done down to Product level. This however does NOT impact on Product revenue reporting or exports to exporting to 3rd Party Accounting applications, as the Assigned PLU still retains the Surcharge amount.

       

      Notes ...


      Using the Back Office API the Surcharge amount will NOT be distributed across all Items in the Order/Sale. This means Surcharge reporting down to Product level WILL NOT be supported. Only Surcharge revenue reporting and the exporting of that to 3rd Party Accounting applications is supported.

      • The Surcharge amount appearing on a Tax Invoice (receipt) as printed from the Oolio Pay (Adyen) device will be identifiable by the Payment Surcharge entry.

       

      • The Surcharge amount appearing in the Search Transactions screen in Back Office will be identifiable by the Name associated with the pre-defined swiftpos Surcharge identified by the Surcharge ID value in the Payments tab Surcharge ID value configured in the Payments tab. on a Tax Invoice (receipt) as printed from the Oolio Pay (Adyen) device and labelled Payment Surcharge.

       

      What Is Required?      ▲ ▼

      • TouchMini v2.23+ and swiftpos v10.60-1+

      What Is Supported?      ▲ ▼

      Provides an overview of what is supported in TouchMini when using an Oolio Pay (Adyen) device.

      • The ability to apply Surcharges to a transaction based on the card presented by a patron when paying for an Order/Sale.
      • The Surcharge is calculated based on the sum of the Order/Sale Total and any Tips.
      • The following parameters can be set to determine when a Surcharge should be applied. The implementation team should be collating this information from the Venue and passing it to the Oolio Pay team to configure:
        • Level - What level should the Surcharge configuration be applied too? Options are:
          • Company Level (all merchants, stores and terminals under the company ID specified it should apply too)
          • Merchant Level (all stores and terminals under the merchant ID specified it should apply too).
          • Store Level (all terminals under the Store ID specified it should apply too).
          • Terminal Level (the Terminal ID specified it should apply too).
        • Ask for Confirmation (True or False)
          • True - This will ensure patrons are prompted to confirm the Surcharge being applied to their Order/Sale. The confirmation is presented on the PIN Pad.
          • False - This will ensure the Surcharge is applied without patron prompting and will show them the new total after presenting their card.
        • Single Tap (True or False)
          • True - This will ensure that when a patron taps their card to pay (as opposed to insert or swipe), they WILL NOT have to tap their card a second time after confirming the application of the Surcharge.
          • If False - This will ensure that when a patron taps their card to pay (as opposed to insert or swipe), they WILL have to tap their card a second time after confirming the application of the Surcharge.
      • Configuration Matrix - This is a matrix which can assist when implementing and configuring Oolio Pay for Adyen devices, and can be provided on how to apply Surcharges. Refer to the matrix options table below.

      Configuration Matrix Brand

      Brand

      Sources

      Currencies

      %

      Amount
      What brands of cards do you want the Surcharge to apply too? Common ones include:
      • Mastercard
      • Visa
      • American Express
      • Diners
      • JCB
      • EFTPOS (AU)
      		 You can optionally define whether it applies to Credit and/or Debit variants of the brands. For example, EFTPOS (AU) may only want to be applied to Credit Card transactions, and NOT Debit Card transactions.
      If left blank, it will be applied to both Credit Card and Debit Card transactions.      		 Advise what currencies that the Surcharge should be applied to. The currency is passed into each transaction request made by TouchMini. Common ones include:
      • AUD = Australian Dollar =
      • NZD – New Zealand Dollar
      • GBP – UK Pound Sterling
      • USD – US Dollar
      • EUR – Euro

      Optionally advise what percentage of Surcharge should be applied to a transaction. For example, for a 2 percent Surcharge, set as 2%.

      This works in conjunction with the Amount column.

      Optionally advise what amount of Surcharge should be applied to a transaction.

      This is defined in micro values. So for currencies which have decimals, this has to be taken into account. For example, if a $0.10 Surcharge amount is required, then this needs to be set as 10.

      This works in conjunction with the % column and is added to any percentage calculated.

       

      Brand Sources Currencies % Amount
      Master Card   AUD 2% 10
      Visa   AUD 2% 10
      EFTPOS (AU)   AUD 2% 10
      AMEX   AUD 2% 10
      Diners   AUD 2% 10

      • Once configured, an example of how this looks to the patron on the PIN Pad can be found here: Surcharge | Adyen Docs

      When Is It Used?      ▲ ▼

      When a Venue has the requirement to pass on a business cost as a Surcharge at the time a patron makes a payment for an Order/Sale. Refer to Surcharge for more information.

       

      Configure For Tipping?      ▲ ▼

      How To?      ▲ ▼

      To configure Oolio Pay for tipping, do as follows:

       

      When Is It Used?      ▲ ▼

      When a Venue has the requirement to provide patrons with the opportunity to enter a Gratuity/Tip for a service received. Refer to Tipping for more information.

       

      How To GET STARTED?      ▲ ▼

      Oolio Pay can be implemented at a Venue using devices provided by:


       

      Adyen      ▲ ▼

      What Is Required?      ▲ ▼

      • Obtain a swiftpos licence for TouchMini.
      • Obtain a device that supports Adyen. Refer to HERE for more information.
      • Connection to Adyen via Touch makes use of the Touch EFT42 - Oolio Pay Peripheral and will require an API Key to be provided by Oolio Pay in order to complete it's configuration.
      • Contact the Oolio Pay Know Your Customer team (KYC) and:
        • Request the creation of an e-commerce merchant account. This account will be used for online ordering and online (cardless) transactions.
        • They can also add Google and Apple Pay as payment methods.
        • Once the account has been created, Oolio Pay will need to provide the Venue with the following information in order for it's Payment settings in OrderAway’s Payments menu to be configured in Venue Manager:
          • Merchant Account
          • Store
          • Client
          • API Key
      • In Back Office

       

      How To Configure Touch?      ▲ ▼

      Touch will need to be configured to ensure it can interface with Adyen. To do this, do as follows:

      • Windows Administrator rights will be needed to compete installation on Touch terminals.
      • Optionally configure a Windows inbound firewall rule to allow incoming traffic via the TCP Port 31100 (or an alternate Port of your choosing). This will ensure messages displayed on device PIN Pads during a transaction can also be displayed in Touch for the Clerk/Staff Member to see.
      • Install the certificate Adyen provide into the Trusted Root Certification Authorities > Certificates folder via the Microsoft Common Console Document. Instructions on this process can be found HERE. For:
      • The network to which the Touch terminals & device PIN Pads are connected to, needs to have an internet connection to the following endpoints:
        • *.adyen.com via HTTPS.
        • *.adyenpayments.com via HTTPS.

       

      Notes ...


      Symantec Endpoint Protection does not support Windows internet
      sharing. This issue may also be present in other Endpoint protection software.

      • Restart the Touch terminals & device PIN Pads after installation of the certificate.

       

      Notes ...


      Refer to original documentation for more information.

       

      Touch EFTPOS Peripheral Setup

       

      How To Configure The P400 Plus PIN Pad?      ▲ ▼

      The PIN Pad should come online automatically. This can be confirmed with the display of a cloud symbol in the top left corner of the screen. If not, confirm the PIN Pad configuration as follows:

      • On the P400Plus PIN Pad, press 9 and the green button to get to the admin menu (passcodes found on the Adyen customer portal under point of sale > terminal settings > passcodes)
      • Go to Network > USB ethernet and check the settings there:
        • IP address = 192.168.137.2
        • Subnet mask = 255.255.255.0
        • Router = 192.168.137.1
        • D.N.S preferred and alternate as above
      • Now return to the home screen and confirm there is a cloud symbol displayed in the top left corner of the screen.

        

      How To Configure The P400 Plus PIN Pad (Ethernet Or Wi-Fi)?      ▲ ▼

      This type of PIN Pad connects to Touch Terminals either via an Ethernet connection or via Wi-Fi.

      All that is required for connection, is the following:

      • The installation of the Adyen provided certificate. Refer HERE for more information.
      • The Touch terminals need to be on the same local area network that the device PIN Pads are connected too. That is, one should be able to successfully ping the device PIN Pads from the Touch terminals.

       

      Noteworthy

      On the device:

      • To force an update, select 9 then Enter. Select Config, enter the passcode, select Check for Updates.
      • To view a list of Transactions, select 8 then Enter.

       

      Other Topics 

       

      How To Configure An Android PIN Pad device?      ▲ ▼

      This type of PIN Pad connects to Touch Terminals via Wi-Fi.

      All that is required for connection, is the following:

      • The installation of the Adyen provided certificate. Refer HERE for more information.
      • The Touch terminals need to be on the same local area network that the device PIN Pads are connected too. That is, one should be able to successfully ping the device PIN Pads from the Touch terminals.

       

      Other Topics

       

      How To Configure OrderAway?      ▲ ▼

      To configure OrderAway for Oolio Pay Adyen, do as follows:

       

      How To Onboard An Adyen Device For TouchMini?      ▲ ▼

      What Is Required?      ▲ ▼

      Venues will need to do the following:

      • Contact the Oolio Pay Know Your Customer team (KYC) and:
        • Request the creation of an e-commerce merchant account. This account will be used for online ordering and online (card not present) transactions.
        • They can also add Google and Apple Pay as payment methods.
        • Once the account has been created, Oolio Pay will need to provide the Venue with the following information:
          • Merchant Account
          • Store
          • Client
          • API Key
      • Configure OrderAway:
        • Locate and access OrderAway's Payments menu.
        • Select Oolio Pay from the drop-down list at the top of the screen.
        • In the General tab enter the details provided by Oolio Pay (outlined above) in the corresponding fields.

       

      • In the Portal tab based on the Venue's requirements:
        • Enable each option under Notify Venue for heading.
        • Enable each option under Notify Member for heading.

       

      • In the OrderAway Web tab based on the Venue's requirements:
        • Enable each option under Notify Venue for heading.
        • Enable each option under Notify Member for heading.

       

      How To?      ▲ ▼ 

      • Unbox the device.
      • When connecting to the Venue's Wi-Fi Network, the devices must be able to communicate outbound to the following endpoints:
      • Install the TouchMini app. To be continued ...
      • Once installed the TouchMini icon should appear on the home screen.

       

      • Launch the TouchMini App
        • From the Home screen, select the TouchMini app to launch it.
        • Once opened the TouchMini logo and App version should be visible.
        • Wait a few seconds and the App Settings screen will be displayed.

       


      • Launch the TouchMini App continued ...
        • Confirm the TouchMini URL is set to the correct URL based on the Venue's region. Namely:
        • Enter the Cloud Client ID associated with the Location in which the device is going to be used.
        • Select SAVE to save any changes.
        • The device will automatically attempt to register itself using the Cloud Client ID entered. The device registration process will need to be completed before continuing. The process is similar to the PAX device. Refer to How To Onboard A PAX Device for more information.
      • If the device is being onboarded for the first time, then selecting the HOME button on the device after the above has been saved and completed. This will ensure the devices' configuration is retrieved and applied.

       

      Notes ...


      If any further changes are made to the device's configuration, then the device's cache will need to be cleared. To do this, go to Settings > Clear Cache. Then clos the app and re-launch it, so the most recent configuration settings are retrieved.

       

       What To Consider?      ▲ ▼ 

      • When a card payment is being taken on an Oolio Pay device, TouchMini will determine the Merchant Reference based on the to be the Cloud Client ID and the Order number, in the format XXXXXXXXX_YYYYY, where:
      • TouchMini will display a loading indicator if an action (like clicking a button) takes longer than 200ms to perform. From experience, the Adyen S1F2 device, when set to:
        • Mobile Data (Cellular), displays a loading indicator each time a menu button is selected or a Product is added to an Order.
        • Wi-Fi, hardly ever displays a loading indicator each time a menu button is selected or a Product is added to an Order.
      • EFTPOS Merchant Receipts and Customer/Cardholder Receipts can be configured by the Oolio Pay KYC team to suit Venue requirements. It can be done at the Merchant, Store or Terminal level. A suggested configuration to request would be:
        • Print a Merchant Receipt only if the payment is unsuccessful (so not for success or cancelled payments) and prompt to print a Customer/Cardholder receipt always (Prompting is only possible for Customer/Cardholder receipts).
      • Oolio pay and S1F2 can do offline sales, it is known as Store and Forward (SAF) functionality. Refer to Oolio's support document Store and Forward (SAF) Functionality for more information.

       

      How To Start Using For The First Time?      ▲ ▼

      The following is an example when using Oolio Pay with Adyen in OrderAway:

      • Place an Order/Sale.
      • Proceed to Checkout.
      • Select the Oolio Pay option.
      • Enter the card credentials.
      • Submit the Order/Sale by selecting the Place Order option.

       

      The Patron's Experience      ▲ ▼

      Previously when using other payment providers, patrons were required to select Proceed to Payment in the Checkout step. This is not the case when using Oolio Pay. Oolio Pay enables patrons to enter in their card credentials while still in Checkout.

      Once Oolio Pay has been configured and enabled, at checkout, patrons will be provided with the opportunity to enter their card credentials when the Oolio Pay option is selected.

       

       

      Wpay      ▲ ▼

       

      What Is Required?      ▲ ▼

      • Obtain a device that supports Wpay. Refer to What Is Supported for more information.
      • Connection to Wpay makes use of the Touch EFT33 - Linkly (Food and Bev) Peripheral, and can be established in either of the following ways:
        • Via the Cloud. To do this:
          • Ensure a Username and Password is obtained from Wpay, and that the device is Paired.
        • Locally using the Linkly Client. To do this:
          • Ensure the Linkly Client is installed at each Touch terminal and configured appropriately (specifically the IP address entered must match with that of the PC hosting Touch).
            • Surcharges are configured in Wpay and sent to the PIN Pads via a firmware update. Also, one needs to ensure the Linkly Client is installed and configured the same (that is, regarding Surcharges) on each Touch terminal. If Surcharges are set in the Linkly Client, this will override what is configured in Wpay.
          • Also ensure (if available), the Cloud Connection option is disabled on the device.
      • Consult the setup guides specific to the type of PIN Pad device to be used to ascertain how to configure them.

       

      What To Consider?      ▲ ▼

      • Switching from integrating with a Bank using Linkly, to Oolio Pay using Wpay, then here is what you need to know:
        • On-premise Linkly EFT Server(s) are NOT required. PIN Pads communicate outbound directly with Wpay.
        • If the Venue's current Bank integration uses the EFT14 - PC-EFTPOS Peripheral in Touch, then this will need to be switched to use the EFT33 - Linkly (Food and Bev) Peripheral instead. This will result in the following changes:
          • MOTO (card not present) transactions are supported via Mail Order.
          • Bar TAB Pre-approvals - are NOT supported as the EFT33 - Linkly (Food and Bev) Peripheral no longer supports this.
          • Surcharges configured within the EFT14 - PC-EFTPOS Peripheral (and sent to Linkly via the PIN Pad) are not supported. Surcharges are configured in Wpay.
        • PIN Pads (such as the Verifone v400M) connected previously via a USB connection or Serial port, can now be connected to the Venue's Wi-Fi network and subsequently to Touch terminals using the IP address of the Touch terminals.
        • Support for USB connected PIN Pads still to be confirmed.
        • Card Numbers are not retuurned by Wpay, thus making it impossible to search for Transaction in Back Office using the Card Number (as the String field in the search).
        • Surcharges are configured in Wpay and sent to the PIN Pads via a firmware update. Also, one needs to ensure the Linkly Client is installed and configured the same (that is, regarding Surcharges) on each Touch terminal. If Surcharges are set in the Linkly Client, this will override what is configured in Wpay.

       

      • When connecting via the Cloud:
        • Integrated Card Surcharging is managed in Wpay.
        • Manual Surcharging is managed in Wpay.
        • Tips are enabled in swiftpos and managed in Wpay.
        • Pre-authorisation is NOT supported.
        • Cash out is currently NOT supported.
      • When connecting Locally via the Linkly Client:
        • By default, Integrated Card Surcharging is managed in Wpay, unless it is configured in the Linkly Client.
        • Manual Surcharging is managed in Wpay.
        • Tips are enabled in swiftpos, defaults are managed in the Linky Client or Wpay.
        • Pre-authorisation is NOT supported.
        • Cash out is currently NOT supported.

       

      How To Configure Touch?      ▲ ▼

      Touch will need to be configured to ensure it can interface with Wpay. To do this, do as follows:

      • Add the EFT33 - Linkly (Food and Bev) type EFTPOS Peripheral. Refer to How To Add An EFTPOS Peripheral for more information.
        • Enter Oolio Pay Wpay in the Description field for the new Peripheral.
      • Once added and the EFTPOS screen is redisplayed, select the Configuration button to open the Oolio Pay Settings screen and configure required. Refer HERE for more information.
      • Using the PC-EFTPOS TCP Settings screen, connection to a Wpay supported device, can be established in either of the following ways:
        • Via the Cloud.
          Do as follows:
          • Enter the Cloud URL obtained from Linkly into the TCP Hostname field. For example, pos.cloud.pceftpos.com.
          • Enter 443 into the TCP Port field. This is the default port.
          • Select the Cloud option from the Connection options available.
          • Enter the Username and Password provided by Wpay.
          • Save the changes and restart Touch.
          • Obtain the Pairing Code from the PIN Pad Device and enter it into the Pairing Code field. Refer HERE for more information.
          • Select the refresh button to retrieve and display the Secret.
          • Configure the Printer settings as required.
          • Select OK to save the changes and exit the PC-EFTPOS TCP Settings screen.
        • Locally using the Linkly Client, do as follows:
          This DOES require the Linkly EFT Client to be installed at Touch. Do as follows:
          • Enter the IP address of the PC hosting Touch into the TCP Hostname field.
          • Enter 2011 into the TCP Port field. This is the default port.
          • Select the Local option from the Connection options available.
          • Configure the Printer settings as required.
          • Select OK to save the changes and exit the PC-EFTPOS TCP Settings screen.

       

      How To Configure A Wpay Supported Device?      ▲ ▼

      When connecting:

      • Via the Cloud, do as follows:
      • Ensure Cloud connection is enabled. Refer to the information specific to the device being used, to ascertain how this is achieved.
      • Ensure a Pairing Code is retrieved in order to complete configuration of Touch for Cloud connection. Refer to information specific to the device being used, to ascertain how this is achieved. Refer to the How To Configure Touch for more information.

       

      How To Start Using For The First Time?      ▲ ▼

      To be continued ...

      End of article.      ▲