Authentication and environment variables

Overview

This section provides information about how to create an API key, set up your environment variables, and use them in your API requests, as well as information about the authentication method used by the OnlinePay API.

Authentication

OnlinePay's API uses the Basic authentication method to secure REST API requests. Basic authentication sends HTTPS requests with an Authorization header containing Base64-encoded strings as a username and password.

These encoded keys are passed in the API request header in the following format:

Authorization: Basic {user-uid}:{api-key}

Replace the {user-uid} and {api-key} values with your own keys.

Environment variables

Variable
Base URLhttps://au.gsc.verifone.cloud/
API KeyCreate an API Key
User IDRetrieve your User ID
Payment Provider ContractsPayment Provider Contracts
3DS Contract3DS Contract
Entity IDEntity ID


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.