Opayo M2 Installation Guide

Installation Guide

This guide is for installing Opayo Suite integration for Magento 2 which you can purchase HERE.
Please note that we highly recommend composer installation.

Please remember before performing an update/install to make a backup, execute the update/install in a secure/test environment, and put Magento into maintenance mode.

Composer Installation

    1. Run this command on Magento's root dir:
        composer config repositories.ebizmarts composer https://packages.ebizmarts.com

    2. Run this command on Magento's root dir. Contact us to get your access token.
        composer config http-basic.gitlab.ebizmarts.com token your_token

      composer config http-basic.sagepay.gitlab.ebizmarts.com token your_token

         composer config http-basic.brippo.gitlab.ebizmarts.com token your_token

    3. Run this command to get the module.
  If you're using Magento 2.1: composer require ebizmarts/sagepaysuite ^10.1
If you're using Magento 2.2: composer require ebizmarts/sagepaysuite ^10.2
If you're using Magento 2.3: composer require ebizmarts/sagepaysuite ^10.3

If you're using Magento 2.4: composer require ebizmarts/sagepaysuite ^10.4

Note: If is the first module you install via composer probably magento will also ask for Magento authentication keys. You can read how obtain your keys HERE.

If you are asked for username and password during the composer require procedure, use "token" as username and your_token as password.

4. Run this command to install the module

bin/magento setup:upgrade

   5. Finally you should re-compile your site after you install the module with the command:

bin/magento setup:di:compile

Token expired and causing problem when running composer update

    If your token expired and it's causing problems when you run composer update. You can renew your support to get a new token or simply run composer config --unset repositories.ebizmarts

Manual Installation

BEFORE INSTALLING MAKE SURE TO DELETE ANY PRE-EXISTENT SAGEPAYSUITE FOLDERS INSIDE THE APP/CODE/EBIZMARTS FOLDER

For all Magento Versions (2.1.x, 2.2.x, 2.3.x and 2.4.x):

    1. Upload the ZIP file to the Magento 2 server, we higly recommend create a TEMPORARY folder for this (out of $MAGENTO_FOLDER$).

    2. Get access to the Magento 2 server.

    3. Go to the TEMPORARY folder and uncompress Sage Pay Suite packages on the TEMPORARY folder created on the first step

            $ unzip /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.X.xx.zip

    4. Go to the Magento2 modules folder.

            $ cd $MAGENTO_FOLDER$/app/code

    5. Create the directory (if it does not exist) that will hold the module contents

            $ mkdir Ebizmarts

    6. Go to the magento root folder (where composer.json is located)

            $ cd $MAGENTO_FOLDER$

     7. Here you will need choose the version depending on your Magento version:

FOR MAGENTO 2.4.x:

             - If you are running Magento 2.4.4 or greater you will need copy the content from the folder 2.4.4 executing the following command:

                $ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.4.xx/2.4.4/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

             - If you are running Magento 2.4.3 or less you will need copy the content from the folder 2.4.3 executing the following command:

                $ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.4.xx/2.4.3/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

FOR MAGENTO 2.3.x:

- If you are running Magento 2.3.3 or greater you will need copy the content from the folder 2.3.3 executing the following command:

                $ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.3.xx/2.3.3/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

- If you are running Magento 2.3.2 or less you will need copy the content from the folder 2.3.2 executing the following command:

                $ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.3.xx/2.3.2/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

FOR MAGENTO 2.2.x:

Here you will need run the following command to copy the files:

$ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.2.xx/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

FOR MAGENTO 2.1.x:

Here you will need run the following command to copy the files:

$ cp -a /PATH/TEMPORARY/TO/PACKAGES/Ebizmarts_OpayoSuiteM2-1.1.xx/app/code/Ebizmarts/* $MAGENTO_FOLDER$/app/code/Ebizmarts/

    8. Run from command line: bin/magento setup:upgrade and bin/magento setup:di:compile. You should now be able to configure the module in the following location: STORES / Configuration / SALES / Payment Methods / Opayo Suite

    9. You can start using Opayo Suite for Magento 2, to set the Configuration correctly you will need to follow this Configuration Guide.