Health Check API

You can use this API to test you are able to successfully connect to the DSG.

This API has the following endpoints:

• GET {serverUrl}/healthcheck/v1/heartbeat Use this endpoint to make a request to check your connection to the DSG
• GET {serverUrl}/healthcheck/v1/clients/ABN/{abn_business}/individuals/TFN/{tfn_individual}/heartbeat Use this endpoint to make an authorized request to check your connection to the DSG using the payer ABN in sandbox environment
• GET {serverUrl}/healthcheck/v1/clients/WPN/{wpn_business}/individuals/TFN/{tfn_individual}/heartbeat Use this endpoint to make an authorized request to check your connection to the DSG using the payer WPN in sandbox environment
• GET {serverUrl}/healthcheck/v1/ Use this endpoint to give the current version and status of the healthcheck API
• GET {serverUrl}/healthcheck/v1/specs/yaml Use this endpoint to view the Healthcheck Open API specification in YAML format
• GET {serverUrl}/healthcheck/v1/specs/spec.yaml Use this endpoint to download the Healthcheck Open API specification in YAML format

Note: {serverUrl}/healthcheck/v1/heartbeat endpoint will check your connection to the DSG via authentication but not authorization. The following endpoints {serverUrl}/healthcheck/v1/clients/ABN/{abn_business}/individuals/TFN/{tfn_individual}/heartbeat and {serverUrl}/healthcheck/v1/clients/WPN/{wpn_business}/individuals/TFN/{tfn_individual}/heartbeat will check your connection to the DSG via authentication and authorization.

For more in-depth information refer to the endpoint paths in the specifications below around the use of the endpoints and desired input path and query parameters.