API Reference

The KeyPay API is a REST/JSON based API.

Obtaining your API Key

To use the KeyPay API, you need to authenticate with your API key which can be found by following the steps below:

  1. Log into KeyPay
  2. Click your username in the top right-hand corner
  3. Click ‘My Account’
  4. Click ‘Generate API Key’
Authenticating Requests

All KeyPay API requests are authenticated via basic HTTP authentication where the username is your API Key and the password is empty. Here are a couple of examples of supplying authentication information for API Key “APIKEY_VALUE”:

Curl (command line)
curl -u APIKEY_VALUE: https://api.yourpayroll.com.au
RestSharp (.NET)
new RestClient
{
    BaseUrl = baseUrl,
    Authenticator = new HttpBasicAuthenticator("APIKEY_VALUE", "")
};

API Operations

A list of API operations supported by the KeyPay API is shown below.

Note: All API operations should be prefixed by https://api.yourpayroll.com.au/api/v2 . For example, /business would resolve to https://api.yourpayroll.com.au/api/v2/business