BigCommerce – Openpay Payment App

Integration Guide

Introduction

Installing and Configuring Openpay Payment App

Multi-User Support

A single store can have multiple users that can log in to assist with the day-to-day functions of managing a store or for a specific role. Each user should have their own account, with permissions limited to only their areas of responsibility.

On BigCommerce, there are a few pre-made sets of user roles, or you can select the permissions you want to grant.

Since, Openpay app provides multi-user support which allows store admins to manually authorise users – other than the store owner – to use the app. This can be done after installing the Openpay app in the store from the create/edit user page by selecting the ‘Openpay’ option in the ‘Single Click Apps’ box and save the user as shown below in the screen. This setting allows the store owner to grant individual users access to the app and makes the app available from that user’s control panel.

‘User Permissions’ page will be shown to the store owner role only, and the authorised user(s) who have loaded the Openpay app for at least once in their control panel will be listed there. From the ‘User Permissions’ page, store owner can restrict the authorised user(s) to access some or all the pages of the app in their control panel by just deselecting the checkbox. The screen given below shows that the user account i.e testuser@example.com will have access to all of the app pages so they can change the Openpay Configuration. The user can also do refunds of the Openpay Orders and  view the Refund History as well.

Revoke the User Access

From the Edit User page, store admin can revoke a user’s access to the app revoke the user’s access by deselecting the ‘Openpay’ option in the ‘Single click Apps’ box and save the user. Once the user access is revoked, they would be removed from the ‘User Permissions’ page for the store owner.

Demo Site

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

Demo Site

Testing Credentials

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 for creating a plan on Openpay

Username: bigcommerce@xx.yy
Password: Testing123

Test Retailer’s Account to check plan created on Openpay’s Retailer’s Portal

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

BigCommerce Order Status

Please share the information below with your team who looks after orders, dispatch and refunds. 

Pending
Customer started the checkout process but did not complete it. Incomplete orders are assigned a ‘Pending’ status and can be found under the More tab in the View Orders screen.

Awaiting Fulfilment
Customer has completed the checkout process and payment has been confirmed.

Awaiting Payment
Customer has completed the checkout process, but payment has yet to be confirmed. Authorise only transactions that are not yet captured have this status.

Completed
Order has been shipped/picked up, and receipt is confirmed; client has paid for their digital product, and their file(s) are available for download.

Cancelled
Seller has cancelled an order, due to a stock inconsistency or other reasons. Stock levels will automatically update depending on your Inventory Settings. Cancelling an order will not refund the order. This status is triggered automatically when an order using an authorize-only payment gateway is voided in the control panel before capturing payment.

Partially Refunded
Seller has partially refunded the order.

Refunded
Seller has used the Refund action. A listing of all orders with a ‘Refunded’ status can be found under the More tab of the View Orders screen.

Download BigCommerce – Order Status – Dispatch – Refunds

Refund Orders

Refunds can be made on Orders with order status Awaiting Fulfilment and Completed.

Note: Refunding a successful Openpay order is a two-step process, first from Openpay App and second from BigCommerce Dashboard.

From BigCommerce Dashboard navigate to Apps > Openpay and click on ‘Refund’ option on the left sidebar.

Enter Order ID and Refund Amount, then hit ‘Refund’.

Confirm refund amount on the confirmation pop-up.

Refund success message will show up like below.

‘The Order has been refunded by Openpay.’

Now click ‘Refund the order in BigCommerce’ button, this will automatically redirect you to the BigCommerce refund screen.

Note: If you are not automatically redirected to BigCommerce refund screen, navigate to ‘Orders’, find the Order ID that matches with the recently refunded on Openpay app and under ‘Action’ click on the ‘Refund’ option. 

All successful refund cases will be stored in the ‘Refunded History’.

Now refund order amount in BigCommerce Order Management.

Under Refundable items select ‘Apply an order level refund’ and input the refund amount based on the data in the ‘Refunded History’ chart on Openpay app.

Enter the same Amount to be refunded as added on Openpay app and click Continue

Note: If you see the message ‘Failed to refund. Plan status is not Active’, please contact Openpay for more support as the Openpay plan might not be complete.

Partial and Full Refunds

• For Partial Refund select Apply an order level Refund
• For Full Refund select Refund entire order

Select ‘Refund customer through third party provider’ as the refund method and click ‘Confirm Refund’ button to finish.

Note: This action will not trigger a refund action to Openpay again.

This will successfully update the order information.

Uninstalling Openpay Payment App

Navigate to Apps > My Apps > Openpay > click Uninstall

Remove the previously added scripts i.e. Openpay Javascript file.

Navigate to Storefront > Script Manager > Installed Scripts > look for Openpay click on the three dots on the right side > Delete

Remove the previously added Offline Payment Method of Openpay.

Navigate to Store Setup > Payments > Offline Payment Methods section, disable the payment method previously set up for Openpay.

Version Control Table