Merge pull request #6215 from alphagov/PP-14844-add_rejection_reason_to_entity

PP-14844 add gateway_rejection_reason to ChargeEntity

Author: SandorArpa

src/main/java/uk/gov/pay/connector/charge/model/domain/ChargeEntity.java

@@ -214,6 +214,9 @@ public class ChargeEntity extends AbstractVersionedEntity {
 
     @Column(name = "requires_3ds")
     private Boolean requires3ds;
+    
+    @Column(name = "gateway_rejection_reason")
+    private String gatewayRejectionReason;
 
     public ChargeEntity() {
         //for jpa
@@ -289,7 +292,11 @@ public Optional<PaymentInstrumentEntity> getPaymentInstrument() {
     public void setPaymentInstrument(PaymentInstrumentEntity paymentInstrument) {
         this.paymentInstrument = paymentInstrument;
     }
-    
+
+    public void setGatewayRejectionReason(String gatewayRejectionReason) {
+        this.gatewayRejectionReason = gatewayRejectionReason;
+    }
+
     public Long getAmount() {
         return amount;
     }
@@ -625,6 +632,10 @@ public Instant getUpdatedDate() {
         return updatedDate;
     }
 
+    public String getGatewayRejectionReason() {
+        return gatewayRejectionReason;
+    }
+
     public static final class WebChargeEntityBuilder {
         private Long amount;
         private String returnUrl;

src/test/java/uk/gov/pay/connector/charge/model/domain/ChargeEntityFixture.java

@@ -79,6 +79,7 @@ public class ChargeEntityFixture {
     private Boolean requires3ds;
     private ChargeResponse.AuthorisationSummary authorisationSummary;
     private AgreementPaymentType agreementPaymentType;
+    private String gatewayRejectionReason;
 
     public static ChargeEntityFixture aValidChargeEntity() {
         return new ChargeEntityFixture();
@@ -178,6 +179,7 @@ public ChargeEntity build() {
         chargeEntity.setExemption3dsRequested(exemption3dsRequested);
         chargeEntity.setPaymentInstrument(paymentInstrument);
         chargeEntity.setUpdatedDate(updatedDate);
+        chargeEntity.setGatewayRejectionReason(gatewayRejectionReason);
 
         if (this.auth3DsRequiredEntity != null) {
             chargeEntity.set3dsRequiredDetails(auth3DsRequiredEntity);
@@ -375,6 +377,11 @@ public ChargeEntityFixture withSavePaymentInstrumentToAgreement(boolean savePaym
         return this;
     }
 
+    public ChargeEntityFixture withGatewayRejectionReason(String gatewayRejectionReason) {
+        this.gatewayRejectionReason = gatewayRejectionReason;
+        return this;
+    }
+
     public ChargeEntityFixture withPaymentInstrument(PaymentInstrumentEntity paymentInstrument) {
         this.paymentInstrument = paymentInstrument;
         return this;

src/test/java/uk/gov/pay/connector/it/dao/ChargeDaoIT.java

@@ -342,6 +342,22 @@ void shouldUpdateChargeWithExemption3dsType() {
         assertEquals(chargeDao.findByExternalId(chargeEntity.getExternalId()).get().getExemption3dsRequested(), Exemption3dsType.OPTIMISED);
     }
 
+    @Test
+    void shouldUpdateChargeWithGatewayRejectionReason() {
+        ChargeEntity chargeEntity = aValidChargeEntity()
+                .withGatewayAccountEntity(gatewayAccount)
+                .withGatewayAccountCredentialsEntity(gatewayAccountCredentialsEntity)
+                .build();
+        chargeDao.persist(chargeEntity);
+
+        assertNull(chargeDao.findByExternalId(chargeEntity.getExternalId()).get().getGatewayRejectionReason());
+
+        chargeEntity.setGatewayRejectionReason("fraudulent");
+        chargeDao.merge(chargeEntity);
+
+        assertEquals(chargeDao.findByExternalId(chargeEntity.getExternalId()).get().getGatewayRejectionReason(), "fraudulent");
+    }
+
     @Test
     void shouldCreateNewChargeWithParityCheckStatus() {
         ChargeEntity chargeEntity = aValidChargeEntity()

src/test/java/uk/gov/pay/connector/model/domain/ChargeEntityTest.java

@@ -234,4 +234,13 @@ void shouldSetRequires3dsToTrueWhenSettingAuth3dsRequiredEntity() {
 
         assertTrue(chargeEntity.getRequires3ds());
     }
+    
+    @Test
+    void shouldReturnGatewayRejectionReason() {
+        ChargeEntity chargeCreated = ChargeEntityFixture
+                .aValidChargeEntity()
+                .build();
+        chargeCreated.setGatewayRejectionReason("fraudulent");
+        assertThat(chargeCreated.getGatewayRejectionReason(), is("fraudulent"));
+    }
 }