GST Property Settlement API Test Scenarios

Last modified

04 Jun 2026

Overview

The test scenarios provided in the sandbox environment are to help you test the use of the GST Property Settlement API in your application software.

If you follow the instructions below, you will get the mocked responses as described. Otherwise, you will receive an error with http status 404, an error code GSTPS.00000 and a message “The requested test scenario does not exist”.

You can run the test using either the desktop app or the cloud app (OSP). Refer to Test credentials that have already been configured for sandbox testing.

The following test scenarios are a mandatory requirement before production access is granted.
Test Scenario 1 – Representative submits a valid request to lodge GST Property Settlement Withholding Notification (Form 1)
Test Scenario 2 – Representative submits a valid request to lodge GST Property Settlement Date Confirmation (Form 2)
Test Scenario 3 – Representative submits a request to validate Lodgment data for GST Property Settlement Withholding Notification (Form 1)
Test Scenario 4 – Representative submits a request to validate Lodgment data for GST Property Settlement Date Confirmation (Form 2)
Test Scenario 5 – Representative submits a valid request to lodge GST Property Settlement Withholding Notification (multiple properties, purchasers, suppliers)
Test Scenario 6 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) due to missing email information
Test Scenario 7 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs when the prerequisite check is not met

Other test scenarios provided are recommended testing to ensure an optimal user experience. In addition to these scenarios, developers are free to conduct further validation testing against the API-specific response messages outlined in the relevant API documentation, without the need for setting up test data.
Test Scenario 8 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) with system exception error
Test Scenario 9 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs with system exception error
Test Scenario 10 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) with processing error from ATO systems
Test Scenario 11 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs with processing error from ATO systems

Test Scenario 1 – Representative submits a valid request to lodge GST Property Settlement Withholding Notification (Form 1)

Test case purpose: Purchaser’s Representative successfully submits a GST Property Settlement Withholding Notification (Form 1) request and receives a Lodgment Reference Number and a Payment Reference Number.

Upon successful API submission, Http status code 201 and a transaction receipt number are returned in the response header. A Lodgment Reference Number (transaction receipt number) and a Payment Reference Number will be provided in the response payload.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock John

Response information

Response type: Informational Message
HTTP status: 201
HTTP reason: Created
HTTP header: receipt: 6300000000001 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "data": {
   "lodgmentReferenceNumber": "6300000000001",
   "paymentReferenceNumber": "123456789012345678"
 }
}

Note: Payment Reference Number is a random number returned in the mock response. In production, the PRN is generated as an unique number for each successful lodgment.

Test Scenario 2 – Representative submits a valid request to lodge GST Property Settlement Date Confirmation (Form 2)

Test case purpose: Purchaser’s Representative successfully submits a GST Property Settlement Date Confirmation (Form 2) request.

Upon successful API submission, Http status code 204 and a transaction receipt number are returned in the response header.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/changeOfPropertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock John
lodgmentReferenceNumber: use the Lodgment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)
paymentReferenceNumber: use the Payment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)

Response information

Response type: Informational Message
HTTP status: 204
HTTP reason: Created
HTTP header: receipt: 6300000000002 (This is an example only. A unique number will be generated at the time of the testing)
Payload: none

Test Scenario 3 – Representative submits a request to validate Lodgment data for GST Property Settlement Withholding Notification (Form 1)

Test case purpose: Purchaser’s representative successfully validates the lodgment data for a GST Property Settlement Withholding Notification (Form 1) request.

Upon successful API submission and no validation errors are found, Http status code 204 and a transaction receipt number are returned in the response header. The request payload is considered valid; however, no lodgment or downstream processing occurs.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements/validationResults
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Joe

Response information

Response type: Informational Message
HTTP status: 204
HTTP reason: Created
HTTP header: receipt: 6300000000003 (This is an example only. A unique number will be generated at the time of the testing)
Payload: none

Test Scenario 4 – Representative submits a request to validate Lodgment data for GST Property Settlement Date Confirmation (Form 2)

Test case purpose: Purchaser’s representative successfully validates the lodgment data for a GST Property Settlement Date Confirmation (Form 2) request.

If the request has invalid data, validation errors would be returned. See the list of validation errors in Response Messages. If the request has passed the validation check and no errors are found, Http status code 204 and a transaction receipt number are returned in the response header. The request payload is considered valid; however, no lodgment or downstream processing occurs.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/changeOfPropertySettlements/validationResults
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Joe
lodgmentReferenceNumber: use the Lodgment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)
paymentReferenceNumber: use the Payment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)

Response information

Response type: Informational Message
HTTP status: 204
HTTP reason: Created
HTTP header: receipt: 6300000000004 (This is an example only. A unique number will be generated at the time of the testing)
Payload: none

Test Scenario 5 – Representative submits a valid request to lodge GST Property Settlement Withholding Notification (multiple properties, purchasers, suppliers)

Test case purpose: Purchaser’s Representative successfully submits a Property Settlement withholding notification (Form 1) for a property purchase transaction involving multiple properties, purchasers and suppliers.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: MS Mock Alice
Property 1: eg 10 Somewhere Road, Wetshore, WA 6030 Australia
Property 2: eg Unit 1 3 Somewhere Road, Wetshore, WA 6030 Australia
Purchaser 1: an Individual who owns 30%
Purchaser 2: an individual who owns 20%
Purchaser 3: non-individual who owns 50%
Supplier 1: an individual withholding proportion amount $10,000
Supplier 2: non-individual withholding proportion amount $5,000

