Skip to main content

Westpac PayWay

Overview​

Westpac is Australia's most trusted payment processing provider. Mageplaza Westpac PayWay extension will help you use Westpac to support online payment by card. Your customers can pay with Visa and Mastercard by default and can pay with American Express, Diners Club and JCB after being activated by Westpac. Mageplaza Westpac PayWay extension is fully compatible with Mageplaza One Step Checkout.

How to use​

1. Guides on Account registration​

  • Westpac: to register for a Westpac account, access this link and filling in the required information below:
    • Note: At PCI-DSS, please select My system meets PCI-DSS compliance for storing credit card numbers to be able to use Westpac PayWay Classic Credit Card API.

  • After registration, the system will send login name and password to the email you registered:

  • Open your registered mail and get your login name and password.

  • After Sign in, the system will ask you to change the password

Finally, the system will ask you to answer 2 security questions to finish logging in.

2. How to get REST API Publishable Key, REST API Secret Key and Merchant ID​

  • At the Westpac interface, click REST API > REST API Keys.

  • Click View to get the REST API Publishable Key and the REST API Secret Key to fill in Configuration (will be guided below)

  • At the interface of Westpac, continue to click Administration> Merchants then get Merchant ID to fill in Configuration (will be instructed below)

3. How to get Biller Code, Security Username, Security Password, Encryption Key​

  • At the Westpac interface, click Setup Net > Hosted Payment Page, then select Bill Payments/Shopping Cart and Next

  • You continue clicking Next and follow the system requirements, then the system will send information of Biller Code, Security Username, Security Password, Encryption Key

  • Continue selecting Next to end the action.

4. How to get API Security Username and API Security Password​

  • At the interface of Westpac, click Setup API > Security, the system displays the security information including username and password.

  • Continue clicking Setup API > Certificate, at Choose your API Technology select PHP and download the file to fill in the Configuration section.

5. Page Checkout​

  • Checkout page: choose payment method with Westpac PayWay. Enter credit card information including: Card Number, Security Code, Name on Card, Expiration. There are 3 payment methods of Westpac PayWay: PayWay Net Trust Frame, PayWay Net Hosted Page, PayWay Classic Credit Card API.

  • PayWay Trust Frame

  • PayWay Net Hosted Page

  • PayWay Classic Credit Card API

  • You can check the checkout process with the following Cards:

Use the following credit card numbers with your test facility. The cardholder name does not matter.

 

Card Number

Security Code

Expiry

Response

4564710000000004

847

02/29

08 Visa Credit Approved

4564030000000007

847

02/20

08 Visa Debit Approved

5163200000000008

070

08/20

08 Mastercard Credit Approved

5163610000000008

847

02/20

08 Mastercard Debit Approved

2221000000000009

009

01/20

08 Mastercard Approved

  • To find out more, please visit here.

How to Configure​

Login to the Magento Admin, choose Stores > Configuration > Sales > Payment Methods

At Westpac PayWay Payment Method, click Configure

1. Credentials​

  • Merchant ID:
    • Copy and paste Merchant ID got before to this field.
    • If left blank or fill in incorrectly ID, the system will not connect to the payment methods.
  • REST API Publishable Key:
    • Copy the REST API Publishable Key got before to this field.
    • If left blank or entered incorrectly, it will not connect to PayWay Net Trusted Frame.
  • REST API Secret Key:
    • Copy the REST API Secret Key got before to this field.
    • If left blank or entered incorrectly, it will not connect to PayWay Net Trusted Frame, PayWay Net Hosted Page, PayWay Classic Credit Card API.

