Skip to content

companieshouse/penalty-payment-web

Repository files navigation

Penalty Payment Web

Web application for handling payments of penalties. This application is written using the Spring Boot Java framework.

  • Retrieves payable penalties from the Penalty Payment Service
  • Displays payable penalties and redirects to the Payments Service to take payment.

Requirements

In order to run this Web App locally you will need to install:

Getting Started

  1. Configure your service if you want to override any of the defaults.
  2. Run make
  3. Run ./start.sh

Configuration

Key Description
PPS_PAY_WEB_PORT The port of the penalty-payment-web application
HUMAN_LOG For human readable logs
CH_BANK_ACC_NAME Bacs payments - Account name (late filing penalty: A)
CH_BANK_SORT_CODE Bacs payments - Sort code (late filing penalty: A)
CH_BANK_ACC_NUM Bacs payments - Account number (late filing penalty: A)
CH_BANK_IBAN Overseas payments - IBAN (late filing penalty: A)
CH_BANK_SWIFT_CODE Overseas payments - SWIFT code (late filing penalty: A)
CH_SANCTIONS_BANK_ACC_NAME Bacs payments - Account name (sanction: P)
CH_SANCTIONS_BANK_SORT_CODE Bacs payments - Sort code (sanction: P)
CH_SANCTIONS_BANK_ACC_NUM Bacs payments - Account number (sanction: P)
CH_SANCTIONS_BANK_IBAN Overseas payments - IBAN (sanction: P)
CH_SANCTIONS_BANK_SWIFT_CODE Overseas payments - SWIFT code (sanction: P)
FEATURE_FLAG_PENALTY_REF_ENABLED_SANCTIONS_191224 Feature flag to enable Penalty Payment for Sanctions
FEATURE_FLAG_PENALTY_REF_ENABLED_SANCTIONS_ROE_290525 Feature flag to enable Penalty Payment for Sanctions - ROE
PENALTY_PAYMENT_MATOMO_PAY_ANOTHER_PENALTY_GOAL_ID Matomo Goal Id: PAY A PENALTY - Pay another penalty
PENALTY_PAYMENT_MATOMO_PENALTY_REF_STARTS_WITH_LFP_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty ref starts with LFP A
PENALTY_PAYMENT_MATOMO_PENALTY_REF_STARTS_WITH_SANCTIONS_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty ref starts with Sanctions P
PENALTY_PAYMENT_MATOMO_PENALTY_DETAILS_CONTINUE_LFP_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty details continue button A
PENALTY_PAYMENT_MATOMO_PENALTY_DETAILS_CONTINUE_SANCTIONS_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty details continue button P
PENALTY_PAYMENT_MATOMO_PENALTY_IN_DCA_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - DCA stop screen
PENALTY_PAYMENT_MATOMO_PENALTY_PAYMENT_IN_PROGRESS_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - Payment in Progress Stop Screen
PENALTY_PAYMENT_MATOMO_UNSCHEDULED_SERVICE_DOWN_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - Stop screen - unscheduled outage
PENALTY_PAYMENT_MATOMO_SCHEDULED_SERVICE_DOWN_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - Stop screen - scheduled outage
PENALTY_PAYMENT_MATOMO_ONLINE_PAYMENT_UNAVAILABLE_LFP_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - Stop screen unable to pay LFP
PENALTY_PAYMENT_MATOMO_ONLINE_PAYMENT_UNAVAILABLE_SANCTIONS_STOP_SCREEN_GOAL_ID Matomo Goal Id: PAY A PENALTY - Stop screen unable to pay Sanctions
GOV_UK_PAY_PENALTY_URL GOV.UK service banner URL: Pay a penalty to Companies House
PENALTY_PAYMENT_MATOMO_PENALTY_REF_STARTS_WITH_SANCTIONS_ROE_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty ref starts with ROE U
PENALTY_PAYMENT_MATOMO_PENALTY_DETAILS_CONTINUE_SANCTIONS_ROE_GOAL_ID Matomo Goal Id: PAY A PENALTY - Penalty details continue button U
PENALTY_PAYMENT_MATOMO_ONLINE_PAYMENT_UNAVAILABLE_SANCTIONS_ROE_STOP_SCREEN_GOAL_ID Matomo Goal Id: Stop screen - unable to pay via this service ROE

Web Pages

Page Address
Start page for Penalty Payment Service /pay-penalty
What does the penalty reference start with? /pay-penalty/ref-starts-with

Terraform ECS

What does this code do?

The code present in this repository is used to define and deploy a dockerised container in AWS ECS. This is done by calling a module from terraform-modules. Application specific attributes are injected and the service is then deployed using Terraform via the CICD platform 'Concourse'.

Application specific attributes Value Description
ECS Cluster company-requests ECS cluster (stack) the service belongs to
Load balancer {env}-chs-chgovuk The load balancer that sits in front of the service
Concourse pipeline Pipeline link
Pipeline code
Concourse pipeline link in shared services

Contributing

Testing

  • Ensure the terraform runner local plan executes without issues. For information on terraform runners please see the Terraform Runner Quickstart guide.
  • If you encounter any issues or have questions, reach out to the team on the #platform slack channel.

Vault Configuration Updates

  • Any secrets required for this service will be stored in Vault. For any updates to the Vault configuration, please consult with the #platform team and submit a workflow request.

Useful Links

About

Web application for paying late filing penalties

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 32