1. Download the Postman Collection

Click the Download Postman button at the top of the Documentation page of the relevant product to download the Postman Collection.

A zipped JSON file will be downloaded on to your computer that contains the Postman Collection. Unzip the file and save the contents in a convenient location.

2. Open the file in Postman

Open Postman on your computer and import the JSON file by following these steps:

1. In Postman, click File > Import
2. Remaining in the File tab, click Upload Files
3. Navigate to where you saved the Postman Collection. Select the file and click Open
4. You will now see a new Collection has been created in your left menu. Click the dropdown arrow to view all the available operations. The Headers, Body and URL will be prepopulated with the required information.

3. Generate an Access Token

OAuth 2.0 is an open standard for authorisation and it is used to provide your applications with secure delegated access. OAuth 2.0 works over HTTP and authorises devices, APIs, servers and applications with access tokens rather than credentials.

Before testing the API you will need to set the authorisation by following these steps:

1. In Postman, select the OAuth method in the left panel
2. All necessary fields should be populated for you
3. Click Send and you should receive a 200 success response
4. You will see your access token in the access_token key of the JSON object received in the response, as seen in the image below
5. Copy the access token to authorise your requests

Please note, the access tokens in the sandbox environments are valid for 24 hours, after which you will have to generate a new access token below to continue testing.