2. Westpac PayWay Net Trusted Frame​

  • Enable: Select Yes to enable PayWay Net Trusted Frame payment features.
  • Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
  • Payment Action:
    • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer's card will always pay for the order and invoice will be created.
    • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer's card.
  • New Order Status: Select status when customer order is successful:
    • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
    • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
  • Card Types:
    • Choose 1 or more cards to be used with this payment method.
    • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
  • Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
  • Payment from Applicable Countries:
    • Select All Allowed Countries so the card payment method can be applied in all countries.
    • To restrict this payment with more conditions, see Payment Restrictions module.
    • Select Specific Countries to limit certain countries to be able to use this payment method
      • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
  • Minimum Order Total:
    • Enter the minimum order amount to display and apply PayWay Net Trusted Frame payments.
    • If the order amount is less than the value in this field, payment methods will not be shown.
  • Maximum Order Total:
    • Enter the maximum amount of order to display and apply PayWay Net Trusted Frame payments.
    • If the order amount is greater than the value in this field, the payment method will not be shown.
  • Debug Mode:
    • If Yes, diagnostic information is stored in log files on the Magento web server.
  • Sort Order:
    • Specify the display position of this payment method compared to other payment methods
    • 0 is the highest priority. Smaller numbers will be preferred to show first.

3. Westpac PayWay Net Hosted Page​

  • Enable: Select Yes to enable PayWay Net Hosted Page.
  • Biller Code: Copy the Biller Code got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • Security Username: Copy Security Username got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • Security Password: Copy Security Password got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • Encryption Key: Copy the Encryption Key got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
  • Payment Action:
    • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer's card will always pay for the order and invoice will be created.
    • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer's card.
  • New Order Status: Select status when customer order is successful:
    • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
    • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
  • Card Types:
    • Choose 1 or more cards to pay.
    • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
  • Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
  • Payment from Applicable Countries:
    • Select All Allowed Countries so the card payment method can be applied in all countries.
    • To restrict this payment with more conditions, see Payment Restrictions module.
    • Select Specific Countries to limit certain countries to be able to use this payment method
      • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
  • Minimum Order Total:
    • Enter the minimum order amount to display and apply PayWay Net Hosted Page payments.
    • If the order amount is less than the value in this field, payment methods will not be shown.
  • Maximum Order Total:
    • Enter the maximum amount of order to display and apply PayWay Net Hosted Page payments.
    • If the order amount is greater than the value in this field, the payment method will not be shown.
  • Debug Mode:
    • If Yes, diagnostic information is stored in log files on the Magento web server.
  • Sort Order:
    • Specify the display position of this payment method compared to other payment methods
    • 0 is the highest priority. Smaller numbers will be preferred to show first.

4. Westpac PayWay Classic Credit Card API​

  • Enable: Select Yes to enable PayWay Classic Credit Card API.
  • API Security Username: Copy API Security Username got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • API Security Password: Copy API Security Password got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
  • Upload Certificate File: Allowed upload file types: .pem. Leaving this blank will not allow payment by this method.
  • Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
  • Payment Action:
    • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer's card will always pay for the order and invoice will be created.
    • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer's card.
  • New Order Status: Select status when customer order is successful:
    • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
    • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
  • Card Types:
    • Choose 1 or more cards to pay.
    • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
  • Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
  • Payment from Applicable Countries:
    • Select All Allowed Countries so the card payment method can be applied in all countries.
    • To restrict this payment with more conditions, see Payment Restrictions module.
    • Select Specific Countries to limit certain countries to be able to use this payment method
      • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
  • Minimum Order Total:
    • Enter the minimum order amount to display and apply PayWay Classic Credit Card API payments.
    • If the order amount is less than the value in this field, payment methods will not be shown.
  • Maximum Order Total:
    • Enter the maximum amount of order to display and apply PayWay Classic Credit Card API payments.
    • If the order amount is greater than the value in this field, the payment method will not be shown.
  • Debug Mode:
    • If Yes, diagnostic information is stored in log files on the Magento web server.
  • Sort Order:
    • Specify the display position of this payment method compared to other payment methods
    • 0 is the highest priority. Smaller numbers will be preferred to show first.

5. Admin View Order​

This section records Credit Card information (Westpac) that customers have ordered and paid.

6. Customer View Order​

This section stores card information that customers have ordered.

7. Compatible with One Step Checkout​