[ACL-250]: Adds payouts in Poland (#339)

dili91 · tl-luca-baggi · web-flow · commit fa33887f3ea6 · 2025-03-14T11:37:37.000+01:00
Co-authored-by: tl-luca-baggi &lt;luca.baggi@truelayer.com&gt;
diff --git a/CHANGELOG.md b/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.1.0] - 2025-03-14
+### Added
+* Add support for PLN payouts
+
 ## [17.0.0] - 2025-01-15
 ### Changed
 * ⚠️ Breaking: removed deprecated HPP link builder
diff --git a/build.gradle b/build.gradle
@@ -1,13 +1,13 @@
 plugins {
     id 'java-library'
     // to unleash the lombok magic
-    id "io.freefair.lombok" version "8.11"
+    id "io.freefair.lombok" version "8.12.2.1"
     // to make our tests output more fancy
     id 'com.adarshr.test-logger' version '4.0.0'
     // to publish packages
     id 'maven-publish'
     // code linting
-    id "com.diffplug.spotless" version "7.0.1"
+    id "com.diffplug.spotless" version "7.0.2"
     //  test coverage
     id 'jacoco'
     id 'com.github.kt3k.coveralls' version '2.12.2'
@@ -108,14 +108,15 @@ dependencies {
     implementation group: 'org.tinylog', name: 'tinylog-impl', version: tinyLogVersion
 
     // JUnit test framework.
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: '5.11.4'
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: '5.12.0'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 
     // Mocking libraries
     testImplementation group: 'org.mockito', name: 'mockito-core', version: '5.15.2'
-    testImplementation group: 'org.wiremock', name: 'wiremock', version: '3.10.0'
+    testImplementation group: 'org.wiremock', name: 'wiremock', version: '3.12.1'
 
     // Wait test utility
-    testImplementation group: 'org.awaitility', name: 'awaitility', version: '4.2.2'
+    testImplementation group: 'org.awaitility', name: 'awaitility', version: '4.3.0'
 
     // Transitive dependencies constraints
     constraints {
diff --git a/gradle.properties b/gradle.properties
@@ -1,7 +1,7 @@
 # Main properties
 group=com.truelayer
 archivesBaseName=truelayer-java
-version=17.0.0
+version=17.1.0
 
 # Artifacts properties
 sonatype_repository_url=https://s01.oss.sonatype.org/service/local/
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/gradlew b/gradlew
diff --git a/src/main/java/com/truelayer/java/entities/beneficiary/BusinessAccount.java b/src/main/java/com/truelayer/java/entities/beneficiary/BusinessAccount.java
@@ -10,11 +10,11 @@
 @Value
 @EqualsAndHashCode(callSuper = false)
 public class BusinessAccount extends Beneficiary {
-    private final Type type = BUSINESS_ACCOUNT;
+    Type type = BUSINESS_ACCOUNT;
 
-    private String reference;
+    String reference;
 
-    private String accountHolderName;
+    String accountHolderName;
 
-    private List<AccountIdentifier> accountIdentifiers;
+    List<AccountIdentifier> accountIdentifiers;
 }
diff --git a/src/main/java/com/truelayer/java/entities/beneficiary/ExternalAccount.java b/src/main/java/com/truelayer/java/entities/beneficiary/ExternalAccount.java
@@ -10,11 +10,11 @@
 @Value
 @EqualsAndHashCode(callSuper = false)
 public class ExternalAccount extends Beneficiary {
-    private final Type type = EXTERNAL_ACCOUNT;
+    Type type = EXTERNAL_ACCOUNT;
 
-    private String reference;
+    String reference;
 
-    private String accountHolderName;
+    String accountHolderName;
 
-    private List<AccountIdentifier> accountIdentifiers;
+    List<AccountIdentifier> accountIdentifiers;
 }
diff --git a/src/main/java/com/truelayer/java/entities/beneficiary/PaymentSource.java b/src/main/java/com/truelayer/java/entities/beneficiary/PaymentSource.java
@@ -10,15 +10,15 @@
 @Value
 @EqualsAndHashCode(callSuper = false)
 public class PaymentSource extends Beneficiary {
-    private final Type type = PAYMENT_SOURCE;
+    Type type = PAYMENT_SOURCE;
 
-    private String paymentSourceId;
+    String paymentSourceId;
 
-    private String userId;
+    String userId;
 
-    private String reference;
+    String reference;
 
-    private String accountHolderName;
+    String accountHolderName;
 
     private List<AccountIdentifier> accountIdentifiers;
 }
diff --git a/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/Remitter.java b/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/Remitter.java
@@ -12,9 +12,9 @@
  */
 @Value
 public class Remitter {
-    private List<AccountIdentifier> accountIdentifiers;
+    List<AccountIdentifier> accountIdentifiers;
 
-    private String accountHolderName;
+    String accountHolderName;
 
-    private String reference;
+    String reference;
 }
diff --git a/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/AccountIdentifier.java b/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/AccountIdentifier.java
@@ -23,6 +23,7 @@
 @JsonSubTypes({
     @JsonSubTypes.Type(value = SortCodeAccountNumberAccountIdentifier.class, name = "sort_code_account_number"),
     @JsonSubTypes.Type(value = IbanAccountIdentifier.class, name = "iban"),
+    @JsonSubTypes.Type(value = NrbAccountIdentifier.class, name = "nrb"),
 })
 @ToString
 @EqualsAndHashCode
@@ -40,6 +41,11 @@ public boolean isIbanIdentifier() {
         return this instanceof IbanAccountIdentifier;
     }
 
+    @JsonIgnore
+    public boolean isNrbIdentifier() {
+        return this instanceof NrbAccountIdentifier;
+    }
+
     @JsonIgnore
     public SortCodeAccountNumberAccountIdentifier asSortCodeAccountNumber() {
         if (!isSortCodeAccountNumberIdentifier()) {
@@ -56,6 +62,14 @@ public IbanAccountIdentifier asIban() {
         return (IbanAccountIdentifier) this;
     }
 
+    @JsonIgnore
+    public NrbAccountIdentifier asNrb() {
+        if (!isNrbIdentifier()) {
+            throw new TrueLayerException(buildErrorMessage());
+        }
+        return (NrbAccountIdentifier) this;
+    }
+
     private String buildErrorMessage() {
         return String.format("Identifier is of type %s.", this.getClass().getSimpleName());
     }
@@ -64,7 +78,8 @@ private String buildErrorMessage() {
     @RequiredArgsConstructor
     public enum Type {
         SORT_CODE_ACCOUNT_NUMBER("sort_code_account_number"),
-        IBAN("iban");
+        IBAN("iban"),
+        NRB("nrb");
 
         @JsonValue
         private final String type;
diff --git a/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/NrbAccountIdentifier.java b/src/main/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/NrbAccountIdentifier.java
@@ -0,0 +1,12 @@
+package com.truelayer.java.merchantaccounts.entities.transactions.accountidentifier;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Builder
+@Getter
+public class NrbAccountIdentifier extends AccountIdentifier {
+    private final Type type = Type.NRB;
+
+    private String nrb;
+}
diff --git a/src/main/java/com/truelayer/java/payouts/entities/accountidentifier/AccountIdentifier.java b/src/main/java/com/truelayer/java/payouts/entities/accountidentifier/AccountIdentifier.java
@@ -23,6 +23,7 @@
 @JsonSubTypes({
     @JsonSubTypes.Type(value = SortCodeAccountNumberAccountIdentifier.class, name = "sort_code_account_number"),
     @JsonSubTypes.Type(value = IbanAccountIdentifier.class, name = "iban"),
+    @JsonSubTypes.Type(value = NrbAccountIdentifier.class, name = "nrb")
 })
 @ToString
 @EqualsAndHashCode
@@ -40,6 +41,11 @@ public boolean isIbanIdentifier() {
         return this instanceof IbanAccountIdentifier;
     }
 
+    @JsonIgnore
+    public boolean isNrbIdentifier() {
+        return this instanceof NrbAccountIdentifier;
+    }
+
     @JsonIgnore
     public SortCodeAccountNumberAccountIdentifier asSortCodeAccountNumber() {
         if (!isSortCodeAccountNumberIdentifier()) {
@@ -56,6 +62,14 @@ public IbanAccountIdentifier asIban() {
         return (IbanAccountIdentifier) this;
     }
 
+    @JsonIgnore
+    public NrbAccountIdentifier asNrb() {
+        if (!isNrbIdentifier()) {
+            throw new TrueLayerException(buildErrorMessage());
+        }
+        return (NrbAccountIdentifier) this;
+    }
+
     private String buildErrorMessage() {
         return String.format("Identifier is of type %s.", this.getClass().getSimpleName());
     }
@@ -64,6 +78,7 @@ private String buildErrorMessage() {
     @RequiredArgsConstructor
     public enum Type {
         SORT_CODE_ACCOUNT_NUMBER("sort_code_account_number"),
+        NRB("nrb"),
         IBAN("iban");
 
         @JsonValue
@@ -78,4 +93,8 @@ public enum Type {
     public static IbanAccountIdentifier.IbanAccountIdentifierBuilder iban() {
         return new IbanAccountIdentifier.IbanAccountIdentifierBuilder();
     }
+
+    public static NrbAccountIdentifier.NrbAccountIdentifierBuilder nrb() {
+        return new NrbAccountIdentifier.NrbAccountIdentifierBuilder();
+    }
 }
diff --git a/src/main/java/com/truelayer/java/payouts/entities/accountidentifier/NrbAccountIdentifier.java b/src/main/java/com/truelayer/java/payouts/entities/accountidentifier/NrbAccountIdentifier.java
@@ -0,0 +1,14 @@
+package com.truelayer.java.payouts.entities.accountidentifier;
+
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+
+@Builder
+@Getter
+@EqualsAndHashCode(callSuper = false)
+public class NrbAccountIdentifier extends AccountIdentifier {
+    private final Type type = Type.NRB;
+
+    private String nrb;
+}
diff --git a/src/test/java/com/truelayer/java/acceptance/AcceptanceTests.java b/src/test/java/com/truelayer/java/acceptance/AcceptanceTests.java
@@ -1,10 +1,11 @@
 package com.truelayer.java.acceptance;
 
-import com.truelayer.java.ClientCredentials;
-import com.truelayer.java.Environment;
-import com.truelayer.java.SigningOptions;
-import com.truelayer.java.TrueLayerClient;
+import static com.truelayer.java.TestUtils.assertNotError;
+
+import com.truelayer.java.*;
 import com.truelayer.java.entities.CurrencyCode;
+import com.truelayer.java.http.entities.ApiResponse;
+import com.truelayer.java.merchantaccounts.entities.ListMerchantAccountsResponse;
 import com.truelayer.java.merchantaccounts.entities.MerchantAccount;
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
@@ -51,11 +52,14 @@ protected MerchantAccount getMerchantAccount(CurrencyCode currencyCode) {
             return merchantAccounts.get(currencyCode);
         }
 
-        MerchantAccount merchantAccount =
-                tlClient.merchantAccounts().listMerchantAccounts().get().getData().getItems().stream()
-                        .filter(m -> m.getCurrency().equals(currencyCode))
-                        .findFirst()
-                        .orElseThrow(() -> new RuntimeException("test merchant account not found"));
+        ApiResponse<ListMerchantAccountsResponse> merchantAccountList =
+                tlClient.merchantAccounts().listMerchantAccounts().get();
+        assertNotError(merchantAccountList);
+
+        MerchantAccount merchantAccount = merchantAccountList.getData().getItems().stream()
+                .filter(m -> m.getCurrency().equals(currencyCode))
+                .findFirst()
+                .orElseThrow(() -> new RuntimeException("test merchant account not found"));
 
         merchantAccounts.put(currencyCode, merchantAccount);
 
diff --git a/src/test/java/com/truelayer/java/acceptance/PayoutsAcceptanceTests.java b/src/test/java/com/truelayer/java/acceptance/PayoutsAcceptanceTests.java
@@ -16,35 +16,35 @@
 import com.truelayer.java.payouts.entities.submerchants.SubMerchants;
 import java.util.Collections;
 import java.util.concurrent.ThreadLocalRandom;
+import java.util.stream.Stream;
 import lombok.SneakyThrows;
-import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 @Tag("acceptance")
 public class PayoutsAcceptanceTests extends AcceptanceTests {
 
-    @Test
-    @DisplayName("It should create a payout and get the details")
+    @ParameterizedTest(name = "It should create a {0} payout and get the details")
+    @MethodSource("providePayoutsArgumentsForDifferentCurrencies")
     @SneakyThrows
-    public void shouldCreateAPayoutAndGetPayoutsDetails() {
+    public void shouldCreateAPayoutAndGetPayoutsDetails(
+            CurrencyCode currencyCode, AccountIdentifier accountIdentifier, SchemeSelection schemeSelection) {
         // find a merchant to execute the payout from
-        MerchantAccount merchantAccount = getMerchantAccount(CurrencyCode.GBP);
+        MerchantAccount merchantAccount = getMerchantAccount(currencyCode);
 
         // create the payout
         CreatePayoutRequest createPayoutRequest = CreatePayoutRequest.builder()
                 .merchantAccountId(merchantAccount.getId())
                 .amountInMinor(ThreadLocalRandom.current().nextInt(10, 100))
-                .currency(CurrencyCode.GBP)
+                .currency(currencyCode)
                 .beneficiary(Beneficiary.externalAccount()
-                        .accountIdentifier(AccountIdentifier.sortCodeAccountNumber()
-                                .accountNumber("00009650")
-                                .sortCode("040668")
-                                .build())
-                        .reference("Java SDK payout test")
+                        .accountIdentifier(accountIdentifier)
+                        .reference(String.format("Java SDK %s payout test", currencyCode.name()))
                         .accountHolderName("LucaB merchant")
                         .build())
-                .schemeSelection(SchemeSelection.instantPreferred().build())
+                .schemeSelection(schemeSelection)
                 .subMerchants(SubMerchants.builder()
                         .ultimateCounterparty(BusinessClient.businessClient()
                                 .tradingName("A sub merchant trading name")
@@ -69,4 +69,21 @@ public void shouldCreateAPayoutAndGetPayoutsDetails() {
         assertEquals(payoutId, getPayoutResponse.getData().getId());
         assertEquals(merchantAccount.getId(), getPayoutResponse.getData().getMerchantAccountId());
     }
+
+    public static Stream<Arguments> providePayoutsArgumentsForDifferentCurrencies() {
+        return Stream.of(
+                Arguments.of(
+                        CurrencyCode.GBP,
+                        AccountIdentifier.sortCodeAccountNumber()
+                                .accountNumber("00009650")
+                                .sortCode("040668")
+                                .build(),
+                        SchemeSelection.instantPreferred().build()),
+                Arguments.of(
+                        CurrencyCode.PLN,
+                        AccountIdentifier.iban().iban("GB25CLRB04066800046876").build(),
+                        SchemeSelection.preselected()
+                                .schemeId("polish_domestic_express")
+                                .build()));
+    }
 }
diff --git a/src/test/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/AccountIdentifierTests.java b/src/test/java/com/truelayer/java/merchantaccounts/entities/transactions/accountidentifier/AccountIdentifierTests.java
diff --git a/src/test/java/com/truelayer/java/payouts/entities/accountidentifier/AccountIdentifierTests.java b/src/test/java/com/truelayer/java/payouts/entities/accountidentifier/AccountIdentifierTests.java
diff --git a/src/test/resources/__files/merchant_accounts/200.get_transactions.json b/src/test/resources/__files/merchant_accounts/200.get_transactions.json
diff --git a/src/test/resources/__files/merchant_accounts/200.list_merchant_accounts.json b/src/test/resources/__files/merchant_accounts/200.list_merchant_accounts.json
