Magento 1.9.X Community Edition – Product Calculator Widget

Integration Guide

Objectives and Target Audience

This guide describes how to install and configure the Openpay Product Calculator Widget / Extension to Magento 1.9.X Community Edition. You should have an existing Magento installed.

What is Magento Widget Extension?

Magento Widgets are Magento Extensions with a predefined set of configuration options. With the help of these Widgets, the store administrators can enrich the frontend blocks functionality. They provide great control and flexibility in creating informational and marketing content from the Magento administrator panel.

Placement of the Widget

Openpay Product Calculator Widget is displayed on the Product Page, showing how Openpay is a flexible, interest-free payment method that gives user the option to pay weekly or fortnightly, over available months.

Installing and Configuring Product Calculator Widget

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 widget/extension, 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

Expand ‘Openpay Widgets Configuration’ and set ‘Enable Widget’ to ‘Enable’ > Save Config

To set up ‘Product Calculator Widget’, expand and fill out the fields as per your Openpay account configuration. (This information will be provided by your Openpay Ecommerce Manager or Account Manager).

Please note a Merchant can either have Deposit Percentage or Fractional Payment.

Important note:
Check with Openpay / Ecommerce Manager if your account is configured with Deposit Percentage Plan Tiers.

Configuration for Deposit Percentage Payment

This option shows percentage deposit of the product price.

Magento 1 Deposit Widget

  • Product Calculator Status: Select Enable to activate the plugin.
  • Deposit Percentage: (normally 20 or as provided).
  • Pay of Month: Select Pay of Months (as provided by Openpay. eg 2, 3 or 4, multiple selection could be done).
  • Mode of Payment: Weekly, Fortnightly or Monthly (as provided).
  • Enable Info Icon: Enable to display Openpay plan tiers as per your account settings.
  • Openpay Brand Message: This message will show on products which have the price outside the minimum and maximum threshold order amount configured on your Openpay account. Brand message: Buy now, pay smarter.
  • Show Brand Message Only: Set this option to ‘Yes’, if you don’t want to display calculated price on the app. It will display Openpay message with Openpay logo and learn more text.
  • Enable Learn More: Enter text ‘Learn more’ on clicking ‘Learn more’ a popup will open explaining how to use Openpay at checkout and requirements to create an Openpay accounts.
  • Popup Image: A default popup is set to load. Only upload this image if provided by Openpay. Set it to ‘Yes’ and upload Popup image, specification: 500px (high) x 500px (wide).
  • Click ‘Save Config’.

Important note:
Check with Openpay / Ecommerce Manager if your account is configured with Fractional Plan Tiers.

Configuration for Fractional Payment

This option shows equal payment breakups of the product price.

Magento 1 Fractional Widget

  • Product Calculator Status: Select Enable to activate the plugin.
  • Deposit Percentage: Leave it blank
  • Pay of Month: Do not select any numbers.
  • Mode of Payment: Weekly, Fortnightly or Monthly (as provided).
  • Enable Info Icon: ‘Disable’.
  • Openpay Brand Message: This message will show on products which have the price outside the minimum and maximum threshold order amount configured on your Openpay account. Brand message: Buy now, pay smarter.
  • Show Brand Message Only: Set this option to ‘Yes’, if you don’t want to display calculated price on the app. It will display Openpay message with Openpay logo and learn more text.
  • Enable Learn More: Enter text ‘Learn more’ on clicking ‘Learn more’ a popup will open explaining how to use Openpay at checkout and requirements to create an Openpay accounts.
  • Fractional Payment: ‘Yes’. 
  • Fractional Payment Pay of Month: Enter only one month as supplied by Openpay.
  • Popup Image: A default popup is set to load. Only upload this image if provided by Openpay. Set it to ‘Yes’ and upload Popup image, specification: 500px (high) x 500px (wide).
  • Click ‘Save Config’.

Frontend View

‘Product Calculator Widget’ with Percentage Deposit
If the module is enabled from the admin and Percentage Deposit is checked the widget will be displayed as follows on the Product Details page.

Hover on the ‘i’ icon and the calculator will be displayed as a popup.

‘Product Calculator Widget’ with Show Brand Message Only
If the module is enabled from the admin and Show Brand Message Only is checked the widget will be displayed as follows on the Product Details page.

‘Product Calculator Widget’ with Fractional Payment
If the module is enabled from the admin and Fractional payment is checked the widget will be displayed as follows on the Product Details page.

‘Learn more’ link opens a popup explaining how to use Openpay at checkout and the requirements to create an Openpay account.

Demo Site

Shows the placement of all the Openpay widgets and assets.

Uninstallation

Navigate to System > Configuration > (on left panel) Openpay Widget > Widget Setup > Product Calculator Widget > Product Calculator Widget Status > Disable

Version Control Table

# Date Version Description
1 September 2017 1.1 Created widget
2 July 2019 1.2 Update the widget features
3 September 2019 1.3 New feature of fractional payment added
4 January 2020 1.4 New design and features added, logo showing on min-max message