17.11. Opayo VSP Form
Opayo (formerly called 'Sagepay') is one of the most popular credit card payment providers in the UK.
VSP Form is a remote-type payment system, where customers are sent to a secure page on Opayo's servers to conduct the card transaction.
The system is simple to set up, but is unusual compared to most remote type payment systems in that the 'callback' (relaying information on a successful payment back to the store) is achieved by redirecting the user's browser back to the store. Most payment systems make the callback themselves (their server calls the store's callback page directly), even if they subsequently send the user back to the store after payment. In theory, payments might not be notified back to your store if a user closes their browser immediately after the payment was made, but in practice, we rarely see this and the system seems stable and reliable.
17.11.1. Setup within Kartris
- Go to Configuration > Payment and Shipping Gateways and click to edit SagePay VSP Form.
- For the 'friendly name', enter the name you want this payment system to be referred to on the front of your site where customers select it, for example 'Pay by credit card with SagePay'.
- Change the status from 'OFF' to 'ON' (for live orders) or 'TEST' or 'FAKE' for testing. 'TEST' means that a test order will be passed, allowing you to test the full integration and pass multiple orders and no cost without needed to do refunds. 'FAKE' means that Kartris will skip the Opayo payment process and instead format a post back itself to the callback page of Kartris. This is useful for testing that the callback process works, triggers the appropriate emails and so on without keep having to keep going through the Opayo test payment process.
- ProcessCurrency - if your store supports some currencies that your Opayo account cannot process, you should set this with a three-letter ISO code to convert all orders to this currency prior to sending users to the payment pages.
- Test URL - (for test orders) should be:
https://sandbox.opayo.eu.elavon.com/gateway/service/vspform-register.vsp - Post URL - (for live orders) should be:
https://live.opayo.eu.elavon.com/gateway/service/vspform-register.vsp - VSPProtocol - Opayo uses a versioning system so that when a newer version of their system is introduced, you can continue to process orders with the older version (at least for some period). The Kartris Opayo support is designed for 'Protocol 3.00', so you should not change this number unless your Kartris payment system is upgraded at some point in the future.
- The other various Opayo settings required should be supplied to you by Opayo.
17.11.2. Setup within Opayo
All the required information to process an order and direct the callback back to your store is actually posted through to Opayo with the order, so no further setup is required at their end. However, you should ensure with Opayo's support that your account is live before you start processing orders.
17.11.3. Common issues
17.11.3.1. The VendorTxCode has been used before
Orders passed through your Opayo account must have unique IDs. If you experience this error when trying to checkout, it means the order ID that is being passed has been used before on your account. This can happen if you've switched to Kartris from another store system, so IDs are starting from a low level. It can also happen if you restored a older backup of your Kartris database for some reason.