Skip to main content

Migrating from ClickSuper API v4.5 to WRKR PAY STP2 API

Matt
  • Updated

Introduction

To support STP2 payloads, our ClickSuper API customers will be required to transition to our WRKR PAY API.

More information on Wrkr: As you may be aware InPayTech Limited was renamed to Wrkr Limited and incorporates ClickSuper services. We are building an exciting roadmap with our Wrkr solutions and ClickSuper will be transitioned to Wrkr Pay in the future. For more information on Wrkr and Wrkr Pay, please visit: www.wrkr.com.au

 

STP1 ClickSuper API v4.5 Process

Ref: ClickSuper API Specification 4_5_10

API Summary:

  • REST-based

  • Security: OAuth 2.0 (all calls are secured with a Bearer token Authorization header, except retrieving the Token)

Sequence:

#

Action

Response

Comment

1

POST Username, Password, grant_type to https://services.inpaytech.com.au/api/token

JSON with access_token

Standard OAuth 2.0 call to get token

2

POST payload to https://services.inpaytech.com.au/api/4.5/stp/submit

JSON with upload to ClickSuper success

 

3

GET ABN, Branch, InterchangeId to https://services.inpaytech.com.au/api/4.5/stp/status

JSON with status

 

 

STP2 WRKR PAY API Process

1. Registration

Contact Samantha Ioane on sam.ioane@wrkr.com.au for credentials.

 

2. API Summary

    • REST-based
    • Security: OAuth 2.0 (all calls are secured with a Bearer token Authorization header,  except retrieving the Token)
    • Payload validation is done before sending to the ATO
    • Supports both STP 1 and STP2 versions of xml payloads
    • Supports only XML file uploads
  • Note that the urls below are for integration testing purposes only, production urls will be provided after integration testing.

 

3. Prerequisites APIs

#

Action

Response

Comment

1

POST for Authorization token https://auth-uat.bond.complypath.com.au/oauth2/token

JSON with access_token

Standard OAuth 2.0 call to get token

2

GET STP details

https://api-uat.bond.complypath.com.au/stp/participant/stp-details/<stpVersion>

JSON response (refer Sample Requests/ Responses of Prerequisites APIs section)

Valid values for stpVersion: STP1, STP2. 

If the verifyStatus= “VERIFIED”, you don’t have to do the next step.

3

POST to update and verify STP details

https://api-uat.bond.complypath.com.au/stp/participant/stp-details/update-and-verify

JSON response (refer Sample Requests/ Responses of Prerequisites APIs section)

You must verify the relevant STP version details before start uploading files.

 

3.1 Sample Requests/ Responses of Prerequisites APIs:

The text ****HIDDEN**** indicates that the real content has been redacted for security reasons.

1. POST for Authorization token

         a. Request:

https://auth-uat.bond.complypath.com.au/oauth2/token
client_id: "****HIDDEN****"
client_secret: "****HIDDEN****"
grant_type: "client_credentials"

 

         b. Response:

{
"access_token": "****HIDDEN****",
"expires_in": 3600,
"token_type": "Bearer"
}

2. GET STP details

         a. Request:

https://api-uat.bond.complypath.com.au/stp/participant/stp-details/<stpVersion>

 

         b. Response:

{
"stpVersion": "STP1",
"productId": "****HIDDEN****",
"bmsVersion": "****HIDDEN****",
"bmsVendor": "****HIDDEN****",
"bmsName": "****HIDDEN****",
"verifyStatus": "PENDING_VERIFICATION"
}

 

3. POST to update and verify STP details

         a. Request:

https://api-uat.bond.complypath.com.au/stp/participant/stp-details/update-and-verify

{
"stpVersion": "STP1",
"productId": "****HIDDEN****",
"bmsVersion": "****HIDDEN****",
"bmsVendor": "****HIDDEN****",
"bmsName": "****HIDDEN****",
"verifyStatus": "VERIFIED"
}

 

         b. Response:

{
"stpVersion": "STP1",
"productId": "****HIDDEN****",
"bmsVersion": "****HIDDEN****",
"bmsVendor": "****HIDDEN****",
"bmsName": "****HIDDEN****",
"verifyStatus": "VERIFIED"
}

 

 

4. File Upload APIs

Step

Action

Response

Comment

1.1

GET pre signed url to payload to upload new file

