Guides
Dashboard Login

Getting Started with the OnlinePay APIs

Overview

This documentation will help you to set up your Checkout facilities and take online payments with OnlinePay API.

It covers what you need to know in order to decide on which integration method is best for you, where to find the essential information like URLs, and how to authenticate with our API.

API keys are used to authenticate your requests to the OnlinePay API. They are unique identifiers that allow you to access the API and perform actions on behalf of your account, such as installing plugins, creating payment links, and managing transactions. To use the API, you need to create an API key and set up your environment variables.

Environment variables are other unique identifiers that are used to store other sensitive information, such as your user ID, payment provider contracts, and 3D Secure contract. These variables are used in conjunction with your API key to authenticate your requests and ensure that you have the necessary permissions to perform the actions you want.

Updated 2 days ago

St. George BankSA Bank of Melbourne

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.

© St.George, Bank of Melbourne and BankSA – Divisions of Westpac Banking Corporation ABN 33 007 457 141 AFSL and Australian credit licence 233714.