Skip to main content

Root API

This is an object representing the top level of the REST API.

To test your network connectivity and API credentials are working correctly, send a GET to this resource.

Get

Request

GET /

Request body

None.

Response

If successful, this method returns the following in the response body.

Field Format Data
links Array of Links Links to related resources and documentation.
buyerCode string The PaymentsPlus buyer code for your facility.
buyerName string The PaymentsPlus buyer name for your facility.
keyName string The name of the API key you sent.

Root response example

{
   "links": [],
   "buyerCode":"<YOUR_FACILITY_CODE>",
   "buyerName":"<YOUR_FACILITY_NAME>",
   "keyName":"<YOUR_KEY_NAME>"
}

HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
403 FORBIDDEN Your facility may not be set up. View more.
407 PROXY AUTHENTICATION REQUIRED This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.
Disclaimer

The information contained in this publication is provided for learning purposes only and is subject to change. Revisions may be issued from time to time that encompass changes or additions to this module.

This is a guide only and it is not comprehensive. It does not impinge on or overrule any formal arrangement you may enter into with the Bank. The Bank and its officers shall not have any liability for any losses of any kind incurred in connection with any action, inaction or decision taken in reliance on the information herein or for any inaccuracies, errors or omissions. In this publication references to the "Bank" are to Westpac Banking Corporation ABN 33 007 457 141 and to any of its operating Divisions, including BankSA and St.George.