BookmarkBookmark this page!
Jun 15, 2023
Opayo Integration

Opayo Integration

Syrinx users now have the ability to manually take payments via the web using Opayo (formerly SagePay) or via handheld Pin Entry Devices (PEDs) provided by Opayo.  Tokenisation has also been introduced meaning that references to card details previously provided to Opayo via a web payment or card machine can be used for future payments without the need to re-enter card details.

Note: Due to recent changes in SCA requirements, the card issuing bank may refuse tokenised payments unless the original payment was taken via a pin entry device.

Opayo Web Payment Setup

The setup of POS/Web payments can be found on the “POS / Web Payments” tab of Syrinx Configuration\System Options\Accounts:

Note: the “POS / Web Payments” tab where web connection settings are entered can only be unlocked via a patch and will be hidden by default

Save Card Details

Enables Tokenisation in the system and must be set to save customer card details in the system.  Unchecking this box once it has been enabled will require the user to delete all customer cards that have been saved in the system.

Req. CVC Check

This will enable the CVC check on any token (auto) payments.

Vendor Name

This will be supplied by Opayo when an account is opened with them.

Integration Key

This will be supplied by Opayo when an account is opened with them.

Integration Password

This will be supplied by Opayo when an account is opened with them.

Default Currency Code

This will be used when multi-currency is not set-up and will be used for all payments, otherwise the customer’s currency code will be used to make the transaction.

Default Country Code

This is required to pass to the Opayo Router and the Default Country Code will be sent over to Opayo if countries are not set up in Syrinx - otherwise it will pick it up from the Site Address that is linked to the contact on the customer.

Opayo Card Machine Setup

All card machines that will be used by Syrinx need to be set up within the Syrinx Configuration program.  There is a new menu option on the “General” tab called “Card Machines” for entering this information:

From this screen, users can see the current card machines that have been set up in the system and add new entries or amend the details of existing entries.  Card Machines must be set to current to be used within Syrinx.

Adding a new card machine or editing a card machine allows the user to amend the following properties:

image.png

Name

This must be unique across all card machines entered.

IP Address

The IP Address of the device – this can be found via the device once it is connected to a WiFi network

Port

The port that this device is going to use to communicate on the network.  By default this should be set to 3333 – this has been exposed in case this ever needs to be changed.

Serial No

This is not mandatory but is a unique identifier of a device and if set, will help the user identify the terminal when editing configuration entries in the future.

Depot

If multiple card machines are to be used across the system – this identifies which depot each card machine is located at 

Merchant ID

The Merchant ID is the company ID provided by Opayo and can be accessed via the PED terminal if not known at time of set-up.

Client ID

The Client ID is the terminal ID provided by Opayo and can be accessed via the PED terminal if not known at time of set-up.

Password

This password is provided by Opayo and allows the card machine to make use of saved card details to take payments via tokenisation.  This is not required if you will not be saving card details.

 

Note: An existing card machine will need to be made non-current before the above details can be edited and then made current again when complete..

Terminal Set-Up

The terminal that Opayo provides needs to be setup on Wi-Fi before it can be used.  The place to do this can be found in Management\Settings\IP Menu\WiFi Setup:

image.png

The Merchant ID, Client ID and Serial Number of the machine can be identified by printing out the terminal info.  To get to the terminal info, the user can go to Management\Help\Term Info.  In the below example the Client Id is referred to as the TID (Terminal ID) and the Merchant ID is the 8 digit number (MID):

The IP Address of a device can be found in Management\Settings\IP Menu\IP Address:

Additional Opayo Card Machine Setup

Opayo will get installed as part of Syrinx and a new sub-folder named “SagePay” will get installed C:\ProgramData\Higher Concept\SyrinxSP v4 within which resides a file nameed PRClientConfig.XML:

PRClientConfig is a file that holds various settings for the PED (card machine) and settings for it to connect to the Opayo PayRouter.  Anything that is exposed within Syrinx Config (such as IP Address/Merchant ID/Client ID) is ignored from the XML file when it is used in conjunction with Syrinx however the file is still used in terms of other configuration values such as Timeouts.  The end-user should not need to change any details here for the Opayo integration to work.  

Default Payment Method

There is a new user option on the “Misc” tab of Syrinx\User\User Options which allows the user to specify what their default type of payment will be. This requires at least one card machine or web payments to be set up:

Making a Payment

Card Machine Payments and Web payments can both be enabled together or on their own within Syrinx.  The following screenshots are based on them both being enabled at the same time.

Taking payment involves the user pressing the “POS / Web” button which can be found under the “Cash” and “Card” buttons on the payment screen:

The user will be presented with the following screen:

Here they will be able to specify the payment amount (in some scenarios, this will be disabled – such as refunding a previous transaction) and they will be able to select their payment method should it be different to the default set up in user options.

 

There are 3 options for taking a Opayo payment:

1. Swipe – only used for Card Machines – starts a swipe transaction (i.e. the customer is present and you want them to use their card).

Depending on which screen the user is in, the user will be asked a series of questions.    If the user is paying a deposit they may be asked if they are paying in full (if an amount is not entered prior to pressing the Card Machine button).

image.png

The user will also be asked whether the customer is present or not?  If the customer is not present, the card machine will expect the user to key in the details of the card the customer is wishing to use.

image.png

If the depot the user is logged into has multiple (current) card machines set up against it, the user will have to pick the card machine they want to use to take the transaction.

Communication will then start with the PED: 

image.png

If the payment is processed successfully on the card machine, the system will display “Authorised” and payment will have been processed and recorded in the Syrinx database:

If a transaction comes back with anything other than AUTHORISED money has not been taken from the card successfully. A common cause for this is the Syrinx PC not being able to communicate with the card machine:

image.png

If the user has set the system option to Save Card Details, an unique token is generated on transaction completion – they will be asked to provide an alias for this transaction:

image.png

2. Manual Payment – This will require the user to enter the details relating to the card (Name, Card Number, Expiry Date and CVC number).  This can be used for Card Machine/Web Payments, the only difference is that if the user has chosen to process through the Card Machine, the questions will be entered in on the Card Machine and they will also be asked for Address Details.  The web payment will ask for a contact/linked site instead: 

image.png

image.png

image.png

As before, if the user has set the system option to Save Card Details, an unique token is generated on transaction completion – they will be asked to provide an alias for this transaction:

image.png

3. Auto Payment (Token) – When a token exists in the system for a customer, pressing this button will give the user the opportunity to select a token to use for this transaction.  

It must be noted at this stage that Web Payment Tokens are completely separate to Card Machine Tokens which means that a web payment token cannot be used for a card machine transaction and vice versa.

image.png

When the user selects a token to use and depending on which type of token was selected, the transaction will do the following:

Card Machine: If System Option “Req. CVC Check?” is set, asks the user for the cards CVC number only.  Please note, this type of transaction is not possible to process through the physical card machine and therefore does not produce a receipt.

Web Payment:  First asks the user to confirm the contact, and if System Option “Req. CVC Check?” is set, asks the user for the cards CVC number only.

Refunds

When processing a refund over the web – firstly this can only be done if the original transaction you are refunding was processed as a web payment.  Because of this, the user does not need to enter any information  in when creating a web refund.  In this regards, it doesn’t matter if the user presses Auto/Manual because it is always automatic. Refunds done via the card machines follow the same process as card machine payments.



 
Was this article helpful?
Upload Files