https://api-uat.bond.complypath.com.au/stp/stp-details/get/pre-signed-urls?fileName=<fileName>

JSON with pre signed url, process id and url expiry

  

1.2 

GET pre signed url to replace existing file

https://api-uat.bond.complypath.com.au/stp/stp-details/get/pre-signed-urls?fileName=<fileName>&processId=<processId>

JSON with pre signed url, process id and url expiry

Existing file can be replaced only if the process status is either PROCESSING, VALID_REQUEST or INVALID_REQUEST

2

PUT file into pre signed url https://wrkr-stp-payloads.s3-accelerate.amazonaws.com/****HIDDEN****

200 OK

  

3.1

POST to submit file

https://api-uat.bond.complypath.com.au/stp/stp-details/upload/xml/<processId>/submit

Success: processId

Exception: STP details not verified (refer Sample Requests/ Responses of File Upload APIs section)

If pay event, use this submit endpoint.

If an STP details not verified exception occurred refer to the PrerequisitesAPIs section. After completing verification you have to start the process from step 1.

3.2

POST to update file

https://api-uat.bond.complypath.com.au/stp/stp-details/upload/xml/<processId>/update

Success: processId

Exception: STP details not verified (refer Sample Requests/ Responses of File Upload APIs section)

If update event, use this update endpoint.

If an STP details not verified exception occurred refer to the PrerequisitesAPIs section. After completing verification you have to start the process from step 1. 

4

GET validation response

https://api-uat.bond.complypath.com.au/stp/stp-details/validate/xml/<processId>

JSON response (refer Sample Requests/ Responses of File Upload APIs section)

Keep polling until status is VALID_REQUEST or INVALID_REQUEST. If the status is VALID_REQUEST continue to the next step. 

Polling frequency guide: 

  • First poll after 10 seconds, and then each every minute.

5

GET declaration content

https://api-uat.bond.complypath.com.au/stp/declaration/<declarationTye>

JSON response with declaration contents

Declaration type has to be obtained from step 4 response.

payevntSummary.declarationType

6

POST to lodge file

https://api-uat.bond.complypath.com.au/stp/stp-details/lodge/xml/<processId>

JSON response (refer Sample Requests/ Responses of File Upload APIs section)

Only VALID_REQUEST status submissions can be lodged.

7

GET lodge status https://api-uat.bond.complypath.com.au/stp/stp-details/<processId>

JSON response (refer Sample Requests/ Responses of File Upload APIs section)

Keep polling until status is one of below, 

COMPLETE,

COMPLETE_WITH_WARNINGS,

COMPLETE_WITH_ERRORS,

FAILED

Polling frequency guide: 

  • Every 5 mins.

 

4.1 Sample Requests/ Responses of File Upload APIs:

The text ****HIDDEN**** indicates that the real content has been redacted for security reasons.

 

1. GET pre signed url to payload file

         1.1 GET pre signed url to payload to upload new file

                 a.Request: 

https://api-uat.bond.complypath.com.au/stp/stp-details/get/pre-signed-urls?fileName=<fileName>

 

                 b. Response:

{
"preSignedUrl":"https://wrkr-stp-payloads****HIDDEN****”,
"processId": "<processId>",
"expiredAt": "2022-07-27T07:04:08.430+0000"
}

 

         1.2 GET pre signed url to replace existing file

                 a. Request: 

https://api-uat.bond.complypath.com.au/stp/stp-details/get/pre-signed-urls?fileName=<fileName>&processId=<processId>

 

                 b.Response:

{
"preSignedUrl":"https://wrkr-stp-payloads****HIDDEN****”,
"processId": "<processId>",
"expiredAt": "2022-07-27T07:04:08.430+0000"
}

2. PUT file into pre signed url 

         a. Request:

https://wrkr-stp-payloads****HIDDEN****


<fileContent>

         b. Response:

200 OK

 

3. POST to submit or update

         3.1 POST to submit file

                 a. Request: 

https://api-uat.bond.complypath.com.au/stp/stp-details/upload/xml/<processId>/submit

{
"fileName": "<fileName>",
"senderId": "<senderId(optional, can be null)>"
}

 

                 b. Response - success:

<processId>

                 c. Response - STP details not verified exception:

{
"status": 500,
"message": "STP details not verified for participant id - ****HIDDEN**** and STP version - STP1",
"errorCode": "STPE-002-STP1"
}

 

