ia-case-payments-api allows Immigration and Asylum workflow to check fees and make a payment for an appeal based on chosen type of hearing during appeal submission. There are exceptions based on Business logic when payment can be done after appeal is submitted. All interactions with Fees and Payment system are encapsulated within this service.

To run the project you will need to have the following installed:

• Java 11
• Docker (optional)

For information about the software versions used to build this API and a complete list of it's dependencies see build.gradle

ia-home-office-integration-api is common Spring Boot application. Command to run:

./gradlew clean bootRun

Unit tests and code style checks:

./gradlew clean build

Integration tests use Wiremock and Spring MockMvc framework:

./gradlew integration

Functional tests use started application instance:

./gradlew functional

In order for these tests to run successfully you will need its dependencies to be running.

There is a need to run ia-docker service stack to provide OpenId authentication and Wiremock recorded responses for Professional Ref Data, Fees service and Payment service.

To successfully interact with the above dependencies a few environment variables need to be set as below.

If you want to run a specific scenario use this command:

./gradlew functional --tests CcdScenarioRunnerTest --info -Dscenario=RIA-3271

If the API is running (either inside a Docker container or via gradle bootRun) you can run the smoke tests as follows:

./gradlew smoke

To understand if the application is working, you can call it's health endpoint:

curl http://localhost:8096/health

If the API is running, you should see this response:

{"status":"UP"}

API details about usages and error statuses are placed in Swagger UI

ia-case-payments-api has 2 endpoints which are equivalent for CCD callbacks phases. Payload is a standard CCD record. Based on the event request is dispatched to proper handlers and Business logic is applied.

Authentication is defined as any other Reform application with Idam Authorization token and S2S ServiceAuthorization token.

Business logic and validation have to be implemented in dedicated handler. ia-case-payments-api has three main handlers which are responsible for integration with downstream services.

Downstream services are listed below:

• Fees service
• Professional Ref Data
• Payment service

This project is licensed under the MIT License - see the LICENSE file for details