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.
Westpac Privacy Statement

Privacy Statement (for individuals whose personal information may be collected - in this clause referred to as "you"). All personal information we collect about you is collected, used and disclosed by us in accordance with our Privacy Statement which is available at Privacy Statement or by calling us through your relationship manager or Westpac representative. Our Privacy Statement also provides information about how you can access and correct your personal information and make a complaint. You do not have to provide us with any personal information but, if you don't, we may not be able to process an application or a request for a product or service.