3.2 POST to update file

         a. Request: https://api-uat.bond.complypath.com.au/stp/stp-details/upload/xml/<processId>/update

{
"fileName": "<fileName>",
"senderId": "<senderId(optional, can be null)>"
}

 

         b. Response  - Success:

<processId>

         c. Response - STP details not verified exception:

{

"status": 500,

"message": "STP details not verified for participant id - ****HIDDEN**** and STP version - STP1",

"errorCode": "STPE-002-STP1"

}

 

4. GET validation response

         a. Request: 

https://api-uat.bond.complypath.com.au/stp/stp-details/validate/xml/<processId>

 

         b. Response - Status: VALID_REQUEST:

{
"status": "VALID_REQUEST",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": null,
"validationResponse": {
"hasErrors": false,
"validations": [],
"hasFileErrors": false,
"warningCount": 0,
"errorCount": 0
   },
"payevntSummary": {
"submissionId": "****HIDDEN****",
"payDate": "****HIDDEN****",
"numberOfEmployers": "1",
"numberOfEmployees": "1",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": null,
"totalChileSupportDeductionsAmount": null,
"total": "****HIDDEN****",
"declarationType": "ESSP"
   },
"step": 2,
"auditEntries": [
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-26T07:15:57.387Z",
"fullName": "Scheduler User (scheduler)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-07-26T07:04:08.330Z",
"fullName": "Direct API User (directApiUser)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": null
           }
       }
   ],
"stpVersion": "STP1",
"batch": false
}

 

         c. Response - Status: INVALID_REQUEST:

{
"status": "INVALID_REQUEST",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": null,
"validationResponse": {
"hasErrors": true,
"validations": [
           {
"context": "****HIDDEN****",
"path": "payevntDetail.payevnt.rp.payroll.paymentRecordTransactionD",
"severity": "Error",
"message": "Pay/Update Date must be provided",
"details": null,
"errorCode": "ERR240",
"contextDetails": {
"context": null,
"parentContext": null,
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": null,
"employeeFamilyName": null,
"employeePayrollId": null,
"submissionId": "****HIDDEN****"
               }
           },
           {
"context": "****HIDDEN****",
"path": "payevntempDetails[5].payevntemp.payee.identifiers.taxFileNumberId",
"severity": "Error",
"message": "Payee TFN provided must be either 8 or 9 digits",
"details": null,
"errorCode": "ERR269",
"contextDetails": {
"context": null,
"parentContext": "****HIDDEN****",
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": "****HIDDEN****",
"employeeFamilyName": "****HIDDEN****",
"employeePayrollId": "****HIDDEN****",
"submissionId": "****HIDDEN****"
               }
           }
   ],
"stpVersion": "STP1",
"batch": true
}

 

5. GET declaration content

         a. Request: 

https://api-uat.bond.complypath.com.au/stp/declaration/<declarationTye>

 

         b. Response:

{
"declarationType": "****HIDDEN****",
"declarationStatement": "****HIDDEN****",
"signingStatement": "****HIDDEN****"
}

 

6. POST to lodge file

         a. Request: https://api-uat.bond.complypath.com.au/stp/stp-details/lodge/xml/<processId>

{
"declarationType": "ESSP"
}

         b. Response:

{
"status": "SENDING",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": "2022-07-26T07:29:34.083Z",
"validationResponse": {
"hasErrors": false,
"validations": [],
"hasFileErrors": false,
"warningCount": 0,
"errorCount": 0
   },
"payevntSummary": {
"submissionId": "****HIDDEN****",
"payDate": "****HIDDEN****",
"numberOfEmployers": "****HIDDEN****",
"numberOfEmployees": "****HIDDEN****",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": null,
"totalChileSupportDeductionsAmount": null,
"total": "****HIDDEN****",
"declarationType": "ESSP"
   },
"step": 4,
"auditEntries": [
       {
"action": "SUBMITTED_TO_ATO",
"timeStamp": "2022-07-26T07:29:34.907Z",
"fullName": "Direct API User (directApiUser)",
"auditData": null
       },
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-26T07:15:57.387Z",
"fullName": "Scheduler User (scheduler)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-07-26T07:04:08.330Z",
"fullName": "Direct API User (directApiUser)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": null
           }
       }
   ],
