Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
executable file 106 lines (70 sloc) 7.72 KB

Simplify Commerce Payment Gateway for Magento 2

Overview

Simplify Commerce Payment Gateway module is a free Magento 2 module that adds Simplify Commerce as payment method on your Magento 2 checkout page. With simple configuration steps described below you can quickly start using Simplify Commerce's secure payment form for receiving payments in your online store.

The module allows payments using Simplify Commerce Hosted Payments. Simplify Commerce Hosted Payments handle credit card data in safe and secure way, with full compliance with legal requirements. We use state-of-the-art encryption and tokenization to securely get payment information from your customer to our database. We monitor every transaction and manage sensitive payment data on our Level 1 PCI certified servers, which makes PCI compliance easier for you. Optionally, you can still use Magento's own credit card input form, if you prefer that, while payments will still be executed by Simplify Commerce API.

Prerequisites

Magento 2.1

The module requires Magento 2.1 or newer. It supports both Community Edition and Enterprise Edition.

Magento 2.1

Customer account at Magento Marketplace website at https://marketplace.magento.com and access keys. Once you register and log in, navigate to My Access Keys and create a new pair of access keys on Magento 2 tab. Note both the public and the private key, you will need them later during installation of the module.

Composer

To download and install the components you need Composer, a PHP package manager. If it's not yet there on your Magento 2 server, install it first. Please follow the instructions specific for your operating system: https://getcomposer.org/doc/00-intro.md

Simplify Commerce Account

Before you can use the module, you must have a Simplify Commerce account https://www.simplify.com/commerce/

We recommend that you configure the module using Simplify Commerce Sandbox configuration. This way you can make sure everything works well, before you start receiving live payments. For testing module configuration you can use test card numbers provided by Simplify Commerce at https://simplify.com/commerce/docs/testing/test-card-numbers. You will find more details about the configuration in the following chapters.

Installation

Before installing the module, make a full backup of your site.

Installation using PHP Composer

The preferred method to install the module is by using PHP Composer:

Log on to your Magento 2 server and navigate to Magento installation folder. The exact location can vary, but you can identify it by content. Inside this folder, amongst others, you should see the following files and folders:

index.php
composer.json
/bin
/var
/vendor

Run the following commands to download and install the module:

composer config repositories.mastercard-module-simplifycommerce git https://github.com/simplifycom/simplify-magento-module.git
composer require mastercard/module-simplifycommerce:2.1.6 --prefer-dist
./bin/magento setup:upgrade
./bin/magento cache:clean

When asked by Composer for user name and password for Magento repository at https://repo.magento.com, enter the Magento Marketplace public key as user name, and private key as password.

Verify whether the module has been succesfully installed. Log in to Magento Admin dashboard and go to System > Web Setup Wizard > Component Manager. Simplify Commerce module should be there at the end of the list. Please make sure that it's enabled. The status icon should be green. If it's red, you need to enable the module, by selecting Enable action in the actions drop-down at the right, then following the provided instructions.

Manual installation

If you prefer to deploy and install the module without Composer, proceed with the following steps:

Download module files from https://github.com/simplifycom/simplify-magento-module/archive/2.1.6.zip

Create folder structure inside the the Magento main folder:

./vendor/mastercard/module-simplifycommerce 

Extract module files into that folder and execute the following commands:

./bin/magento setup:upgrade
./bin/magento cache:clean

Verify whether the module has been succesfully installed. Log in to Magento Admin dashboard and go to System > Web Setup Wizard > Component Manager. Simplify Commerce module should be there at the end of the list. Please make sure that it's enabled. The status icon should be green. If it's red, you need to enable the module, by selecting Enable action in the actions drop-down at the right, then following the provided instructions.

Deinstallation

If you want to uninstall the previously installed Simplify Commerce Payment Gateway module, please run the following commands:

./bin/magento module:uninstall MasterCard_SimplifyCommerce
./bin/magento setup:upgrade
./bin/magento cache:clean

Configuration

Configuration steps

Please follow these steps to configure the module:

  1. Login to Magento Admin dashboard
  2. Go to Stores > Configuration > Sales > Payment Methods
  3. Expand OTHER PAYMENT METHODS, then Simplify Commerce by MasterCard
  4. Fill in configuration details as described below
  5. Click Save Config to store the configuration.
  6. Follow Magento instructions and clean application cache, to make sure that the new payment method is immediately available in your online store.

Configuration details

The following settings are available in Simplify Commerce Payment Gateway configuration screen:

  • Enabled: should be set to YES, to make Simplify Commerce available as payment method on checkout page
  • Title: name of the payment method displayed on checkout page
  • Public API Key: secret key from your Simplify Commerce Merchant Dashboard. For testing the module please use the Sandbox key. Once you see that payments from Magento 2 with test credit card numbers are visible in your Simplify Commerce Merchant Dashboard, you should come back here and enter the Live key. From this moment you will be able to receive payments from real credit cards.
  • Private API Key: the second secret key from Simplify Commerce Merchant Dashboard. The same rules as above apply.
  • Display Order: position, at which this payment method should be listed on checkout page
  • New Order Status: status assigned to a newly created order, before the payment has been received
  • Payment Action: determines when the buyer's credit card will be charged. If you select Authorize and Capture, the card will be charged immediately. If you select Authorize, the payment will be verified and authorized, but no money will charged yet. Only when you issue an invoice for the received order, will the card be charged.
  • Use Simplify Hosted Payments: if YES, hosted payment form from Simplify Commerce is used to enter the credit card data. In this scenario no credit card data is ever processed or stored in your Magento 2 system. This is the most secure and recommended solution.
  • Customer can save credit card: if YES, the customer can store credit cards in Simplify Commerce for future use. This option is only available, when Simplify Hosted Payments are enabled.
  • Credit Card Types: card types that should be accepted in your online store
  • Accepted Currencies: currencies accepted in your online store
  • Payment from Applicable Countries: countries from which customers are allowed in your online store

License

This software is Open Source, released under the BSD 3-Clause license. See LICENSE.md for more info.