Flash sale: Get up to 30% off themes and extensions. Ends April 26 at 3 pm UTC. Shop the sale.
  1. Documentation /
  2. Westpac PayWay NET Payment Gateway

Westpac PayWay NET Payment Gateway

The Westpac PayWay NET Payment Gateway allows you to use Westpac PayWay NET as a credit card processor via their shopping cart process (see note). This gateway also works with St. George bank. Process Visa and Mastercard by default, and optionally accept American Express, Diners Club and JCB after further activation by Westpac. This gateway supports two integration methods. Trusted Frame is the newer and preferred integration. The gateway generates a credit card form in an iFrame on your checkout page. The disadvantage is that it is slightly harder to style (though you can add custom styles via the plugin configuration). Direct Post is the older integration method and is easier to style, however requires the credit card collection to take place on a separate page after the checkout page. In both integration methods, the customer’s credit card details are sent directly from your site page to the bank’s servers via a secure connection without any credit card details coming in contact with your server, so no need to worry about complex PCI compliance. Note: Another extension is available if you wish to use the more seamless Westpac PayWay API integration. Learn more about Westpac PayWay and the different integration types at: https://www.payway.com.au/core/AboutView

Requirements

↑ Back to top

  • An active PayWay merchant account
  • An SSL certificate
  • AUD set as your store currency

Installation

↑ Back to top
  1. Purchase and download the plugin zip file from WooCommerce.com.
  2. Log in to your WordPress Admin and click Plugins | Add New from the left hand menu.
  3. Click Upload, then browse to select the zip file from your computer. Once selected, click OK and then Install Now.
  4. Activate the plugin.

Setup and Configuration

↑ Back to top

Westpac PayWay – using Trusted Frame (recommended)

↑ Back to top
  1. Log into your Westpac PayWay administration tool (http://payway.com.au) and click on your biller code on the top menu (the cog icon).
  2. Under Access to PayWay, click on REST API Keys
    • Click Add at the bottom of the table.
    • Choose “Publishable” and click Save.
    • Copy and store the full API Key shown as you will need to enter it in the gateway settings. Click Back.
    • Click Add at the bottom of the table again.
    • Choose “Secret” and click Save.
    • Copy and store the full API Key shown as you will need to enter it in the gateway settings. Click Back.
Note that your Secret API Key will expire 2 years after it is created, however the plugin will automatically create and save a new Secret API Key when the existing key will expire, however you can always generate new keys and manually replace them in the gateway settings.

Westpac PayWay – using Direct Post (older)

↑ Back to top
  1. Log into your Westpac PayWay administration tool (http://payway.com.au) and click on your biller code on the top menu (the cog icon).
  2. Under PayWay Modules, click on PayWay Net.
  3. Click on Setup Hosted Payment Page.
  4. Select the Bill Payments/Shoping Cart – secure shopping cart handoff method option and click Next.
  5. Copy and store your PayWay Biller Code, you will need it later. Click Next.
  6. If you wish to receive an email from PayWay for every payment, enter your email address under Merchant Notification Email.
  7. Optionally tick Allow Customer Receipt Email if you wish to send notification emails from PayWay directly to the customer.
  8. You do not need to enter Browser Return or Server-To-Server Payment Notification options as the plugin will provide them at the time of payment. Click Next.
  9. Copy and store your Encryption KeyUsername, and Password. You will need them all later.
  10. You must enter your web server’s IP address in the list at the bottom of the page. Without doing so, all payments will fail. If you aren’t sure what your web server’s IP address is, you can obtain it by going to the plugin settings page in WooCommerce and look for the phrase “Your server’s IP address is:”. If you continue to have problems, try using a wildcard address (eg. “123.123.123.0/24” will allow all addresses from 123.123.123.0 to 123.123.123.255).
  11. No configuration is required on the Customer Reference Number page. Click Next.
  12. You do not need to set Payment Amount Limits, however you may set them if they apply in your case. Click Next.
  13. Optionally, configure Card Scheme Surchargesor leave blank. Click Next.
  14. Ensure you have copied the PayWay Biller Code, Encryption Key, Username and Password. If you don’t have all of these, run through these steps again.

Configure PayWay Net plugin settings

↑ Back to top
  1. Go to: WooCommerce > Settings > Payments and click Set up in the Westpac & St. George PayWay Net row.
  2. Enter and select options:
    • Tick Enable this payment method.
    • Choose which API method you wish to use. For an overview of each, view the PayWay documentation provided by your bank. Generally, Trusted Frame is the recommended option. Note that the settings you must provide will change based on which API method you provide.
    • Enter a Title, which is displayed to customers for this payment option. i.e., Westpac PayWay or Credit Card.
    • Choose which bank your merchant account is with.
    • Enter your Merchant ID, as provided by your bank.
    • Optionally, enable reCAPTCHA if you want to display the reCAPTCHA on the credit card page. This can help combat fraudulent card test. If you enable reCAPTCHA, you will need to provide a reCAPTCHA site key, available from Google.
    • Enter your payment credentials (API keys, biller code, username/password, encryption key, depending on the API method chosen) as provided by the PayWay administration tool.
    • If you’re using Trusted Frame, you can optionally add a set of styles to modify the display of the credit card form. Refer to the documentation for more information.
    • Tick American Express, Diners Club or JCB, if you have arranged with PayWay to accept these cards, which will display for customers as options on the payment screen.
  3. Save changes.

Test card details

↑ Back to top
In test mode, you can use a number of credit card details to test different transaction statuses. Refer to the Payway online documentation for a full up to date list.

FAQ

↑ Back to top
Does Westpac PayWay NET support St. George? Yes, St. George will work with this extension. Which integrations/APIs does this gateway support? This gateway supports PayWay NET Direct Post (also called Shopping Cart) and Trusted Frame.

Questions & Support

↑ Back to top
Have a question before you buy? Please fill out this pre-sales form. Already purchased and need some assistance? Get in touch the developer via the Help Desk.