Response information

Response type: Informational Message
HTTP status: 201
HTTP reason: Created
HTTP header: receipt: 6300000000005 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "data": {
   "lodgmentReferenceNumber": "6300000000005",
   "paymentReferenceNumber": "123456789012345678"
 }
}

Note: Payment Reference Number is a random number returned in the mock response. In production, the PRN is generated as an unique number for each successful lodgment.

Test Scenario 6 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) due to missing email information

Test case purpose: A representative submits a GST Property Settlement Withholding Notification (Form 1) request. It fails as email confirmation is indicated true, but email is not provided. The lodgment submission is unsuccessful.

Http status code 422 and an error GSTPSWN.00002 are returned. No lodgment or downstream processing occurs.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Alexender
emailCorrespondenceIndicator: true
electronicMailAddress: Not provided

Response information

Response type: Error
HTTP status: 422
HTTP reason: Unprocessable Entity
HTTP header: receipt: 6300000000006 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "GSTPSWN.00002",
     "detail": " Email address must be provided if indicator to receive ATO confirmation via email is true",
     "source": {
       "pointer": "/contactDetails/electronicMailAddress"
     }
   }
 ]
}

Test Scenario 7 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs when the prerequisite check is not met

Test case purpose: A representative submits a GST Property Settlement Date Confirmation (Form 2) request. It fails as the prerequisite check is not met. The lodgment submission is unsuccessful.

Http status code 422 and an error GSTPSDC.00001 are returned. No lodgment or downstream processing occurs.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/changeOfPropertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Steve
prerequisiteCheckIndicator: false
lodgmentReferenceNumber: use the Lodgment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)
paymentReferenceNumber: use the Payment Reference Number provided from the prior successful submission of Form 1 (GST Property Settlement Withholding Notification)

Response information

Response type: Error
HTTP status: 422
HTTP reason: Unprocessable Entity
HTTP header: receipt: 6300000000007 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "GSTPSDC.00001",
     "detail": "The GST property settlement withholding notification must be completed prior to submission of GST property settlement Date Confirmation",
     "source": {
       "pointer": "/prerequisiteCheckIndicator"
     }
   }
 ]
}

Below are some additional test scenarios available for your testing. These are not mandatory to obtain production access.

Test Scenario 8 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) with system exception error

Test case purpose: A representative submits a GST Property Settlement Withholding Notification (Form 1) request. A system exception (API internal server error) occurred.

Http status code 500 and an error GSTPS.ERROR are returned.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock James
GSTPropertySettlementWithholdingNotificationRequest: a valid request payload

Response information

Response type: Error
HTTP status: 500
HTTP reason: Internal Server Error
HTTP header: receipt: 6300000000008 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "GSTPS.ERROR",
     "detail": "Your request cannot be processed. Please try again later. If the problem persists, please contact ATO."
   }
 ]
}

Test Scenario 9 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs with system exception error

Test case purpose: A representative submits a GST Property Settlement Date Confirmation (Form 2) request. A system exception (generic internal server error) occurred.

Http status code 500 and an error 500-01 are returned.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/changeOfPropertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock David
GSTPropertySettlementDateConfirmationRequest: a valid request payload

Response information

Response type: Error
HTTP status: 500
HTTP reason: Internal Server Error
HTTP header: receipt: 6300000000009 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "500-01",
     "detail": "internal server error"
   }
 ]

Test Scenario 10 – Unsuccessful submission of GST Property Settlement Withholding Notification (Form 1) with processing error from ATO systems

Test case purpose: A representative submits a GST Property Settlement Withholding Notification (Form 1) request. A processing error occurred from ATO systems.

Http status code 422 and an error GSTPSWN.EMxxxxx (where xxxxx is a 5 digitals numeric code) are returned.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/propertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Paul
GSTPropertySettlementWithholdingNotificationRequest: a valid request payload

Response information

Response type: Error
HTTP status: 422
HTTP reason: Unprocessable Entity
HTTP header: receipt: 6300000000010 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "GSTPSWN.EMxxxxx",
     "detail": "Your request cannot be processed. Please try again later. If the problem persists, please contact ATO."
   }
 ]
}

Test Scenario 11 – Unsuccessful submission of GST Property Settlement Date Confirmation (Form 2) occurs with processing error from ATO systems

Test case purpose: A representative submits a GST Property Settlement Date Confirmation (Form 2) request. A system exception (generic internal server error) occurred.

Http status code 422 and an error GSTPSDC.EMxxxxx (where xxxxx is a 5 digitals numeric code) are returned.

Request information

Test Endpoint: https://sandbox.api.ato.gov.au/propertySettlementGoodsServicesTax/v1/clients/ABN/{identifierValue}/changeOfPropertySettlements
where {identifierValue} must be the same ABN used to generate the Access Token to call the API
HTTP verb: POST
lodgedBy: REPRESENTATIVE
ContactDetails: Mr Mock Luke
GSTPropertySettlementDateConfirmationRequest: a valid request payload

Response information

Response type: Error
HTTP status: 422
HTTP reason: Unprocessable Entity
HTTP header: receipt: 6300000000011 (This is an example only. A unique number will be generated at the time of the testing)
Payload:

{
 "errors": [
   {
     "code": "GSTPSDC.EMxxxxx",
     "detail": "Your request cannot be processed. Please try again later. If the problem persists, please contact ATO."
   }
 ]
}

Go back to Property Settlement Service