"stpVersion": "STP1",
"batch": false
}

7. GET lodge status

         a. Request: 

https://api-uat.bond.complypath.com.au/stp/stp-details/<processId>

 

         b. Response - Status: COMPLETE :

{
"status": "COMPLETE",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": "2022-07-26T07:29:34.083Z",
"validationResponse": {
"hasErrors": false,
"validations": [],
"hasFileErrors": false,
"warningCount": 0,
"errorCount": 0
   },
"payevntSummary": {
"submissionId": "****HIDDEN****",
"payDate": "****HIDDEN****",
"numberOfEmployers": "****HIDDEN****",
"numberOfEmployees": "****HIDDEN****",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": null,
"totalChileSupportDeductionsAmount": null,
"total": "****HIDDEN****",
"declarationType": "ESSP"
   },
"step": 4,
"auditEntries": [
       {
"action": "COMPLETE",
"timeStamp": "2022-07-26T07:31:00.737Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "RECEIVED_BY_ATO",
"timeStamp": "2022-07-26T07:31:00.697Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "SUBMITTED_TO_ATO",
"timeStamp": "2022-07-26T07:29:34.907Z",
"fullName": "Direct API User (directApiUser)",
"auditData": null
       },
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-26T07:15:57.387Z",
"fullName": "Scheduler User (scheduler)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-07-26T07:04:08.330Z",
"fullName": "Direct API User (directApiUser)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": null
           }
       }
   ],
"stpVersion": "STP1",
"batch": false
}

         c. Response - Status: COMPLETE_WITH_WARNINGS :

{
"status": "COMPLETE_WITH_WARNINGS",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": "****HIDDEN****",
"validationResponse": {
"hasErrors": true,
"validations": [
           {
"context": "1.001",
"path": "/tns:PAYEVNT/tns:Rp/tns:Payroll/tns:InteractionRecordCt",
"severity": "Warning",
"message": "Payee Record Count must be equal to the number of children (PAYEVNTEMP)",
"details": null,
"errorCode": "CMN.ATO.PAYEVNT.000191",
"contextDetails": {
"context": "1.001",
"parentContext": null,
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": null,
"employeeFamilyName": null,
"employeePayrollId": null,
"submissionId": "****HIDDEN****"
               }
           },
           {
"context": "1.001",
"path": null,
"severity": "Information",
"message": "Message Accepted",
"details": null,
"errorCode": "CMN.ATO.GEN.OK",
"contextDetails": {
"context": "1.001",
"parentContext": null,
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": null,
"employeeFamilyName": null,
"employeePayrollId": null,
"submissionId": "****HIDDEN****"
               }
           }
       ],
"hasFileErrors": true,
"warningCount": 1,
"errorCount": 0
   },
"payevntSummary": {
"submissionId": "****HIDDEN****",
"payDate": "****HIDDEN****",
"numberOfEmployers": "****HIDDEN****",
"numberOfEmployees": "****HIDDEN****",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": null,
"totalChileSupportDeductionsAmount": null,
"total": "****HIDDEN****",
"declarationType": "ESSP"
   },
"step": 4,
"auditEntries": [
       {
"action": "COMPLETE_WITH_WARNINGS",
"timeStamp": "2022-07-07T03:45:28.990Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "RECEIVED_BY_ATO",
"timeStamp": "2022-07-07T03:40:28.930Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "SUBMITTED_TO_ATO",
"timeStamp": "2022-07-07T03:35:56.320Z",
"fullName": "****HIDDEN****",
"auditData": null
       },
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-07T03:33:06.673Z",
"fullName": "****HIDDEN****)",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-07-07T03:32:51.840Z",
"fullName": "****HIDDEN****",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": null
           }
       }
   ],
"stpVersion": "STP1",
"batch": false
}

         d. Response - Status: COMPLETE_WITH_ERRORS :

