Skip to content

Fpvtl 1845 failed payments #3699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JohnnyEmbleton wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fpvtl 1845 failed payments #3699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
59ead62
FPVTL-1845-Failed Payments
JohnnyEmbleton Mar 25, 2026
ec9ef8a
Merge branch 'master' into FPVTL-1845-failed-payments
JohnnyEmbleton Mar 25, 2026
7a1fc52
Tweaked logic and unit tests
JohnnyEmbleton Mar 26, 2026
f70558c
Reverted yaml
JohnnyEmbleton Mar 26, 2026
4e44794
Tweaked coe to handle duplicate payments status calls.
JohnnyEmbleton Apr 8, 2026
880cca5
Addressed PR code review comments.
JohnnyEmbleton Apr 8, 2026
705097d
Addressed PR code review comments.
JohnnyEmbleton Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/main/java/uk/gov/hmcts/reform/prl/config/payments/AsyncPaymentConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package uk.gov.hmcts.reform.prl.config.payments;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Executor;

@Configuration
public class AsyncPaymentConfiguration {

@Bean(name = "taskExecutor")
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(2);
executor.setMaxPoolSize(5);
executor.setQueueCapacity(500);
executor.setThreadNamePrefix("PRL-Async-");
executor.initialize();
return executor;
}
}
4 changes: 4 additions & 0 deletions ...main/java/uk/gov/hmcts/reform/prl/controllers/ServiceRequestUpdateCallbackController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ public void serviceRequestUpdate(
throw (new RuntimeException(INVALID_CLIENT));
}
}
log.info("Processing service-request-update for caseId: {} with service request reference: {} ",
serviceRequestUpdateDto.getCcdCaseNumber(),
serviceRequestUpdateDto.getServiceRequestReference()
);
requestUpdateCallbackService.processCallback(serviceRequestUpdateDto);
} catch (Exception ex) {
log.error(
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/uk/gov/hmcts/reform/prl/services/CourtFinderService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public Court getNearestFamilyCourt(CaseData caseData) throws NotFoundException {

}
} catch (Exception e) {
log.info("CourtFinderService.getNearestFamilyCourt() method is throwing exception : {}",e);
log.error("CourtFinderService.getNearestFamilyCourt() method is throwing exception : {} for caseId {} ",e, caseData.getId());
}
return null;
}
Expand Down
257 changes: 6 additions & 251 deletions src/main/java/uk/gov/hmcts/reform/prl/services/RequestUpdateCallbackService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,271 +1,26 @@
package uk.gov.hmcts.reform.prl.services;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import uk.gov.hmcts.reform.ccd.client.model.CaseDataContent;
import uk.gov.hmcts.reform.ccd.client.model.CaseDetails;
import uk.gov.hmcts.reform.ccd.client.model.EventRequestData;
import uk.gov.hmcts.reform.ccd.client.model.StartEventResponse;
import uk.gov.hmcts.reform.prl.clients.ccd.CcdCoreCaseDataService;
import uk.gov.hmcts.reform.prl.enums.CaseEvent;
import uk.gov.hmcts.reform.prl.enums.State;
import uk.gov.hmcts.reform.prl.enums.uploadadditionalapplication.ApplicationStatus;
import uk.gov.hmcts.reform.prl.enums.uploadadditionalapplication.PaymentStatus;
import uk.gov.hmcts.reform.prl.models.Element;
import uk.gov.hmcts.reform.prl.models.complextypes.uploadadditionalapplication.AdditionalApplicationsBundle;
import uk.gov.hmcts.reform.prl.models.court.Court;
import uk.gov.hmcts.reform.prl.models.dto.ccd.CaseData;
import uk.gov.hmcts.reform.prl.models.dto.ccd.CcdPayment;
import uk.gov.hmcts.reform.prl.models.dto.ccd.CcdPaymentServiceRequestUpdate;
import uk.gov.hmcts.reform.prl.models.dto.payment.ServiceRequestUpdateDto;
import uk.gov.hmcts.reform.prl.services.caseflags.PartyLevelCaseFlagsService;
import uk.gov.hmcts.reform.prl.services.tab.alltabs.AllTabServiceImpl;
import uk.gov.hmcts.reform.prl.utils.CaseUtils;
import uk.gov.hmcts.reform.prl.utils.ElementUtils;
import uk.gov.hmcts.reform.prl.utils.UploadAdditionalApplicationUtils;

