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

Do the following steps to retrieve your unique user-uid.

1. Navigate to My Account in the OnlinePay dashboard.

2. Copy the string in the URL following /users/.

   

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.