{
"status": "COMPLETE_WITH_ERRORS",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": "2022-07-06T00:03:54.900Z",
"validationResponse": {
"hasErrors": true,
"validations": [
           {
"context": "4.4",
"path": "/tns:PAYEVNTEMP/tns:Payee/tns:Identifiers/tns:TaxFileNumberId",
"severity": "Error",
"message": "TFN must be a valid TFN",
"details": null,
"errorCode": "CMN.ATO.GEN.402043",
"contextDetails": {
"context": "4.4",
"parentContext": "2.0",
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": "****HIDDEN****",
"employeeFamilyName": "****HIDDEN****",
"employeePayrollId": "****HIDDEN****",
"submissionId": "****HIDDEN****"
               }
           }
       ],
"hasFileErrors": true,
"warningCount": 0,
"errorCount": 1
   },
"payevntSummary": {
"submissionId": "Batch",
"payDate": null,
"numberOfEmployers": "****HIDDEN****",
"numberOfEmployees": "****HIDDEN****",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": null,
"totalChileSupportDeductionsAmount": null,
"total": "****HIDDEN****",
"declarationType": "EMSSP"
   },
"step": 4,
"auditEntries": [
       {
"action": "COMPLETE_WITH_ERRORS",
"timeStamp": "2022-07-06T00:15:29.987Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "RECEIVED_BY_ATO",
"timeStamp": "2022-07-06T00:05:30.030Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "SUBMITTED_TO_ATO",
"timeStamp": "2022-07-06T00:03:55.887Z",
"fullName": "****HIDDEN****",
"auditData": null
       },
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-06T00:03:49.513Z",
"fullName": "****HIDDEN****",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-06-30T00:38:55.700Z",
"fullName": "****HIDDEN****",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       }
   ],
"stpVersion": "STP1",
"batch": true
}

 

         e. Response - Status: FAILED :

{
"status": "FAILED",
"processId": "<processId>",
"fileName": "****HIDDEN****",
"eventType": "SUBMIT",
"submittedAt": "****HIDDEN****",
"validationResponse": {
"hasErrors": true,
"validations": [
           {
"context": "1.1",
"path": "/tns:PAYEVNT/tns:Rp/tns:Payroll/tns:PaymentRecordTransactionD",
"severity": "Error",
"message": "A field contains invalid data (such as letters in numeric or date field).",
"details": "The value specified for an item does not match the item type (value = \"\", item type = Date, uniqueID = http://www.sbr.gov.au/ato/payevnt:PaymentRecordTransactionD) Hint: The string '' is not a valid Date value.",
"errorCode": "CMN.ATO.GEN.XML03",
"contextDetails": {
"context": "1.1",
"parentContext": null,
"companyName": "****HIDDEN****",
"companyIdentifierType": "ABN",
"companyIdentifier": "****HIDDEN****",
"employeeGivenName": null,
"employeeFamilyName": null,
"employeePayrollId": null,
"submissionId": "****HIDDEN****"
               }
           }
       ],
"hasFileErrors": true,
"warningCount": 0,
"errorCount": 1
   },
"payevntSummary": {
"submissionId": "****HIDDEN****",
"payDate": "-",
"numberOfEmployers": "****HIDDEN****",
"numberOfEmployees": "****HIDDEN****",
"totalGross": "****HIDDEN****",
"totalPayGW": "****HIDDEN****",
"totalChildSupportGarnisheeAmount": "-",
"totalChileSupportDeductionsAmount": "-",
"total": "****HIDDEN****",
"declarationType": "ESSP"
   },
"step": 4,
"auditEntries": [
       {
"action": "FAILED",
"timeStamp": "2022-07-15T07:00:48.310Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "RECEIVED_BY_ATO",
"timeStamp": "2022-07-15T06:55:48.557Z",
"fullName": "ATO User (atoUser)",
"auditData": null
       },
       {
"action": "SUBMITTED_TO_ATO",
"timeStamp": "2022-07-15T06:54:32.763Z",
"fullName": "****HIDDEN****",
"auditData": null
       },
       {
"action": "VALIDATION_PASSED",
"timeStamp": "2022-07-15T06:53:53.797Z",
"fullName": "****HIDDEN****",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": "****HIDDEN****"
           }
       },
       {
"action": "FILE_UPLOADED",
"timeStamp": "2022-07-15T06:53:37.477Z",
"fullName": "****HIDDEN****",
"auditData": {
"previousFileName": null,
"fileName": "****HIDDEN****",
"previousRequestId": null,
"requestId": null
           }
       }
   ],
"stpVersion": "STP2",
"batch": false
}

5. Other Supporting APIs

#

Action

Response

Comment

1

POST to cancel submission https://api-uat.bond.complypath.com.au/stp/stp-details/cancel/<processId>

