Skip to content

Installation of EVO Payments plugin for Magento 2.x

Jump to bottom
Eóin O' Leary edited this page Feb 8, 2022 · 1 revision

Introduction

This manual is for the installation, configuration and the use of the payment module for Magento 2.x and EVO Payments. Before installing ensure sure you have the required details for setup.

You will need:

  • EVO Payments Merchant ID
  • EVO Payments password
  • EVO Payments payment plugin
  • Login details to your server
  • Magento administrator login details
  • We also recommend before getting started you take a full backup of your website.

System requirements:

  • Magento version 2.x

Installation

  1. Download the extension.
  2. Upload the “app” folder to the root directory of your store using FTP/SSH.
  3. Enable the extension and clear the static view files. bin/magento module:enable EVO_Payment --clear-static-content
  4. Register the extension and initiate the database migrations. bin/magento setup:upgrade
  5. Recompile the Magento project. bin/magento setup:di:compile
  6. Clear the Magento store’s cache. bin/magento cache:flush

Configuration

  1. Next go to STORES > Configuration > Sales > Payment Methods. image
  2. Scroll to EVO Payments settings and you will see the following form fields which must be populated. Please enter them here and click save. It is now installed, and you can begin testing.

image

  1. Once finished click save config. We also recommend at this point you clear the Magento cache.
  2. When you receive an order you can check if payment was collected by going to sales => orders => View. You should also check to see the transaction in the EVO back office.

Clearing Magento cache

  1. Go to System > Cache Management

image

  1. Select all blocks by pressing Select All button and press Submit button

image

Captures

For authorized transactions you can create capture directly to IPG back office from Magento. To do this open an order and click on Invoice button at the top right side.

image

Once on the Invoice page, scroll down to the bottom, choose Capture Online dropdown menu and click on Submit Invoice button.

image

Void

For authorized transactions you can void directly to IPG back office from Magento. To do this open an order and click on Void or Cancel button at the top right side.

image

Refunds

For paid transactions you can create refunds and send them automatically to EVO back office from Magento. To do this open the invoice of the captured order.

image

Then click on Credit Memo on the TOP RIGHT side menu.

image

Once on the credit memo screen click refund and you should get a message telling you the refund was successful, please verify this later in the back office.

image

Security

Do I need to use SSL/TLS on my payment pages?

Yes, for a couple of reasons:

  • It's more secure. In particular, it significantly reduces your risk of being exposed to a man-in-the-middle attack.
  • Users correctly feel more comfortable sharing their payment information on pages visibly served over HTTPS. Your conversion rate is likely to be higher if your pages are served over SSL/TLS, too.

What if I don't want to set up SSL/TLS yet?

  • You can test your page--but not live transactions--before installing your SSL/TLS certificate. You don't need to enable HTTPS until you're ready to go live.
  • To test live transactions without your own SSL/TLS certificate, you could host your site with a provider that provides a secure subdomain.
Clone this wiki locally