Magento 1.9.X Community Edition – Checkout Calculator Widget

Integration Guide

Objectives and Target Audience

This guide describes how to install and configure the Openpay Checkout 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 Checkout Calculator Widget is displayed on the Checkout Page, showing all the available payments allowing the users to pay weekly or fortnightly, over available months.

Installing and Configuring Checkout 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

Login to your Magento admin account.

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 ‘Checkout 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.

  • Checkout Calculator Status: Enable.
  • Deposit Percentage: (normally 20 or as provided).
  • Mode of Payment: Weekly, Fortnightly or Monthly (as provided).
  • Pay of Month: Select Pay of Months (as provided by Openpay. eg 2, 3 or 4, multiple selection could be done for deposit payment).
  • Checkout Instruction: (Optional) Enter the text ‘Click on Place Order to securely complete your purchase. You will be directed to Openpay website.’ Or you can leave this field blank.
  • 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.

  • Checkout Calculator Status: Enable.
  • Deposit Percentage: Leave it blank.
  • Pay of Month:Select Pay of Months (as provided by Openpay. eg 2, 3 or 4, multiple selection could be done for fractional payment).
  • Mode of Payment:Weekly, Fortnightly or Monthly (as provided)
  • Checkout Instruction: (Optional) Enter the text ‘Click on Place Order to securely complete your purchase. You will be directed to Openpay website.’ Or you can leave this field blank.
  • Fractional Payment: ‘Yes’.
  • Click ‘Save’.

Frontend View

‘Checkout Calculator Widget’ for Percentage Deposit
If the module is enabled from the admin and Percentage Deposit is checked the widget will be displayed as follows on the Checkout Page.

‘Checkout Calculator Widget’ for Fractional Payment
If the module is enabled from the admin and Fractional payment is checked the widget will be displayed as follows on the Checkout Page.

Demo Site

Shows the placement of all the Openpay widgets and assets. 

Uninstallation

Navigate to System > Configuration > (on left panel) Openpay Widget > Widget Setup > Checkout Calculator Widget > Checkout 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 updated