JSON response (refer Sample Requests/ Responses of Other Supporting APIs section)

Only INVALID_REQUEST,

VALID_REQUEST status submissions can be cancelled.

2

POST for list of submissions

https://api-uat.bond.complypath.com.au/stp/search/stp-history

JSON response (refer Sample Requests/ Responses of Other Supporting APIs section)

Paginated.

 

5.1 Sample Requests/ Responses of Other Supporting APIs

The text ****HIDDEN**** indicates that the real content has been redacted for security reasons.

POST to cancel submission

         a. Request:

https://api-uat.bond.complypath.com.au/stp/stp-details/cancel/<processId>

 

         b. Response:

<processId>

 

POST for list of submissions

         a. Request:

https://api-uat.bond.complypath.com.au/stp/search/stp-history

{
"pageNumber": 0,
"pageSize": 3
}

         b. Response:

{
"paginationData": {
"pageNumber": 0,
"pageSize": 3,
"totalItems": 101
   },
"rows": [
       {
"processId": "****HIDDEN****",
"submissionId": "-",
"eventType": "SUBMIT",
"grossPayment": "-",
"paygwAmount": "-",
"submitDate": null,
"payUpdateDate": "-",
"processedDate": "-",
"status": "CANCELLED",
"step": 0
       },
       {
"processId": "****HIDDEN****",
"submissionId": "****HIDDEN****",
"eventType": "SUBMIT",
"grossPayment": "****HIDDEN****",
"paygwAmount": "****HIDDEN****",
"submitDate": "2022-07-26T07:29:34.083Z",
"payUpdateDate": "****HIDDEN****",
"processedDate": "****HIDDEN****",
"status": "COMPLETE",
"step": 4
       },
       {
"processId": "****HIDDEN****",
"submissionId": "Batch",
"eventType": "SUBMIT",
"grossPayment": "****HIDDEN****",
"paygwAmount": "****HIDDEN****0",
"submitDate": null,
"payUpdateDate": "-",
"processedDate": "-",
"status": "ARCHIVED",
"step": 2
       }
   ]
}

 

6. Status Definitions

 

Status

Definition

Additional details

1

 

PROCESSING

File is uploading, is processing or is validating.

  

2

 

CANCELLED

 

The submission is cancelled.

  

3

 

ARCHIVED

 

The submission is not lodged within 24 hrs, hence the system archived the submission.

This report was automatically archived as it was not lodged within 24 hours of creation. If you wish to lodge this report, you must create a new STP report and reupload the file again.

4

 

INVALID_REQUEST

 

The uploaded file is having validation errors.

  

5

 

VALID_REQUEST

 

The uploaded file is valid, and can proceed to lodge.

  

6

 

SENDING

 

The file is sent to ATO.

Your file is being transmitted to the ATO. This may take a number of minutes depending on file size and ATO systems.

7

 

RECEIVED_BY_ATO

 

ATO received the file.

The ATO has received the submission. Response times from the ATO can vary according to the size of the report and the status of the ATO's services. It can take from a few minutes to *72 hours* to receive a response, depending on these factors.

8

 

COMPLETE

 

ATO response received with status COMPLETE.

The ATO has successfully processed the submission. You have fulfilled your employer obligations to the ATO.

9

 

COMPLETE_WITH_WARNINGS

 

ATO response received with status COMPLETE_WITH_WARNINGS.

You have met your reporting obligation but the ATO has issued one or more warnings. You do not need to resubmit your file, however you should review the warnings prior to the next file upload.

10

 

COMPLETE_WITH_ERRORS

 

ATO response received with status COMPLETE_WITH_ERRORS.

You have met your reporting obligation but the ATO has rejected one or more records. You do not need to resubmit your file, however you should review the errors and aim to resolve them prior to the next file upload.

11

 

FAILED

 

ATO response received with status FAILED.

You have not met your reporting obligation. You need to resolve the issues with your file and resubmit to ensure it reaches the ATO.

7. Production & Test Environment Details

#

Environment

URL

1

Test

Token - https://auth-uat.bond.complypath.com.au/oauth2/token

STP base url - https://api-uat.bond.complypath.com.au/stp

2

Production

Token -https://auth.wrkr.au/oauth2/token

STP base url - https://api.wrkr.au/stp/

 

Related articles

Powered by Zendesk