HTTP API (Legacy)


Important: API Channel Activation for New Accounts and Sub-Accounts

When you create a new Account or Sub-Account, please be aware that by default, no API channels will be active. To enable API access and manage your Accounts and Sub-Accounts' API credentials and settings, please follow the steps outlined in the "API Keys" page.

Note for Accounts Created Before 6 June 2023: If you have an Account that was created before 6 June 2023, the API channels would have been automatically enabled. However, if you wish to switch to an alternative API or use additional APIs, you will need to create an API Key for the desired API.


The page can be referenced at

We do offer HTTP communication, however HTTPS is recommended. To use SSL please replace https with http in all URLs mentioned in this guide. All functions require the following information:

  • Type
  • Username
  • Password

The “Type” defines what function you wish to execute.
The output is XML based and will always contain the following:



Please Note:

Where XML data is passed the data between the xml tags should be URL encoded.

The following symbols need to be replaced if you’re using the “Get” method.

SymbolReplace With