feat(ACL-390): Add new data fields required for cVRP payments across all payment products (#389)

Co-authored-by: Luca Baggi <74901945+tl-luca-baggi@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [17.6.0] - 2026-05-15
+### Added
+* Add support for `user_interaction` and `use_cases` fields in payment API for commercial mandates
+
 ## [17.5.1] - 2025-10-31
 ### Fixed
 * Update Sonatype Central badge url in order to show latest version

gradle.properties

@@ -1,7 +1,7 @@
 # Main properties
 group=com.truelayer
 archivesBaseName=truelayer-java
-version=17.5.1
+version=17.6.0
 
 # Artifacts properties
 project_name=TrueLayer Java

src/main/java/com/truelayer/java/entities/UseCase.java

@@ -0,0 +1,17 @@
+package com.truelayer.java.entities;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum UseCase {
+    CHARITY("charity"),
+    FINANCIAL_SERVICES("financial_services"),
+    GOVERNMENT("government"),
+    UTILITIES("utilities");
+
+    @JsonValue
+    private final String useCase;
+}

src/main/java/com/truelayer/java/mandates/entities/mandate/VRPCommercialMandate.java

@@ -2,6 +2,7 @@
 
 import static com.truelayer.java.mandates.entities.mandate.Mandate.Type.COMMERCIAL;
 
+import com.truelayer.java.entities.UseCase;
 import com.truelayer.java.mandates.entities.beneficiary.Beneficiary;
 import com.truelayer.java.payments.entities.providerselection.ProviderSelection;
 import lombok.Builder;
@@ -20,4 +21,6 @@ public class VRPCommercialMandate extends Mandate {
     private Beneficiary beneficiary;
 
     private String reference;
+
+    private UseCase useCase;
 }

src/main/java/com/truelayer/java/mandates/entities/mandatedetail/MandateDetail.java

@@ -5,6 +5,7 @@
 import com.truelayer.java.TrueLayerException;
 import com.truelayer.java.commonapi.entities.UserDetail;
 import com.truelayer.java.entities.CurrencyCode;
+import com.truelayer.java.entities.UseCase;
 import com.truelayer.java.mandates.entities.Constraints;
 import com.truelayer.java.mandates.entities.beneficiary.Beneficiary;
 import com.truelayer.java.payments.entities.providerselection.ProviderSelection;
@@ -40,6 +41,10 @@ public abstract class MandateDetail {
 
     private ProviderSelection providerSelection;
 
+    private UseCase useCase;
+
+    private String type;
+
     public abstract Status getStatus();
 
     public AuthorizationRequiredMandateDetail asAuthorizationRequiredMandateDetail() {

src/main/java/com/truelayer/java/payments/entities/UserInteraction.java

@@ -0,0 +1,15 @@
+package com.truelayer.java.payments.entities;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum UserInteraction {
+    PRESENT("present"),
+    NOT_PRESENT("not_present");
+
+    @JsonValue
+    private final String userInteraction;
+}

src/main/java/com/truelayer/java/payments/entities/paymentmethod/Mandate.java

@@ -3,6 +3,7 @@
 import static com.truelayer.java.payments.entities.paymentmethod.PaymentMethod.Type.MANDATE;
 
 import com.fasterxml.jackson.annotation.JsonGetter;
+import com.truelayer.java.payments.entities.UserInteraction;
 import com.truelayer.java.payments.entities.retry.Retry;
 import java.util.Optional;
 import lombok.Builder;
@@ -29,4 +30,6 @@ public class Mandate extends PaymentMethod {
     public Optional<String> getReference() {
         return Optional.ofNullable(reference);
     }
+
+    private UserInteraction userInteraction;
 }

src/main/java/com/truelayer/java/payments/entities/submerchants/BusinessClient.java

@@ -12,6 +12,7 @@
 @EqualsAndHashCode(callSuper = false)
 public class BusinessClient extends UltimateCounterparty {
     private final Type type = Type.BUSINESS_CLIENT;
+    private String id;
     private String tradingName;
     private String commercialName;
     private String url;

src/main/java/com/truelayer/java/paymentsproviders/entities/VrpCommercialCapabilities.java

@@ -1,12 +1,16 @@
 package com.truelayer.java.paymentsproviders.entities;
 
 import com.truelayer.java.entities.ProviderAvailability;
+import com.truelayer.java.entities.UseCase;
 import com.truelayer.java.payments.entities.ReleaseChannel;
+import java.util.List;
 import lombok.Value;
 
 @Value
 public class VrpCommercialCapabilities {
     ReleaseChannel releaseChannel;
 
     ProviderAvailability availability;
+
+    List<UseCase> useCases;
 }

src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/VrpCommercialCapabilities.java

@@ -1,6 +1,10 @@
 package com.truelayer.java.paymentsproviders.entities.searchproviders;
 
+import com.truelayer.java.entities.UseCase;
+import java.util.List;
 import lombok.Value;
 
 @Value
-public class VrpCommercialCapabilities {}
+public class VrpCommercialCapabilities {
+    List<UseCase> useCases;
+}