&

Introduction

Magento is a popular E-commerce platform. Payright has developed a plugin which easily integrates with Magento based webshop. It's a simple way of letting your customers use Payright at checkout. Adding Payright on to your Magento webshop is easy, you don't need advanced technical skills.

What you need

Magento instance, installed on your web server. You also need FTP access to the server or testing purpose, you would need the following

  • API Key
  • Payright Merchant Username,
  • Merchant Password
  • Client Username
  • Client Password
Payright Logo and Terms & Conditions

Upon activating the Magento Payright module, installments text and Payright logo's would be displayed on

  • Checkout Page - Mandatory
  • Product Page - Mandatory
  • Product Category Page - Optional
  • Hot sellers - Optional
  • Related Products - Optional

Detailed information could be found in the configuration instruction below

Get Magento

This document assumes that you already have a working Magento webshop. if you don't you can download the software and learn how to it here Many web hosting services have tools that let you install Magento in just a matter of a few clicks.

Get Plugin

Payright is compatible with Magento v2.0

In order to deploy Payright on Magento 2

  • Go to https://github.com/PayRightEnjoyNowPaylater/PayRight-Magento2 located on our code repository GITHUB.
  • You would be able to clone the module or download as.ZIP (nontechies its recommend to download as a zip file )
  • Unzip the file
  • Client Copy the 'Payright' folder to: [MAGENTO]/app/code/
  • Log in to your Magento backend.
  • Clear your Magento Cache
  • 7. Log out of the Magento back end and log in again. This would force permissions for new Payright plugin.

That's it if you don't get any errors, you should have the Payright module installed on your webshop.

Go to Stores > Configuration > Sales > Payment Methods and click on Payright



Configuring the Payright Plugin

Once you have your Auth keys and Configuration information from your account manager or developer portal. Next step is to configure the plugin.

  • Open the Magento Admin Panel.
  • Go to Stores > Configuration > Sales > Payment Methods > Payright.
  • Expand the sections, and fill them in as described below.
Minimum Configuration

The absolute minimum configuration is

  • Open the Magento Admin Panel.
  • Go to Stores > Configuration > Sales > Payment Methods > Payright .
  • Expand the sections, and fill them in as described below.
Order Shipment

When a customer's return after payment through Payright, the payment status will be "Processing". Once the order is shipped the payment status will be "Complete". On the order details page > Ship > Submit Shipment. Once the shipment is completed the plan will be Activated.

Configuration Property Description Default
Enable Select Yes to offer Payright in your webshop
Sandbox Select Yes to offer Payright on Test Mode
Username Enter the Username provided at the time of merchant account creation or contact account manager.
Password Enter the Password provided at the time of merchant account creation or contact account manager.
Could be also be found in the Payright Developer Portal
API Key Enter the API KEY provided at the time of merchant account creation or contact account manager.
Client Id Enter the Client ID provided at the time of merchant account creation or contact account manager.
Merchant Username Enter the Merchant Username provided at the time of the merchant account creation or contact account manager.
Merchant Password Enter the Merchant Password provided at the time of the merchant account creation or contact account manager.
Minimum Amount Set the minimum amount that Payright Transactions could be enabled.
Account Manager would provide the minimum Amount. Varies from Merchant to Merchant based on Payright risk assessment
Maximum Amount does not need to be configured, this is handled via the Payright API

Configuration Property Description Preview
Show Payright Instalments information on Product Page If this is selected as YES, Payright Installment text would be displayed on the Product Page.
Payright recommends this to set to YES at all times.
Backend Configuration Preview Front End Preview
Show Payright Instalments information on Category Page If this is selected as YES, Payright Installment text would be displayed on the Category Pages.
Payright recommends this to set to YES at all times.
Backend Configuration Preview Front End Preview
Show Payright Installments information on Bestseller Products If this is selected as YES, Payright Installment text would be displayed on the Bestseller Module. Backend Configuration Preview Front End Preview
Show Payright Installments information on Cross-sell Products If this is selected as YES, Payright Installment text would be displayed on the Cross-sellers Module. Backend Configuration Preview Front End Preview
Show Payright Installments information on Related Products If this is selected as YES, Payright Installment text would be displayed on the Related Products Module. Backend Configuration Preview Front End Preview
Show Payright Installments information on Upsell Products If this is selected as YES, Payright Installment text would be displayed on the Upsells Module Backend Configuration Preview Front End Preview
Order Page if the order is Shipped by clicking Ship, the payment plan will activate
Ship This is the shipment page. it includes the plan details for the plan. if the shipment is submitted the plan will activate. If there is an issue with the plan activation, please contact support@payright.com.au
Presentation at Checkout

The Payright plugin for Magento already comes with the correct Terms & Conditions, logos, etc. Everything should display correctly on your checkout page by default.

We recommend that you set the following values under the Payright plugin settings:

  • Sort Order = 1
    If you have multiple Payright payment methods for the same country, give them the lowest possible (but different) sort order numbers.
  • Show Payright Installments information on Product Page - YES
Testing & Go Live

Once your webshop has been configured with test Auth keys, you can make a test purchase's using Payright as the payment method.

  • Test the whole chain, ask your Key Account Manager for an Auth key to the Payright Client Test environment. You can use this in Test mode. You will receive confirmation emails and will be able to see the payment plans in Test Merchant Portal.
  • Once you and your Key Account Manager are happy that everything is in order, you will get a Live Auth key and can start offering Payright to your customers.