Find your Organisation ID (Entity ID)

Overview

Your Organisation ID, or Entity ID, is a unique identifier that matches the organisation associated with the API key to your OnlinePay account. It is used to identify which organisation you are making API requests for, and it is important to use the correct Organisation ID in your API requests to ensure that you are using the correct settings and configurations for your account.

The identifier is called Organisation ID in the OnlinePay dashboard, but the same identifier is used as the entity_id when making API request

Entity ID

1. In your OnlinePay dashboard, navigate to Administration > Account Setup > Organisation.

2. Click the name of the organisation or site that you want to use for your API request.

3. On the organisation General information page, copy the Organisation ID and save it to your preferred REST API client as an environment variable or save it in a secure location for use when making requests using cURL.