Merge pull request #86 from unzerdev/UMCS-515/fix/invoice-secured-cancelation-failed

UMCS-515 Invoice secured - reason code for Cancel is mandatory

Author: GreatG0ose

CHANGELOG.md

@@ -19,6 +19,7 @@ This release brings Unzer Paylater Invoice payment type support to Java SDK.
 ### Fixed
 
 * Fixed: customer salutation is null, because of marshalling/unmarshalling issue.
+* Fixed: cancel InvoiceSecured charge failed with error `API.340.100.024: Reason code is mandatory for the payment type INVOICE_SECURED`. Please, use `com.unzer.payment.Cancel.setReasonCode` to set reason code and `com.unzer.payment.Unzer.cancelCharge(java.lang.String, java.lang.String, com.unzer.payment.Cancel)` to cancel InvoiceSecured charge. 
 
 ### Removed
 

src/main/java/com/unzer/payment/Cancel.java

@@ -24,13 +24,13 @@
  * Business object for Cancellations
  *
  * @author Unzer E-Com GmbH
- *
  */
 public class Cancel extends AbstractTransaction<Payment> {
 
     private BigDecimal amountGross;
     private BigDecimal amountNet;
     private BigDecimal amountVat;
+    private ReasonCode reasonCode;
 
     public Cancel() {
         super();
@@ -73,4 +73,17 @@ public BigDecimal getAmountVat() {
     public void setAmountVat(BigDecimal amountVat) {
         this.amountVat = amountVat;
     }
+
+    public ReasonCode getReasonCode() {
+        return reasonCode;
+    }
+
+    public Cancel setReasonCode(ReasonCode reasonCode) {
+        this.reasonCode = reasonCode;
+        return this;
+    }
+
+    public enum ReasonCode {
+        CANCEL, RETURN, CREDIT
+    }
 }

src/main/java/com/unzer/payment/PaymentError.java

@@ -15,6 +15,8 @@
  */
 package com.unzer.payment;
 
+import java.util.Objects;
+
 public class PaymentError {
 
     private String merchantMessage;
@@ -61,4 +63,23 @@ public String toString() {
         return "{merchantMessage:" + merchantMessage + ", customerMessage:" + customerMessage + ", code:" + code + "}";
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        PaymentError that = (PaymentError) o;
+
+        return Objects.equals(merchantMessage, that.merchantMessage) &&
+                Objects.equals(customerMessage, that.customerMessage) &&
+                Objects.equals(code, that.code) ;
+    }
+
+    @Override
+    public int hashCode() {
+        int result = merchantMessage != null ? merchantMessage.hashCode() : 0;
+        result = 31 * result + (customerMessage != null ? customerMessage.hashCode() : 0);
+        result = 31 * result + (code != null ? code.hashCode() : 0);
+        return result;
+    }
 }

src/main/java/com/unzer/payment/communication/json/JsonCharge.java

@@ -15,9 +15,12 @@
  */
 package com.unzer.payment.communication.json;
 
+import com.unzer.payment.Cancel;
+
 public class JsonCharge extends JsonInitPayment implements JsonObject {
 
     private String invoiceId;
+    private String reasonCode;
 
     public JsonCharge() {
         super();
@@ -51,4 +54,7 @@ public void setInvoiceId(String invoiceId) {
         this.invoiceId = invoiceId;
     }
 
+    public void setReasonCode(String reasonCode) {
+        this.reasonCode = reasonCode;
+    }
 }

src/main/java/com/unzer/payment/communication/mapper/JsonToBusinessClassMapper.java

@@ -57,6 +57,10 @@ public JsonObject map(Cancel cancel) {
         JsonCharge json = new JsonCharge();
         json.setAmount(cancel.getAmount());
         json.setPaymentReference(cancel.getPaymentReference());
+
+        if (cancel.getReasonCode() != null) {
+            json.setReasonCode(cancel.getReasonCode().toString());
+        }
         return json;
     }
 

src/test/java/com/unzer/payment/business/paymenttypes/InvoiceSecuredTest.java

@@ -24,14 +24,19 @@
 import com.unzer.payment.communication.json.JsonIdObject;
 import com.unzer.payment.paymenttypes.InvoiceSecured;
 import com.unzer.payment.service.PaymentService;
+import org.junit.jupiter.api.DynamicTest;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestFactory;
 
 import java.math.BigDecimal;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.text.ParseException;
+import java.util.Collection;
 import java.util.Currency;
 import java.util.Date;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import static com.unzer.payment.business.BasketV1TestData.getMaxTestBasketV1;
 import static com.unzer.payment.business.BasketV1TestData.getMinTestBasketV1;
@@ -40,6 +45,7 @@
 import static com.unzer.payment.util.Url.unsafeUrl;
 import static com.unzer.payment.util.Uuid.generateUuid;
 import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.DynamicTest.dynamicTest;
 
 public class InvoiceSecuredTest extends AbstractPaymentTest {
 
@@ -224,6 +230,70 @@ public void testChargeInvoiceFactoringBasketV2() throws HttpCommunicationExcepti
         assertNotNull(charge.getPaymentId());
     }
 
+    @TestFactory
+    public Collection<DynamicTest> testCancelInvoiceSecured() {
+        return Stream.of(Cancel.ReasonCode.RETURN, Cancel.ReasonCode.RETURN, Cancel.ReasonCode.CREDIT)
+                .map(rc -> dynamicTest(rc.name(), () -> {
+                    Unzer unzer = getUnzer();
+                    InvoiceSecured paymentType = unzer.createPaymentType(new InvoiceSecured());
+                    Basket basket = getMaxTestBasketV2();
+                    String invoiceId = getRandomInvoiceId();
+                    Charge charge = paymentType.charge(
+                            basket.getTotalValueGross(),
+                            Currency.getInstance("EUR"),
+                            unsafeUrl("https://www.meinShop.de"),
+                            getMaximumCustomerSameAddress(generateUuid()),
+                            basket,
+                            invoiceId
+                    );
+                    Cancel cancel = unzer.cancelCharge(
+                            charge.getPaymentId(),
+                            charge.getId(),
+                            (Cancel) new Cancel(unzer)
+                                    .setReasonCode(rc)
+                                    .setAmount(basket.getTotalValueGross())
+                    );
+                    assertNotNull(cancel);
+                    assertNotNull(cancel.getId());
+                    assertEquals(Cancel.Status.SUCCESS, cancel.getStatus());
+                })).collect(Collectors.toList());
+    }
+
+    @Test
+    public void testCancelFailsWithoutReasonCode() throws HttpCommunicationException {
+        PaymentError expectedError = new PaymentError(
+                "Reason code is mandatory for the payment type INVOICE_SECURED",
+                "Reason code is mandatory for the payment type INVOICE_SECURED. Please contact us for more information.",
+                "API.340.100.024"
+        );
+
+        Unzer unzer = getUnzer();
+        InvoiceSecured paymentType = unzer.createPaymentType(new InvoiceSecured());
+        Basket basket = getMaxTestBasketV2();
+        String invoiceId = getRandomInvoiceId();
+        Charge charge = paymentType.charge(
+                basket.getTotalValueGross(),
+                Currency.getInstance("EUR"),
+                unsafeUrl("https://www.meinShop.de"),
+                getMaximumCustomerSameAddress(generateUuid()),
+                basket,
+                invoiceId
+        );
+
+        PaymentException exception = assertThrows(PaymentException.class, () -> {
+            unzer.cancelCharge(
+                    charge.getPaymentId(),
+                    charge.getId(),
+                    (Cancel) new Cancel(unzer)
+                            .setAmount(basket.getTotalValueGross())
+            );
+        });
+        assertEquals(1, exception.getPaymentErrorList().size());
+        PaymentError actualError = exception.getPaymentErrorList().get(0);
+
+        assertEquals(expectedError, actualError);
+    }
+
 
     @Deprecated
     private InvoiceSecured getInvoiceSecured() {