PrestaShop – Openpay Payment Plugin

Integration Guide

Overview

The purpose of this document is to enumerate the technical steps involved in the integration of Openpay plugin into an existing Prestashop 1.6 installation. The Openpay plugin has been developed for Prestashop v1.6.

Prestashop1.6 Installation

If Prestashop 1.6 is not already installed, this document provides step-by-step instructions to install it:
http://doc.prestashop.com/display/PS16/Installing+PrestaShop

Prestashop1.6 Documentation

This user guide will help you familiarize yourself with PrestaShop’s features:
http://doc.prestashop.com/display/PS16/English+documentation

Components

Openpay integration has following modules:

  • module: openpay
  • cronjob: cron_openpay_purchase.php

Installing and Configuring Openpay Payment Plugin

Module Integration

In Prestashop, all the modules for customising the online shop are in the folder prestashop/modules.

Follow the steps below:

  • The folder openpay must be inserted in this
  • Then go to prestashop backoffice and navigate into the menu “Modules and Services”.
  • Click “Install” on the module Openpay.

Backoffice Configuration

For the Openpay integration to work, the following needs to be configured in the Backoffice.

After these integration steps are completed, the refund and checkout features would be functional.

Following are the credentials for training environment:

Button Text: Openpay

Openpay Auth Token: 3-373|180D731A-F9C8-437B-8FC0-8341196D9CF0

Openpay Handover URL: https://retailer.myopenpay.com.au/websalestraining/?TransactionToken=

Openpay Service URL: https://api.training.myopenpay.com.au/v1/merchant

Modus: Staging (if working on Test)

Widget Minimum Price: $50

Widget Maximum Price: $5000

Job Frequency:

After these integration steps are completed, the refund and checkout features would
be functional.

This section contains basic set of test cases. Detailed test reports are attached for your reference

Checkout Test

Order products whose sum is higher than Widget Minimum Price (configured in Backoffice). Click on the Button “Openpay”. After clicking Buy now button, customer should be redirected to Openpay Payment Gateway. After execution of all steps, customer will come back to PrestaShop with status canceled or approved.

Refund Test

After refunding the Order status in Orders should be changed in “Openpay refund status”

Job Test

Job can be tested manual. Insert the target link, which is configured in Cron task manager in the browser. Then all orders, which has Openpay “pending” status and are older than frequency time, should be changed in Openpay “approved” status or canceled.

Job Integration

The file cron_openpay_purchase.php is to be inserted in the folder prestashop/[your admin folder].

For jobs, we need the administrator module Cron tasks manager. It will be installed by default. After clicking “Configure” button, a new job should be created.

The link from cron_openpay_purchase.php file must be inserted there and the key should be used, which is created there.

Example:

Now this link can be inserted in a cronjob tool.

For example, crontab –e:

More information can be found in: https://wiki.ubuntuusers.de/Cron/

How does Openpay work on your site

Checkout using Openpay Payment Method

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: AppTestUser@xx.yy
Password: Test123

Test Merchant / Retailers Account

https://retailer.myopenpay.com.au/training
Username: test_user
Password: Test@123

Refund

PrestaShop Order Status

Openpay uses custom order status which will be automatically created after installing the module.

Openpay pending status
Customer completes the Openpay form and will be redirected to PrestaShop. If all is fine then the response status is LODGED, order will be placed with order status.

Next Step is to capture the order. If there will be some connection problems or capture will be failed then status will not be changed and order stay in Openpay pending status.

Openpay rejected status
If capture was successful and the order status from Openpay response is not approved then order status will be changed to Openpay rejected status.

Openpay approved status
If capture was successful and order status from Openpay response is approved then order status will be changed to Openpay approved status and can be refunded. Every 30 minutes a job runs and checks the order that are in status Openpay pending status. If returned Openpay order status is Approved and Openpay plan status is Active then order status will be changed to Openpay approved status.

Openpay refunded status
All Orders with status Openpay approved status can be partial and full refunded. If whole amount was refunded then order will be changed to Openpay refunded status.

Canceled
Every 30 minutes a job runs and checks the order that are in status Openpay pending status. If returned Openpay order status is not Approved or returned Openpay plan status is not Active then order status will be changed to status Canceled.

Uninstallation

Navigate to Modules and Services > List of modules > Openpay > Configure (dropdown) > Uninstall

Version Control Table

# Date Version Description
1 Month/Year 1.0 Created payment plugin