OpenCart 3.X – Openpay Payment Plugin / Extension

Integration Guide

Objectives and Target Audience

This guide describes how to install and configure the Openpay Payment Gateway Extension to OpenCart. You should have an existing OpenCart installed.

Introduction

What is OpenCart Extension?

OpenCart 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 of the content and functionality of their online store.

OpenCart can be 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 for connecting to Openpay’s online payment processing platform via OpenCart.

Signing up for Openpay merchant account

In order to start taking payments through Openpay, you need to sign up and get approval for an Openpay merchant account. Once your application is approved, you can configure Openpay Hosted Payment Solution module and start taking payments.

Openpay provides a test account and users for training and testing purpose.

Installing and Configuring Openpay Payment Extension

Prerequisites

Before Installing the Openpay module, you need to make sure that your web server meets the following criteria:

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

Running OpenCart on a Windows server

OpenCart can be run on a Windows server, although this is not officially supported by OpenCart. Please visit the OpenCart website for details.

For this module, Vqmode needs to be installed earlier within the OpenCart setup.

Installation Steps

To install the extension, download and extract the zip file.

The folder contains the required files and folders that are listed below:

  • i. Upload folder => containing admin,catalog,vqmod folders
  • ii. Readme.md (have information about that module)

Upload the module folder “admin,catalog,vqmod” along with all the files into the OpenCart root directory

Admin Setup

Log in to your OpenCart admin account

Navigate to System > Users > User Groups > Edit ‘Administrator’ > Select installed module ‘extension/payment/Openpay’ in Access Permission and Modify Permission Section > Save

Extensions > Extensions > Choose the extension type > Select ‘Payment’ from the dropdown > Openpay > Install

Then click on Edit button

Populated the fields for Openpay Payment as follows:

Status: Enabled

Country: Set it to Australia.

Jam Auth Token: Please enter Jam Auth Token provided by Openpay or
Use the Test Jam Token below for testing:
30000000000001183|abfea8e7-9c15-4889-bc44-0df8a05ad73c

Sandbox Mode: If the website is live then set it to ‘No’. If the website is under production or under development, then set it to ‘Yes’.

Minimum Order Amount: Will populate once Update Min Max button is clicked.

Maximum Order Amount: Will populate once Update Min Max button is clicked.

Run Min Max: Click ‘Update Min – Max’ to get the min-max amount.
(Order amount should be greater than minimum and less than maximum to enable Openpay payment method on the frontend of your site. This value is displayed on the on Jam Token provided.)

Click on ‘Save’.

How does Openpay work

If the customer chooses to checkout with items that are worth less than the total amount provided in the admin total, then Openpay will not show in the ‘Payment Method’.

If the amount is greater than the Minimum Order Value and Less than the Maximum Order Value which is set on admin configuration, it will allow the users to pay using Openpay Payment Method.

Click on the ‘Continue’ tab, and the Order Confirm Order Option will be shown.

Click on the ‘Confirm Order’ and it will be redirected to the Openpay Payment Gateway page. This will perform a HTTP POST request to Openpay.

Openpay Plan Creation

If the customer is already registered with Openpay, the following screen will be displayed:

If you do not have an Openpay account, you need to create one.

We do not send Email code on training mode please use 123456 for verification.

We do not send SMS on training mode please use 111111 for verification.

If the customer continues to login, then the following page will be displayed:

If one clicks on Submit Plan, and the plan is successful, the browser will be redirected to your site with “Your order has been placed” message.

Demo Site

Shows the placement of all the Openpay widgets and assets. You can test an Openpay plan creation on this site.

Testing

This section provides the credentials for test user and test merchant account on Openpay Training Environment to create and check your Openpay plan.

Test User

Username: testopencart@xx.yy
Password: Testing123

Test Merchant / Retailers Account

https://retailer.myopenpay.com.au/training
Username: adminopencart
Password: Test123

OpenCart Order Status

Processing
After successful payment order status will be ‘Processing’.

Complete
If the order is shipped or dispatch by the admin, then orders status change to complete.

Cancelled
If the order is cancelled by an admin user.

Refunded
If the order is fully refunded by an admin user, then orders status change to Refunded.

Below is the detailed order status to share with your staff who look after orders, dispatch and refunds.

Refund

Refund can be done easily from the Admin panel of OpenCart.

Admin can check the placed order in the admin area from Sales > Order > Order list

Select the Openpay order you wish to refund and click Edit.

Under ‘Add Order History’ > Order Status > select ‘Refunded’ on the dropdown menu and click ‘Add history’ button.

The order will be refunded back to the customer’s account automatically.

Uninstallation

Navigate to Extensions> Extensions > Select ‘Payment’ from Choose the extension type dropdown > Openpay > Uninstall

Version Control Table

# Date Version Description
1 September 2017 1.1 Created payment plugin
2 July 2019 5.2 Updated to API 5.2
3 September 2019 5.5 Updated to API 5.5