Add search payments providers endpoint + statement reference to merchant account (#330)

tl-luca-baggi · web-flow · commit 653cd572ae94 · 2024-12-10T17:48:46.000+01:00
diff --git a/build.gradle b/build.gradle
@@ -112,7 +112,7 @@ dependencies {
 
     // Mocking libraries
     testImplementation group: 'org.mockito', name: 'mockito-core', version: '5.14.2'
-    testImplementation group: 'org.wiremock', name: 'wiremock', version: '3.9.2'
+    testImplementation group: 'org.wiremock', name: 'wiremock', version: '3.10.0'
 
     // Wait test utility
     testImplementation group: 'org.awaitility', name: 'awaitility', version: '4.2.2'
diff --git a/gradle.properties b/gradle.properties
@@ -1,7 +1,7 @@
 # Main properties
 group=com.truelayer
 archivesBaseName=truelayer-java
-version=16.1.0
+version=16.2.0
 
 # Artifacts properties
 sonatype_repository_url=https://s01.oss.sonatype.org/service/local/
diff --git a/src/main/java/com/truelayer/java/payments/entities/beneficiary/MerchantAccount.java b/src/main/java/com/truelayer/java/payments/entities/beneficiary/MerchantAccount.java
@@ -18,4 +18,6 @@ public class MerchantAccount extends Beneficiary {
     private String reference;
 
     private Verification verification;
+
+    private String statementReference;
 }
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/IPaymentsProvidersApi.java b/src/main/java/com/truelayer/java/paymentsproviders/IPaymentsProvidersApi.java
@@ -3,10 +3,10 @@
 import com.truelayer.java.entities.RequestScopes;
 import com.truelayer.java.http.entities.ApiResponse;
 import com.truelayer.java.paymentsproviders.entities.PaymentsProvider;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersRequest;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersResponse;
 import java.util.concurrent.CompletableFuture;
-import retrofit2.http.GET;
-import retrofit2.http.Path;
-import retrofit2.http.Tag;
+import retrofit2.http.*;
 
 /**
  * Interface that models /payments-providers/* endpoints
@@ -16,4 +16,8 @@ public interface IPaymentsProvidersApi {
     @GET("/payments-providers/{id}")
     CompletableFuture<ApiResponse<PaymentsProvider>> getProvider(
             @Tag RequestScopes scopes, @Path("id") String providerId);
+
+    @POST("/payments-providers/search")
+    CompletableFuture<ApiResponse<SearchPaymentProvidersResponse>> searchPaymentProviders(
+            @Tag RequestScopes scopes, @Body SearchPaymentProvidersRequest request);
 }
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/IPaymentsProvidersHandler.java b/src/main/java/com/truelayer/java/paymentsproviders/IPaymentsProvidersHandler.java
@@ -2,6 +2,8 @@
 
 import com.truelayer.java.http.entities.ApiResponse;
 import com.truelayer.java.paymentsproviders.entities.PaymentsProvider;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersRequest;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersResponse;
 import java.util.concurrent.CompletableFuture;
 
 /**
@@ -19,4 +21,14 @@ public interface IPaymentsProvidersHandler {
      * @see <a href="https://docs.truelayer.com/reference/get-payment-provider"><i>Get Payment Provider</i> API reference</a>
      */
     CompletableFuture<ApiResponse<PaymentsProvider>> getProvider(String providerId);
+
+    /**
+     * Returns a list of payments providers.
+     *
+     * @param request the request with filters to search providers
+     * @return the response of the <i>Search Payments Providers</i> operation
+     * @see <a href="https://docs.truelayer.com/reference/search-payment-providers"><i>Search Payment Providers</i> API reference</a>
+     */
+    CompletableFuture<ApiResponse<SearchPaymentProvidersResponse>> searchProviders(
+            SearchPaymentProvidersRequest request);
 }
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/PaymentsProvidersHandler.java b/src/main/java/com/truelayer/java/paymentsproviders/PaymentsProvidersHandler.java
@@ -6,6 +6,8 @@
 import com.truelayer.java.entities.RequestScopes;
 import com.truelayer.java.http.entities.ApiResponse;
 import com.truelayer.java.paymentsproviders.entities.PaymentsProvider;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersRequest;
+import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersResponse;
 import java.util.concurrent.CompletableFuture;
 import lombok.Builder;
 
@@ -29,4 +31,10 @@ public RequestScopes getRequestScopes() {
     public CompletableFuture<ApiResponse<PaymentsProvider>> getProvider(String providerId) {
         return paymentsProvidersApi.getProvider(getRequestScopes(), providerId);
     }
+
+    @Override
+    public CompletableFuture<ApiResponse<SearchPaymentProvidersResponse>> searchProviders(
+            SearchPaymentProvidersRequest request) {
+        return paymentsProvidersApi.searchPaymentProviders(getRequestScopes(), request);
+    }
 }
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/AisConsent.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/AisConsent.java
@@ -0,0 +1,12 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import java.util.List;
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class AisConsent {
+    private List<Scope> scopes;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/AuthorizationFlow.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/AuthorizationFlow.java
@@ -0,0 +1,11 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class AuthorizationFlow {
+    private Configuration configuration;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/BankTransferCapabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/BankTransferCapabilities.java
@@ -0,0 +1,6 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Value;
+
+@Value
+public class BankTransferCapabilities {}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Capabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Capabilities.java
@@ -0,0 +1,16 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Capabilities {
+    PaymentsCapabilities payments;
+
+    MandatesCapabilities mandates;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Configuration.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Configuration.java
@@ -0,0 +1,17 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Configuration {
+    private ProviderSelection providerSelection;
+
+    private Redirect redirect;
+
+    private Form form;
+
+    private Consent consent;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Consent.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Consent.java
@@ -0,0 +1,11 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Consent {
+    private Requirements requirements;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Form.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Form.java
@@ -0,0 +1,12 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import java.util.List;
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Form {
+    private List<InputType> inputTypes;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Icon.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Icon.java
@@ -0,0 +1,11 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Icon {
+    private IconType type;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/IconType.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/IconType.java
@@ -0,0 +1,18 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum IconType {
+    DEFAULT("default"),
+    EXTENDED("extended"),
+    EXTENDED_SMALL("extended_small"),
+    EXTENDED_MEDIUM("extended_medium"),
+    EXTENDED_LARGE("extended_large");
+
+    @JsonValue
+    private final String iconType;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/InputType.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/InputType.java
@@ -0,0 +1,16 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum InputType {
+    TEXT("text"),
+    TEXT_WITH_IMAGE("text_with_image"),
+    SELECT("select");
+
+    @JsonValue
+    private final String inputType;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/MandatesCapabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/MandatesCapabilities.java
@@ -0,0 +1,16 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class MandatesCapabilities {
+    VrpSweepingCapabilities vrpSweeping;
+
+    VrpCommercialCapabilities vrpCommercial;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/PaymentsCapabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/PaymentsCapabilities.java
@@ -0,0 +1,14 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class PaymentsCapabilities {
+    BankTransferCapabilities bankTransfer;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/PisConsent.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/PisConsent.java
@@ -0,0 +1,9 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class PisConsent {}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/ProviderSelection.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/ProviderSelection.java
@@ -0,0 +1,11 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class ProviderSelection {
+    private Icon icon;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Redirect.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Redirect.java
@@ -0,0 +1,9 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Redirect {}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Requirements.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Requirements.java
@@ -0,0 +1,13 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.*;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class Requirements {
+    private PisConsent pis;
+
+    private AisConsent ais;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Scope.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/Scope.java
@@ -0,0 +1,15 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum Scope {
+    ACCOUNTS("accounts"),
+    BALANCE("balance");
+
+    @JsonValue
+    private final String scope;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/SearchPaymentProvidersRequest.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/SearchPaymentProvidersRequest.java
@@ -0,0 +1,29 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import com.truelayer.java.entities.CurrencyCode;
+import com.truelayer.java.payments.entities.CountryCode;
+import com.truelayer.java.payments.entities.CustomerSegment;
+import com.truelayer.java.payments.entities.ReleaseChannel;
+import java.util.List;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+@Builder
+@Getter
+@ToString
+@EqualsAndHashCode
+public class SearchPaymentProvidersRequest {
+    private List<CountryCode> countries;
+
+    private List<CurrencyCode> currencies;
+
+    private ReleaseChannel releaseChannel;
+
+    private List<CustomerSegment> customerSegments;
+
+    private Capabilities capabilities;
+
+    private AuthorizationFlow authorizationFlow;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/SearchPaymentProvidersResponse.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/SearchPaymentProvidersResponse.java
@@ -0,0 +1,10 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import com.truelayer.java.paymentsproviders.entities.PaymentsProvider;
+import java.util.List;
+import lombok.Value;
+
+@Value
+public class SearchPaymentProvidersResponse {
+    List<PaymentsProvider> items;
+}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/VrpCommercialCapabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/VrpCommercialCapabilities.java
@@ -0,0 +1,6 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Value;
+
+@Value
+public class VrpCommercialCapabilities {}
diff --git a/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/VrpSweepingCapabilities.java b/src/main/java/com/truelayer/java/paymentsproviders/entities/searchproviders/VrpSweepingCapabilities.java
@@ -0,0 +1,6 @@
+package com.truelayer.java.paymentsproviders.entities.searchproviders;
+
+import lombok.Value;
+
+@Value
+public class VrpSweepingCapabilities {}
diff --git a/src/test/java/com/truelayer/java/acceptance/PaymentsAcceptanceTests.java b/src/test/java/com/truelayer/java/acceptance/PaymentsAcceptanceTests.java
diff --git a/src/test/java/com/truelayer/java/acceptance/PaymentsProvidersAcceptanceTests.java b/src/test/java/com/truelayer/java/acceptance/PaymentsProvidersAcceptanceTests.java
diff --git a/src/test/java/com/truelayer/java/integration/PaymentsProvidersIntegrationTests.java b/src/test/java/com/truelayer/java/integration/PaymentsProvidersIntegrationTests.java
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.attempt_failed.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.attempt_failed.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorization_required.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorization_required.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorized.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorized.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorizing.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorizing.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.executed.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.executed.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.failed.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.failed.json
diff --git a/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.settled.json b/src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.settled.json
diff --git a/src/test/resources/__files/payments_providers/200.search_payments_providers.json b/src/test/resources/__files/payments_providers/200.search_payments_providers.json

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,6 @@ public class MerchantAccount extends Beneficiary {`
`18`	`18`	`private String reference;`
`19`	`19`
`20`	`20`	`private Verification verification;`
	`21`	`+`
	`22`	`+ private String statementReference;`
`21`	`23`	`}`