Provides endpoints for testing which mimic third party service endpoints which HTS depends on.
Please click here for more information.
Run sbt run on the terminal to start the service. The service runs on port 7002 by default.
The unit tests can be run by running
sbt test
| Path | Method | Description |
|---|---|---|
| /nsi-services/account | POST | Mimics a call to create an account. Different responses are allowed for based on the NINO in the request |
| /nsi-services/account | PUT | If the nino: XX999999X is given, a health check response with an OK status is returned otherwise the request is treated as an update email |
| /nsi-services/account | GET | Gets account information using a predefined set of data mapped to certain NINOs |
| /nsi-services/transactions | GET | Gets transaction information using a predefined set of data mapped to certain NINOs |
| Path | Method | Description |
|---|---|---|
| /help-to-save/eligibility-check/{NINO} | GET | Mimics a call to check eligibility for HTS. Different responses are allowed for based on the NINO in the request |
| /help-to-save/accounts/{NINO} | PUT | Mimics a call to set the ITMP flag |
| /universal-credits/threshold-amount | GET | Mimics call to get the HTS UC threshold value |
| Path | Method | Description |
|---|---|---|
| /email-verification/verification-requests | POST | Mimics call to verify an email address. When this endpoint is hit, a message will appear in the logs indicating where the continue URL is to simulate completing the email verification |
| Path | Method | Description |
|---|---|---|
| /hmrc/{NINO} | GET | Mimics a call to check the UC status. Different responses are allowed for based on the NINO in the request |
| Path | Method | Description |
|---|---|---|
| /pay-as-you-earn/02.00.00/individuals/{NINO} | GET | Mimics a call to get user info via the GetPAYEPersonDetails API |
| Path | Method | Description |
|---|---|---|
| /validateBankDetails | GET | Mimics a call to validate bank details. Different responses are allowed for based on the bank details being passed in |
This code is open source software licensed under the Apache 2.0 License