Integration methods

OnlinePay allows you to accept payments using multiple methods. There are several integration methods to choose from depending on how you want to accept online payments:

Integration methodDescriptionPCI compliance
Hosted Payments Page (HPP)Full page redirect to OnlinePay serversSAQ A
iFrameRender a OnlinePay hosted form on your websiteSAQ A
Pay by LinkSend payment links to your customers manually or automate with an APISAQ A
Server-to-Server APIPerform API calls to capture customer payment information and place ordersSAQ D

This documentation covers the information you need to know to interact with our APIs and start taking online payments, as well as information about how to accept payments using server-to-server REST API calls to capture customer details, payment information, and place orders. REST API uses RESTful architecture, or Representational State Transfer, which allows you to exchange information reliably and securely through application programming interface (API) requests.

Depending on your familiarity with using APIs, you may want to use an API client, such as Postman or Insomnia , so that you can easily capture and store variables. Alternatively, you can make cURL requests directly from the command line or use our API Reference documentation



Did this page help you?

Terms and conditions Website requirements Other fees and charges

This information is a general statement for information purposes only and should only be used as a guide. While all care has been taken in preparation of this document, no member of the Westpac Group, nor any of their employees or directors gives any warranty of accuracy or reliability nor accepts any liability in any other way, including by reason of negligence for any errors or omissions contained herein, to the extent permitted by law. Unless otherwise specified, the products and services described are available only in Australia.

Visa is a registered trademark of Visa International Service Association. Mastercard® is a registered trademark of Mastercard International Incorporated. American Express® is a registered trademark of American Express. UnionPay is a trademark of UnionPay International Co. Ltd.
Apple, the Apple logo, Apple Pay, Apple Watch and iPhone are trademarks of Apple Inc., registered in the U.S. and other countries. App Store is a service mark of Apple Inc. Google Pay™ is a trademark of Google LLC.
Bluetooth® is a registered trademark owned by Bluetooth SIG, Inc. and use of the mark by Westpac is under license.

© Westpac Banking Corporation ABN 33 007 457 141 AFSL and Australian credit licence 233714.