WordPress – Openpay Widget

Integration Guide

Objectives and Target Audience

This guide describes the process of installing and configuring the Openpay Widget plugin to WordPress version 5.x. Install this plugin after installing the Openpay Payment Method for WooCommerce plugin.

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.

You should have an existing WordPress website to install the Openpay Widget plugin.

What is Openpay Widget?

Openpay Widgets is a WordPress plugin 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 WordPress

Prerequisites

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

  • There should be an existing WooCommerce installation on your WordPress web server. The Openpay module is compatible with WordPress version 4.x and WooCommerce version 3.x. The installation procedure described here has been tested on WooCommerce version 3.x
  • Supported Web Servers: Apache / nginx
  • SSL: A valid security certificate is required to work over a secure channel (HTTPS) from the WordPress 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 WordPress website https://wordpress.org/about/requirements/ and WooCommerce website: https://woocommerce.com/

Installation Steps

To install the plugin, download the Openpay Widget plugin zip file.

Log in to your WordPress admin dashboard

Navigate from Dashboard to Plugin > Add New > Add Plugins (select the downloaded file) > Upload

After installing: Activate the ‘Openpay Widget’ plugin.

Admin Setup

Navigate from Dashboard > Openpay Widgets

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.

WordPress Openpay Widget Configuration

Configuring Openpay Widget App

Enable Widget Set 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 for WooCommerce plugin is installed
Maximum Order Value Will automatically populated if the Openpay Payment Method for WooCommerce plugin is installed
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’
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
Show Product Page Widget Select ‘Yes’ to display the Product Page Widget on the product detail page
Show Cart Widget Select ‘Yes’ to display Cart Widget on the cart page
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 “Proceed to Openpay”.
  Click ‘Save Changes’

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.
Download the trust seal from the links below:

     

Banners / Style Guide

Entire suite of digital banners can be found here.

Demo Site

Shows the placement of all the Openpay widgets and assets.

Uninstallation

Navigate from Dashboard to Plugins > Openpay Widget > Deactivate

Version Control Table

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