Magento 2.X Community Edition – View Cart Widget

Integration Guide

Objectives and Target Audience

This guide describes how to install and configure the Openpay View Cart Widget Extension to Magento 2.X Community Edition. You should have an existing Magento installed.

What is Magento Payment Extension?

Magento is an eCommerce platform, built on open source technology, which provides online merchants with not only a flexible shopping cart system, but also control over the look and feel, content and the functionality of their online store. Magento has been fully integrated with Openpay’s online payment solutions. Installing and configuring the Hosted Payment Solution module of Openpay provide a simple, secure and convenient option to connect with Openpay’s online payment processing platform via Magento.

Placement

Openpay View Cart Widget shows on Cart Page, reminding the user they have an option to choose Openpay as their payment method at checkout.

Installing and Configuring View Cart 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 2.x. The installation procedure described here has been tested on Magento version 2.x
  • Supported Web Servers: Apache / nginx
  • SSL: A valid security certificate is required to work over a secure channel (HTTPS) from the Magento Admin Panel or while submitting 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: https://devdocs.magento.com/#/individual-contributors.

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.

Go to your projects root folder and follow the path: app/code/ If there is no ‘code’ folder under the ‘app’ directory, then please create it

Unzip the extension file and traverse until the ‘Openpay’ folder is found. Copy and paste that folder into the ‘code’ folder

Open a terminal window and switch to Magento root directory

Then run these commands:

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

If cache is enabled on your website, run this command: php bin/magento cache:flush

Or, you can do it manually from the admin panel by following the path: System > Tools > Cache Management > Flush Magento Cache

Check the status of the module by running this command: php bin/magento module:status. If the Openpay_viewcartWidget appears on the ‘List of enabled modules’, then the module is running properly.

Admin Setup

Log in to your Magento admin.

Navigate to Stores > Settings > Configuration

Expand ‘Openpay Widgets’ from the left panel and click on ‘Settings’

Expand Openpay Widgets Configuration > Enable Widgets > Yes > Save Config

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

  • View Cart Status: Enable.
  • Show only on Min-Max: Set this option ‘Yes’ only if you wish to show the widget on order amount which fall within the minimum and maximum threshold.
  • Openpay Brand Message: Enter text ‘Pay overtime, interest free. Available at checkout.’
  • 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: Only upload this image if provided by Openpay. (eg. 2 or 3) Set it to ‘Yes’ and upload Popup image, specification: 500px (high) x 500px (wide).
  • Click ‘Save Config

Frontend View

View Cart Widget
If the plugin is enabled from the admin, widget will be displayed as follows on the Cart 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 Stores > Configuration > Openpay Widgets > Settings expand View Cart Widget > No

Version Control Table

# Date Version Description
1 January 2019 1.00 Guide Created