Magento 1.9.X Community Edition – Openpay Widget

Integration Guide

Objectives and Target Audience

This guide describes the process of installing and configuring the Openpay Widget / Extension to Magento 1.9.X Community Edition. You should have an existing Magento installed.

This widget explains how Openpay is a flexible, interest-free payment method. It showcases the minimum and maximum order value, allowing the user to choose an option to pay weekly or fortnightly, over available months.

What is Openpay Widget?

Openpay Widgets is a Magento Extension with a predefined set of configuration options.

Placement of the Widgets

Openpay Widget plugin is a set of widgets, when installed and activated will show the widgets on the following pages:

  • Info Belt – Top section of the HomePage
  • Product Catalog / Listing Page
  • Product Detail Page
  • Cart Page
  • Checkout Page

Installing and Configuring Openpay Widgets on Magento 1

Prerequisites

Before installing the Openpay module, make sure that your web server meets the following criteria:

  • There should be an existing Magento installation on your web server. The Openpay module is compatible with Magento version 1.9.x. The installation procedure described here has been tested on Magento version 1.9.x
  • Supported Web Servers: Apache / nginx
  • SSL: A valid security certificate is required to work over a secured channel (HTTPS) from the Magento Admin Panel or while submitting the form data from the store‐front. Self‐signed SSL certificates are not supported
  • MySQL database with sample data
  • At least 5.6 or the later version of PHP, MySQL and web browser
  • Curl (version 7.20.0 ‐ 7.44.0)

For further details on PHP compatibility, MySQL, supported Web servers and other requirements, refer to the Magento website: http://devdocs.magento.com/guides/m1x/system-requirements.html

Running Magento on a Windows Server

Magento can be run on a Windows server.

Installation Steps

To install the Openpay Widget, download the zip file and extract it.

Log in to the Magento admin panel.

Copy and paste all the files within the Root Folder. If you have any custom theme, you can upload the theme file to the current theme (app/design/frontend/)/< Your package >/< Your Theme >)

Admin Setup

Navigate to admin panel: System > Configuration > (on left panel) Openpay Widget > Widget Setup

To set up ‘Openpay Widgets’ fill out the fields as required as per your Openpay account configuration. (This information will be provided by your Openpay Ecommerce Manager or Account Manager).

Important note:
Check with Openpay / Ecommerce Manager for your Plan Tiers configuration.

Magento1 Openpay Widget Configuration

Configuring Openpay Widget

 

General Configuration

Enable Widget Set to ‘Yes’
Include JQuery Default set to ‘No’, only if Jquery is not added to the website, set it to ‘Yes’
Region Select Australia or United Kingdom (as per your contract)
Plan Tiers Select months (as provided by Openpay eg 2, 3 or 4, multiple selections could be done)
Currency Select your store currency
Minimum Order Value Will automatically populated if the Openpay Payment Method extension is installed
Maximum Order Value Will automatically populated if the Openpay Payment Method extension is installed

Info Belt Widget

Show Info Belt Widget There are two options to display the Info Belt on top of the website head section.
Home Page or Across the Site. Select your preferred option from the dropdown
Info Belt Widget Color Select an option from ‘Amber’, ‘Grey’ or ‘White’, one that suits your website theme
Info Belt Widget Sticky If your website theme has a sticky menu select ‘Yes’ else select ‘No’

Product Listing / Catalogue Page Widget

Show Catalog Page Widget Select ‘Yes’ to display Catalog Page Widget on product listing / catalog page
Show Openpay Logo on Catalog Widget Select ‘Yes’ to display the Openpay logo on Catalog Page Widget for product listing / catalog page

Product Page Widget

Show Product Page Widget Select ‘Yes’ to display the Product Page Widget on the product detail page

Cart Widget

Show Cart Widget Select ‘Yes’ to display Cart Widget on the cart page

Checkout Widget

Show Checkout Widget Select ‘Yes’ to display Checkout Page Widget for the checkout page of the website
Instalment Text For Australia add text: Pay in interest free fortnightly instalments.
As per the instalment plan set on your Openpay account.
(Leave this field blank for the United Kingdom)
Redirect Text Add text: You will be redirected to Openpay’s website to complete your order when you click “Continue”.
  Click ‘Save Config’

Frontend View of Openpay Widgets

If the module is enabled from the admin with the correct setting the widgets will be displayed as follows on the different sections of the website.

Info Belt Widget

Displayed on top of the homepage above the navigation.

Info Belt Widget

 


Catalog Page Widget

Displayed on Product Listing/Catalog Page.

Product Catalog / Listing Page

 


Product Page Widget

Displayed on Product Detail Page.

Product Page Widget

 


Cart Page Widget

Displayed on Cart Page.

Cart Page Widget

 


Checkout Page Widget

Displayed on Checkout Page.

Checkout Page Widget

 


Learn More – Popup

All ‘Learn more’ links will open a popup as follows indicating the available repayment months and explaining what you need to get started to use Openpay.

Learn More - Pop up

Assets

The next step is to add the assets, Landing Page, Quick Links, Trust Logo, and Banners.

Landing Page

Create a new page > add Openpay HTML tag

Paste the code below on your page just like any other HTML element for Openpay Landing Page content.

<opy-landing-page></opy-landing-page>

Trust Seal

Add the Openpay trust seal under the “Available Payment Methods” section on the footer.

Download the trust seal from here.

Example of how Openpay Landing Page, Quick Link and Trust Seal will be showcased.

Assets - Landing Page, Quick Link and Trust Seal

Banners / Style Guide

The entire suite of digital banners can be found here.

Demo Site

Shows the placement of all the Openpay widgets and assets.

Uninstallation

Navigate to System > Configuration > (on left panel) Openpay Widget > General Configuration > Enable Widget > No

Version Control Table

# Date Version Description
1 September 2020 1.0 Created new all in one widget