import java.time.LocalDateTime;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

import static uk.gov.hmcts.reform.prl.constants.PrlAppsConstants.AWP_WA_TASK_NAME;
import static uk.gov.hmcts.reform.prl.constants.PrlAppsConstants.AWP_WA_TASK_TO_BE_CREATED;
import static uk.gov.hmcts.reform.prl.constants.PrlAppsConstants.WA_ADDITIONAL_APPLICATION_COLLECTION_ID;
import static uk.gov.hmcts.reform.prl.constants.PrlAppsConstants.YES;
import uk.gov.hmcts.reform.prl.services.payment.PaymentAsyncService;

@Slf4j
@Component
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class RequestUpdateCallbackService {

public static final String PAID = "Paid";
private final ObjectMapper objectMapper;
private final SystemUserService systemUserService;
private final SolicitorEmailService solicitorEmailService;
private final CaseWorkerEmailService caseWorkerEmailService;
private final AllTabServiceImpl allTabService;
private final CourtFinderService courtFinderService;
private final CcdCoreCaseDataService coreCaseDataService;
private final PartyLevelCaseFlagsService partyLevelCaseFlagsService;
private final UploadAdditionalApplicationUtils uploadAdditionalApplicationUtils;
private final PaymentAsyncService paymentAsyncService;

public void processCallback(ServiceRequestUpdateDto serviceRequestUpdateDto) {
String systemAuthorisation = systemUserService.getSysUserToken();
String systemUpdateUserId = systemUserService.getUserId(systemAuthorisation);
CaseDetails caseDetails
= coreCaseDataService.findCaseById(systemAuthorisation, serviceRequestUpdateDto.getCcdCaseNumber());

boolean isCasePayment = verifyCaseCreationPaymentReference(
caseDetails,
serviceRequestUpdateDto.getServiceRequestReference()
);
CaseEvent caseEvent;
if (isCasePayment) {
caseEvent = PAID.equalsIgnoreCase(serviceRequestUpdateDto.getServiceRequestStatus())
? CaseEvent.PAYMENT_SUCCESS_CALLBACK : CaseEvent.PAYMENT_FAILURE_CALLBACK;
} else {
caseEvent = PAID.equalsIgnoreCase(serviceRequestUpdateDto.getServiceRequestStatus())
? CaseEvent.AWP_PAYMENT_SUCCESS_CALLBACK : CaseEvent.AWP_PAYMENT_FAILURE_CALLBACK;
}

log.info("Following case event will be triggered {}", caseEvent.getValue());

EventRequestData eventRequestData = coreCaseDataService.eventRequest(caseEvent, systemUpdateUserId);
StartEventResponse startEventResponse =
coreCaseDataService.startUpdate(
systemAuthorisation,
eventRequestData,
serviceRequestUpdateDto.getCcdCaseNumber(),
true
);

CaseDataContent caseDataContent;
if (isCasePayment) {
caseDataContent = coreCaseDataService.createCaseDataContent(
startEventResponse,
setCaseData(
serviceRequestUpdateDto
)
);
} else {
caseDataContent = coreCaseDataService.createCaseDataContent(
startEventResponse,
setAwPPaymentCaseData(
startEventResponse,
serviceRequestUpdateDto
)
);
}

coreCaseDataService.submitUpdate(
systemAuthorisation,
eventRequestData,
caseDataContent,
serviceRequestUpdateDto.getCcdCaseNumber(),
true
);

if (isCasePayment) {
partyLevelCaseFlagsService.generateAndStoreCaseFlags(serviceRequestUpdateDto.getCcdCaseNumber());

EventRequestData allTabsUpdateEventRequestData = coreCaseDataService.eventRequest(
CaseEvent.UPDATE_ALL_TABS,
systemUpdateUserId
);
StartEventResponse allTabsUpdateStartEventResponse =
coreCaseDataService.startUpdate(
systemAuthorisation,
allTabsUpdateEventRequestData,
serviceRequestUpdateDto.getCcdCaseNumber(),
true
);

CaseData allTabsUpdateCaseData = CaseUtils.getCaseDataFromStartUpdateEventResponse(
allTabsUpdateStartEventResponse,
objectMapper
);
log.info(
"Refreshing tab based on the payment response for caseId {} ",
serviceRequestUpdateDto.getCcdCaseNumber()
);

allTabsUpdateCaseData = getCaseDataWithStateAndDateSubmitted(
serviceRequestUpdateDto,
allTabsUpdateCaseData
);

allTabService.mapAndSubmitAllTabsUpdate(
systemAuthorisation,
serviceRequestUpdateDto.getCcdCaseNumber(),
allTabsUpdateStartEventResponse,
allTabsUpdateEventRequestData,
allTabsUpdateCaseData
);

log.info(
"Updating the Case data with payment information for caseId {}",
serviceRequestUpdateDto.getCcdCaseNumber()
);

if (PAID.equalsIgnoreCase(serviceRequestUpdateDto.getServiceRequestStatus())) {
solicitorEmailService.sendEmail(allTabsUpdateStartEventResponse.getCaseDetails());
caseWorkerEmailService.sendEmail(allTabsUpdateStartEventResponse.getCaseDetails());
}
}
}

private boolean verifyCaseCreationPaymentReference(CaseDetails caseDetails, String serviceRequestReference) {
CaseData caseData = CaseUtils.getCaseData(caseDetails, objectMapper);
return !StringUtils.isEmpty(serviceRequestReference)
&& serviceRequestReference.equalsIgnoreCase(caseData.getPaymentServiceRequestReferenceNumber());
}

public CaseData getCaseDataWithStateAndDateSubmitted(ServiceRequestUpdateDto serviceRequestUpdateDto,
CaseData caseData) {
try {
Court closestChildArrangementsCourt = courtFinderService.getNearestFamilyCourt(caseData);
if (serviceRequestUpdateDto.getServiceRequestStatus().equalsIgnoreCase(PAID)) {
ZonedDateTime zonedDateTime = ZonedDateTime.now(ZoneId.of("Europe/London"));
caseData = caseData.toBuilder()
.state(shouldUpdateCaseState(caseData) ? State.SUBMITTED_PAID : caseData.getState())
.dateSubmitted(DateTimeFormatter.ISO_LOCAL_DATE.format(zonedDateTime))
.build();

} else {
caseData = caseData.toBuilder()
.state(shouldUpdateCaseState(caseData) ? State.SUBMITTED_NOT_PAID : caseData.getState())
.build();
}
if (closestChildArrangementsCourt != null) {
caseData = caseData.toBuilder().courtName(closestChildArrangementsCourt.getCourtName()).courtId(String.valueOf(
closestChildArrangementsCourt.getCountyLocationCode())).build();
caseData.setCourtCodeFromFact(String.valueOf(closestChildArrangementsCourt.getCountyLocationCode()));
}
} catch (Exception e) {
log.error("Error while populating case date in payment request call {}", caseData.getId(), e);
if (serviceRequestUpdateDto == null || StringUtils.isBlank(serviceRequestUpdateDto.getCcdCaseNumber())) {
log.error("Discarding payment callback: Missing Case Number in DTO.");
return;
}
return caseData;
}

private CaseData setCaseData(ServiceRequestUpdateDto serviceRequestUpdateDto) {
return CaseData.builder()
.id(Long.parseLong(serviceRequestUpdateDto.getCcdCaseNumber()))
.paymentCallbackServiceRequestUpdate(CcdPaymentServiceRequestUpdate.builder()
.serviceRequestReference(serviceRequestUpdateDto.getServiceRequestReference())
.ccdCaseNumber(serviceRequestUpdateDto.getCcdCaseNumber())
.serviceRequestAmount(serviceRequestUpdateDto.getServiceRequestAmount())
.serviceRequestStatus(serviceRequestUpdateDto.getServiceRequestStatus())
.callBackUpdateTimestamp(LocalDateTime.now())
.payment(CcdPayment.builder().paymentAmount(
serviceRequestUpdateDto.getPayment().getPaymentAmount())
.paymentReference(serviceRequestUpdateDto.getPayment().getPaymentReference())
.paymentMethod(serviceRequestUpdateDto.getPayment().getPaymentMethod())
.caseReference(serviceRequestUpdateDto.getPayment().getCaseReference())
.accountNumber(serviceRequestUpdateDto.getPayment().getAccountNumber())
.build()).build()).build();
}

private Map<String, Object> setAwPPaymentCaseData(StartEventResponse startEventResponse, ServiceRequestUpdateDto serviceRequestUpdateDto) {
CaseData startEventResponseData = CaseUtils.getCaseData(startEventResponse.getCaseDetails(), objectMapper);
Map<String, Object> caseDataUpdated = new HashMap<>();
if (startEventResponseData.getAdditionalApplicationsBundle() != null) {
Optional<Element<AdditionalApplicationsBundle>> additionalApplicationsBundleElement
= startEventResponseData.getAdditionalApplicationsBundle()
.stream()
.filter(x -> null != x.getValue().getPayment()
&& x.getValue().getPayment().getPaymentServiceRequestReferenceNumber().equalsIgnoreCase(
serviceRequestUpdateDto.getServiceRequestReference()))
.findFirst();

if (additionalApplicationsBundleElement.isPresent()
&& PAID.equalsIgnoreCase(serviceRequestUpdateDto.getServiceRequestStatus())) {
AdditionalApplicationsBundle updatedAdditionalApplicationsBundleElement = additionalApplicationsBundleElement.get()
.getValue()
.toBuilder()
.payment(additionalApplicationsBundleElement.get().getValue().getPayment().toBuilder()
.status(PaymentStatus.PAID.getDisplayedValue())
.build())
.c2DocumentBundle(null != additionalApplicationsBundleElement.get().getValue().getC2DocumentBundle()
? additionalApplicationsBundleElement.get().getValue().getC2DocumentBundle().toBuilder().applicationStatus(
ApplicationStatus.SUBMITTED.getDisplayedValue()).build() : null)
.otherApplicationsBundle(null != additionalApplicationsBundleElement.get().getValue().getOtherApplicationsBundle()
? additionalApplicationsBundleElement.get().getValue().getOtherApplicationsBundle()
.toBuilder().applicationStatus(ApplicationStatus.SUBMITTED.getDisplayedValue()).build() : null)
.build();

int index = startEventResponseData.getAdditionalApplicationsBundle().indexOf(
additionalApplicationsBundleElement.get());
if (index != -1) {
startEventResponseData.getAdditionalApplicationsBundle()
.set(
index,
ElementUtils.element(
additionalApplicationsBundleElement.get().getId(),
updatedAdditionalApplicationsBundleElement
)
);
}
caseDataUpdated.put(WA_ADDITIONAL_APPLICATION_COLLECTION_ID, additionalApplicationsBundleElement.get().getId());
caseDataUpdated.put("additionalApplicationsBundle", startEventResponseData.getAdditionalApplicationsBundle());
caseDataUpdated.put(
AWP_WA_TASK_NAME,
uploadAdditionalApplicationUtils.getAwPTaskNameWhenPaymentCompleted(updatedAdditionalApplicationsBundleElement));
caseDataUpdated.put(AWP_WA_TASK_TO_BE_CREATED, YES);
}
}
return caseDataUpdated;
}

private boolean shouldUpdateCaseState(CaseData caseData) {
return caseData.getState() == State.SUBMITTED_NOT_PAID
|| caseData.getState() == State.CASE_WITHDRAWN;
paymentAsyncService.handlePaymentCallback(serviceRequestUpdateDto);
}
}
Loading