This guide describes how to install and configure Openpay Payment Plugin to WordPress version 5.x. In order to use Openpay payment method, WooCommerce version 3.x should be active on your ecommerce website.
WooCommerce is a free to use plugin for WordPress. This converts a basic WordPress site into a Multi-dimensional eCommerce platform with a wide range of features, built on open source technology.
WooCommerce provides online merchants not only with a flexible shopping cart system, but also control over the look‐and‐feel of the content as well as the functionality of their online store.
WooCommerce 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 to connect with Openpay’s online payment processing platform via WooCommerce.
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.
Before installing the Openpay module, make sure that your web server meets the following criteria:
WordPress can be run on a Windows server, although this is not officially supported by WordPress. Please visit the WordPress website for details: https://wordpress.org
Log in to your WordPress admin account
Navigate to WooCommerce > Settings > Payments > Openpay > Manage
To check Orders, go to: WooCommerce > Orders > (ANY ORDER)
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 ‘Place Order‘ and it will be redirected to the Openpay Payment Gateway page. This will perform a HTTP POST request to Openpay.
If the customer is already registered with Openpay, the following screen will be displayed:
If customer does not have an Openpay account, they will need to create one.
If the customer continues to login, then the following page will be displayed
We do not email verification code on training mode please use 123456 for verification.
We do not send SMS on training mode please use 111111 for verification.
If the user clicks on Return to Shop, the browser will redirect to your website cart page.
If the user continues to login, then the following page will be displayed
If one clicks on ‘Submit Plan‘, the browser will be redirected to your site with ‘Your order has been placed’ message.
This section provides the credentials for test user and test merchant account on Openpay Training Environment to create and check your Openpay plan.
Username: testwordpress@xx.yy
Password: Testing123
https://retailer.myopenpay.com.au/training
Username: adminwoocom
Password: Test123
Pending Payment
If somehow a payment was declined or not completed after order placement, the order will be ‘Pending Payment’. Do not dispatch Openpay order on this status.
Processing
After successful payment order status will be ‘Processing’.
Complete
If the order is shipped or dispatch by admin they can change the orders status 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.
Dispatch, Shipping and Refund can be done easily from the admin panel of WordPress.
If the admin wants to ship the products, they can change the order status to ‘Shipped‘ and submit the status
Admin can initiate the refund for a single order from the backend
(Below is just an example refund amount may vary)
To process a refund, click on WooCommerce > Orders > Select the order to be refunded > Click on Refund
Enter the Refund amount > Click on Refund $XX.XX via Openpay
Enter the Reason for refund is optional
Admin can initiate the refund for a single order from the backend
(Below is just an example refund amount may vary)
To process a refund, click on WooCommerce > Orders > Select the order to be refunded > Click on Refund
Enter the Partial Refund amount > Click on Refund $XX.XX via Openpay
Enter the Reason for refund is optional
Under Orders it shows the partially refunded amount.
Navigate to Dashboard > Plugins > Openpay Payment Method for WooCommerce > Deactivate
| # | Date | Version | Description |
|---|---|---|---|
| 1 | September 2017 | 1.1 | Created payment plugin |
| 2 | July 2019 | 5.2 | Updated payment plugin to API 5.2 |
| 3 | September 2019 | 5.5 | Updated payment plugin to API 5.5 |
| 4 | July 2020 | 5.5.1 | Message Updated on Thank you page reload |
