Locate your User ID

Overview

Your user ID is unique to your OnlinePay account and is used to authenticate your requests to the OnlinePay API. It ensures that the user making an API request has sufficient permissions to perform the requested action, and also helps to track API usage and monitor for any suspicious activity.

⚠️

Before you disable or delete a user from your OnlinePay account, ensure any associated API keys that are in use are replaced with keys associated with another user. If you disable or delete a user, any API keys associated with that user will no longer be valid, and any requests made using those keys will fail. This includes API keys used for API integration or plugins that you may have set up to work with OnlinePay.

See Set up users and roles for more information about user roles and their permissions.

Retrieve your User ID

You can find your unique user-uid in the OnlinePay dashboard:

  1. Navigate to My Account in the OnlinePay dashboard under your user profile icon in the top right corner.

  2. Find your User ID string in your General information panel, then click the copy icon to copy the string to your device clipboard.

  3. Save the UUID value as a userId variable in your REST API client.

    Alternatively, you can pass the UUID in your request header if using cURL.



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.