Last modified
Overview
This page provides some suggested test scenarios to help you test the use of the stapled super fund API in your software in the sandbox environment. If you follow the instructions below, you will get the mocked responses as described below.
Note: The receipt number in the response payload of a post request provided below is an example only and you will receive a different number.
Test Scenario 1 - POST RSF - TFN provided - SMSF response
Test Description: Verify that an RSF request is processed, and the employer must make super contributions to a stapled SMSF account returned by the ATO.
Request information
- HTTP verb: POST
- Payee TFN: 220114645
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/220114645/stapledSuperFund
Response information
- Response type: Business payload
- HTTP status: 200
- HTTP reason: OK
- HTTP header: receipt: 6300000000014
- Payload:
{
"data": {
"requestOutcome": {
"reasonCode": "Stapled SMSF"
},
"payee": {
"payeePayrollId": "123456789",
"personName": {
"familyName": "Doe",
"givenName": "John",
"otherGivenName": "Louis Rey"
}
},
"superfund": {
"australianBusinessNumber": "12345678901",
"organisationalName": "Australian Super Pty Ltd",
"superannuationProduct": {
"name": ""
},
"superannuationFund": {
"uniqueSuperannuationIdentifier": "",
"memberAccount": ""
}
}
}
} Test Scenario 2 - POST RSF - TFN provided - Non SMSF response
Test Description: Ensure that an RSF request is processed, and the employer contributes to a stapled super fund account (non-SMSF) returned for an employee.
Request information
- HTTP verb: POST
- Payee TFN: 220114653
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/220114653/stapledSuperFund
Response information
- Response type: Business payload
- HTTP status: 200
- HTTP reason: OK
- HTTP header: receipt: 6300000000027
- Payload:
{
"data": {
"requestOutcome": {
"reasonCode": "Stapled fund"
},
"payee": {
"payeePayrollId": "123456789",
"personName": {
"familyName": "Doe",
"givenName": "John",
"otherGivenName": "Louis Rey"
}
},
"superfund": {
"australianBusinessNumber": "12345678901",
"organisationalName": "Australian Super Pty Ltd",
"superannuationProduct": {
"name": "Australian Super"
},
"superannuationFund": {
"uniqueSuperannuationIdentifier": "STA0100AU",
"memberAccount": "12345678901234"
}
}
}
} Test Scenario 3 - POST RSF - TFN not provided - BET ID and message
Test Description: Confirm that the system returns an error when an employer submits a request using an invalid or missing TFN.
Request information
- HTTP verb: POST
- Payee TFN: 111111111
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/111111111/stapledSuperFund
Response information
- Response type: Informational Message
- HTTP status: 202
- HTTP reason: Accepted
- HTTP header: receipt: 6300000000030
- Payload:
{
"messages": [
{
"code": "RSF.00002",
"detail": "Your request cannot be processed to the service level agreement. Please use the corresponding GET action with the provided receipt number to get the request outcome.",
"severity": "information"
}
]
} Test Scenario 4 - GET RSF by Receipt Id - SMSF response
Test Description: Validate that a processed RSF request can be successfully retrieved using a valid TFN and Receipt ID.
Request information
- HTTP verb: GET
- Payee TFN: 220114688
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/220114688/stapledSuperFund/6300000000069
Response information
- Response type: Business Payload
- HTTP status: 200
- HTTP reason: OK
- HTTP header: receipt: 6300000000069
- Payload:
{
"data": {
"requestOutcome": {
"reasonCode": "Stapled SMSF"
},
"payee": {
"payeePayrollId": "123456789",
"personName": {
"familyName": "Doe",
"givenName": "John",
"otherGivenName": "Louis Rey"
}
},
"superfund": {
"australianBusinessNumber": "12345678901",
"organisationalName": "Australian Super Pty Ltd",
"superannuationProduct": {
"name": ""
},
"superannuationFund": {
"uniqueSuperannuationIdentifier": "",
"memberAccount": ""
}
}
}
}Test Scenario 5 - GET RSF by Invalid Receipt Id
Test Description: Check that the system returns an error when an employer attempts to retrieve RSF data using a non-existent Receipt ID.
Request information
- HTTP verb: GET
- Payee TFN: 220114696
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/220114696/stapledSuperFund/6300000000072
Response information
- Response type: Error
- HTTP status: 422
- HTTP reason: Unprocessable Entity
- HTTP header: receipt: 6300000000072
- Payload:
{
"errors": [
{
"code": "RSF.00006",
"detail": "Receipt number provided is invalid.",
"source": {
"parameter": "receipt"
}
}
]
} Test Scenario 6 - POST RSF - Exempted TFN provided - Either address is required
Test Description: Ensure that RSF requests for exempted payee TFNs are rejected with an appropriate error response.
Request information
- HTTP verb: POST
- Payee TFN: 333333333
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/333333333/stapledSuperFund
Response information
- Response type: Error
- HTTP status: 422
- HTTP reason: Unprocessable Entity
- HTTP header: receipt: 6300000000043
- Payload:
{
"errors": [
{
"code": "ADDR.00001",
"detail": "If an exempted TFN code is present, Payee residential address or Payee postal address must be provided."
}
]
} Test Scenario 7 - POST RSF - Passes validation but no mock scenario match for POST
Test Description: Test that a stapled fund is still returned and contributions are required even when no mock scenario is configured for the TFN.
Request information
- HTTP verb: POST
- Payee TFN: OTHER
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/{AnyOtherTFN}/stapledSuperFund
Response information
- Response type: Business payload
- HTTP status: 200
- HTTP reason: OK
- HTTP header: receipt: 6300000000056
- Payload:
{
"data": {
"requestOutcome": {
"reasonCode": "Stapled fund"
},
"payee": {
"payeePayrollId": "123456789",
"personName": {
"familyName": "Doe",
"givenName": "John",
"otherGivenName": "Louis Rey"
}
},
"superfund": {
"australianBusinessNumber": "12345678901",
"organisationalName": "Australian Super Pty Ltd",
"superannuationProduct": {
"name": "Australian Super"
},
"superannuationFund": {
"uniqueSuperannuationIdentifier": "STA0105AU",
"memberAccount": "12345678901234"
}
}
}
}Test Scenario 8 - GET RSF - Passes validation but no mock scenario match for GET
Test Description: Confirm that RSF data can be retrieved using a valid Receipt ID even if no mock setup exists for the associated TFN.
Request information
- HTTP verb: GET
- Payee TFN: OTHER
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/{AnyOtherTFN}/stapledSuperFund/6300000000105
Response information
- Response type: Business payload
- HTTP status: 200
- HTTP reason: OK
- HTTP header: receipt: 6300000000105
- Payload:
{
"data": {
"requestOutcome": {
"reasonCode": "Stapled fund"
},
"payee": {
"payeePayrollId": "123456789",
"personName": {
"familyName": "Doe",
"givenName": "John",
"otherGivenName": "Louis Rey"
}
},
"superfund": {
"australianBusinessNumber": "12345678901",
"organisationalName": "Australian Super Pty Ltd",
"superannuationProduct": {
"name": "Australian Super"
},
"superannuationFund": {
"uniqueSuperannuationIdentifier": "STA0106AU",
"memberAccount": "12345678901234"
}
}
}
}Alternate Stapled Super Fund Scenarios:
Enabling employers to lodge a subsequent stapled super fund request that will exclude previously notified stapled super fund accounts from the decision-making process, as they could not accept contributions from that employer.
Note: The following instructions relate to Sandbox only to enable successful testing of the new functionality. They are to be followed while executing Test Scenarios 9 to 13.
- Multiple Submissions Required: These tests return different valid responses when the same POST request is submitted multiple times. To complete the test, you must submit the same request endpoint until you receive each of the following response outcomes:
- Stapled SMSF
- Stapled fund
- Used default fund
- Time Constraint: All three responses must be obtained within 30 minutes from the time the first request is submitted. If the 30-minute window is exceeded (or) if you want to retest, please restart the test from the beginning using a new Access Token.
Test Scenario 9 - POST RSF - TFN provided - Alternate SMSF response
Test Description: Validate that when an employer flag they are unable to make contributions to previously notified funds, each RSF request may return a different outcome based on the employee's available lodged funds.
Request information
- HTTP verb: POST
- Payee TFN: 220114645
- Available Funds: Stapled SMSF & Stapled Fund
- End Point: /super/v1/clients/ABN/{Employer}/payees/TFN/220114645/stapledSuperFund?unableToMakeContribution=true
Response information
Request RSF - Attempt 1 | Request RSF - Attempt 2 | Request RSF - Attempt 3…n |
|
|
|
Test Scenario 10 - POST RSF - TFN provided - Tax Agent Lodger - Alternate Stapled Fund response
Test Description: Confirm that an agent acting on behalf of an employer who is unable to make contributions to previously notified funds receives varying RSF outcomes across requests.
Request information
- HTTP verb: POST
- Payee ABN: 19090096156
- Payee TFN: 220114653
- Tax Agent TAN: 10185000
- Available Funds: Stapled Fund 1 & Stapled Fund 2
- End Point: /super/v1/clients/ABN/19090096156/payees/TFN/220114653/stapledSuperFund?context="TAN=10185000"&unableToMakeContribution=true
Response information
Request RSF - Attempt 1 | Request RSF - Attempt 2 | Request RSF - Attempt 3…n |
|
|
|
Test Scenario 11 - POST RSF - TFN provided - Business Intermediatory Lodger - Choice Fund (Alternate Fund) response
Test Description: Ensure that an authorised contact acting for an employer who is unable to make contributions to previously notified funds receives different RSF outcomes per request.
Request information
- HTTP verb: POST
- Payee ABN: 75086973944
- Payee TFN: 44444444
- Available Funds: Choice Stapled Fund & Stapled Fund
- End Point: /super/v1/clients/ABN/75086973944/payees/TFN/44444444/stapledSuperFund?context="ABN=BusinessIntermediary}"&unableToMakeContribution=true
Response information
Request RSF - Attempt 1 | Request RSF - Attempt 2 | Request RSF - Attempt 3…n |
|
|
|
Test Scenario 12 - POST RSF - TFN provided - Tax Agent Lodger - Choice SMSF (Alternate Fund) response
Test Description: Confirm that an agent acting on behalf of an employer who is unable to make contributions to previously notified funds receives varying RSF outcomes across requests.
Request information
- HTTP verb: POST
- Payee ABN: 28090593990
- Payee TFN: 28918644
- Tax Agent TAN: 28855009
- Available Funds: Choice Stapled SMSF & Stapled Fund
- End Point: /super/v1/clients/ABN/28090593990/payees/TFN/28918644/stapledSuperFund?context="TAN=28855009"&unableToMakeContribution=true
Response information
Request RSF - Attempt 1 | Request RSF - Attempt 2 | Request RSF - Attempt 3…n |
|
|
|
Test Scenario 13 - GET RSF by Receipt Id - TFN provided - Alternate SMSF response
Test Description: Verify that an employer can retrieve the RSF outcome using a Receipt ID that was generated from a previous RSF request (e.g., Test Scenario 9) where the employer flagged, they were unable to make contributions to previously notified funds.
Request information
- HTTP verb: GET
- Payee TFN: 220114645
- Available Funds: Stapled SMSF & Stapled Fund
- End Point:
- /super/v1/clients/ABN/{Employer}/payees/TFN/220114645/stapledSuperFund/6300000000014
- /super/v1/clients/ABN/{Employer}/payees/TFN/220114645/stapledSuperFund/6300000000019
- /super/v1/clients/ABN/{Employer}/payees/TFN/220114645/stapledSuperFund/6300000000036
Response information
Request RSF - with receipt id=6300000000014 | Request RSF - with receipt id=6300000000019 | Request RSF - with receipt id=6300000000036 |
|
|
|
Go back to Stapled super fund