[ACL-243] Add creditableAt property to payment details response (#358)

Author: tl-luca-baggi

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.2.0] - 2025-04-16
+### Added
+* Add support for `deprecated_at` property to GET payment API response
+
 ## [17.1.0] - 2025-03-14
 ### Added
 * Add support for PLN payouts

build.gradle

@@ -1,13 +1,13 @@
 plugins {
     id 'java-library'
     // to unleash the lombok magic
-    id "io.freefair.lombok" version "8.12.2.1"
+    id "io.freefair.lombok" version "8.13.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.2"
+    id "com.diffplug.spotless" version "7.0.3"
     //  test coverage
     id 'jacoco'
     id 'com.github.kt3k.coveralls' version '2.12.2'
@@ -108,11 +108,11 @@ dependencies {
     implementation group: 'org.tinylog', name: 'tinylog-impl', version: tinyLogVersion
 
     // JUnit test framework.
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: '5.12.0'
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: '5.12.2'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 
     // Mocking libraries
-    testImplementation group: 'org.mockito', name: 'mockito-core', version: '5.15.2'
+    testImplementation group: 'org.mockito', name: 'mockito-core', version: '5.17.0'
     testImplementation group: 'org.wiremock', name: 'wiremock', version: '3.12.1'
 
     // Wait test utility

gradle.properties

@@ -1,7 +1,7 @@
 # Main properties
 group=com.truelayer
 archivesBaseName=truelayer-java
-version=17.1.0
+version=17.2.0
 
 # Artifacts properties
 sonatype_repository_url=https://s01.oss.sonatype.org/service/local/

src/main/java/com/truelayer/java/payments/entities/paymentdetail/AuthorizedPaymentDetail.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonGetter;
 import com.truelayer.java.entities.AuthorizationFlowWithConfiguration;
 import com.truelayer.java.entities.PaymentSource;
+import java.time.ZonedDateTime;
 import java.util.Optional;
 import lombok.*;
 
@@ -16,6 +17,8 @@ public class AuthorizedPaymentDetail extends PaymentDetail {
 
     AuthorizationFlowWithConfiguration authorizationFlow;
 
+    ZonedDateTime creditableAt;
+
     @JsonGetter
     public Optional<AuthorizationFlowWithConfiguration> getAuthorizationFlow() {
         return Optional.ofNullable(authorizationFlow);

src/main/java/com/truelayer/java/payments/entities/paymentdetail/ExecutedPaymentDetail.java

@@ -17,6 +17,8 @@ public class ExecutedPaymentDetail extends PaymentDetail {
 
     ZonedDateTime executedAt;
 
+    ZonedDateTime creditableAt;
+
     AuthorizationFlowWithConfiguration authorizationFlow;
 
     SettlementRisk settlementRisk;

src/main/java/com/truelayer/java/payments/entities/paymentdetail/FailedPaymentDetail.java

@@ -21,6 +21,8 @@ public class FailedPaymentDetail extends PaymentDetail {
 
     ZonedDateTime failedAt;
 
+    ZonedDateTime creditableAt;
+
     FailureStage failureStage;
 
     String failureReason;

src/main/java/com/truelayer/java/payments/entities/paymentdetail/SettledPaymentDetail.java

@@ -25,6 +25,8 @@ public class SettledPaymentDetail extends PaymentDetail {
 
     ZonedDateTime executedAt;
 
+    ZonedDateTime creditableAt;
+
     AuthorizationFlowWithConfiguration authorizationFlow;
 
     SettlementRisk settlementRisk;

src/test/java/com/truelayer/java/payments/entities/paymentdetail/PaymentDetailTests.java

@@ -67,15 +67,17 @@ public void shouldNotConvertToAuthorizingPaymentDetail() {
     @Test
     @DisplayName("It should yield true if instance is of type AuthorizedPaymentDetail")
     public void shouldYieldTrueIfAuthorizedPaymentDetail() {
-        PaymentDetail sut = new AuthorizedPaymentDetail(null, new AuthorizationFlowWithConfiguration(null));
+        PaymentDetail sut = new AuthorizedPaymentDetail(
+                null, new AuthorizationFlowWithConfiguration(null), ZonedDateTime.now(Clock.systemUTC()));
 
         assertTrue(sut.isAuthorized());
     }
 
     @Test
     @DisplayName("It should convert to an instance of class AuthorizedPaymentDetail")
     public void shouldConvertToAuthorizedPaymentDetail() {
-        PaymentDetail sut = new AuthorizedPaymentDetail(null, new AuthorizationFlowWithConfiguration(null));
+        PaymentDetail sut = new AuthorizedPaymentDetail(
+                null, new AuthorizationFlowWithConfiguration(null), ZonedDateTime.now(Clock.systemUTC()));
 
         assertDoesNotThrow(sut::asAuthorized);
     }
@@ -96,6 +98,7 @@ public void shouldYieldTrueIfFailedPaymentDetail() {
         PaymentDetail sut = new FailedPaymentDetail(
                 null,
                 ZonedDateTime.now(Clock.systemUTC()),
+                ZonedDateTime.now(Clock.systemUTC()),
                 FailedPaymentDetail.FailureStage.AUTHORIZATION_REQUIRED,
                 "failed for some reason",
                 null);
@@ -109,6 +112,7 @@ public void shouldConvertToFailedPaymentDetail() {
         PaymentDetail sut = new FailedPaymentDetail(
                 null,
                 ZonedDateTime.now(Clock.systemUTC()),
+                ZonedDateTime.now(Clock.systemUTC()),
                 FailedPaymentDetail.FailureStage.AUTHORIZATION_REQUIRED,
                 "failed for some reason",
                 null);
@@ -134,6 +138,7 @@ public void shouldYieldTrueIfSettledPaymentDetail() {
                 ZonedDateTime.now(Clock.systemUTC()),
                 ZonedDateTime.now(Clock.systemUTC()),
                 ZonedDateTime.now(Clock.systemUTC()),
+                ZonedDateTime.now(Clock.systemUTC()),
                 null,
                 null);
 
@@ -148,6 +153,7 @@ public void shouldConvertToSettledPaymentDetail() {
                 ZonedDateTime.now(Clock.systemUTC()),
                 ZonedDateTime.now(Clock.systemUTC()),
                 ZonedDateTime.now(Clock.systemUTC()),
+                ZonedDateTime.now(Clock.systemUTC()),
                 null,
                 null);
 
@@ -167,15 +173,17 @@ public void shouldNotConvertToSettledPaymentDetail() {
     @Test
     @DisplayName("It should yield true if instance is of type ExecutedPaymentDetail")
     public void shouldYieldTrueIfExecutedPaymentDetail() {
-        PaymentDetail sut = new ExecutedPaymentDetail(null, ZonedDateTime.now(Clock.systemUTC()), null, null);
+        PaymentDetail sut = new ExecutedPaymentDetail(
+                null, ZonedDateTime.now(Clock.systemUTC()), ZonedDateTime.now(Clock.systemUTC()), null, null);
 
         assertTrue(sut.isExecuted());
     }
 
     @Test
     @DisplayName("It should convert to an instance of class ExecutedPaymentDetail")
     public void shouldConvertToExecutedPaymentDetail() {
-        PaymentDetail sut = new ExecutedPaymentDetail(null, ZonedDateTime.now(Clock.systemUTC()), null, null);
+        PaymentDetail sut = new ExecutedPaymentDetail(
+                null, ZonedDateTime.now(Clock.systemUTC()), ZonedDateTime.now(Clock.systemUTC()), null, null);
 
         assertDoesNotThrow(sut::asExecuted);
     }

src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.authorized.json

@@ -47,6 +47,7 @@
     }
   },
   "created_at":"2022-01-17T17:13:18.214924Z",
+  "creditable_at":"2022-01-18T17:13:18.214924Z",
   "status":"authorized",
   "authorization_flow":{
     "configuration":{

src/test/resources/__files/payments/200.get_payment_by_id.bank_transfer.executed.json

@@ -50,6 +50,7 @@
     "account_holder_name":"John Doe"
   },
   "executed_at":"2022-01-17T17:13:18.214924Z",
+  "creditable_at":"2022-01-18T17:13:18.214924Z",
   "metadata": {
     "a_custom_key": "a-value"
   }