From c7e777c37c7749b08ed462462096a2f9fb03615e Mon Sep 17 00:00:00 2001 From: Ruchi Dhamankar Date: Thu, 27 Apr 2023 14:48:18 +0530 Subject: [PATCH] FINERACT-1706-Allow-Chargeback-on-payment-type-transactions --- .../loanaccount/domain/LoanTransaction.java | 4 + ...WritePlatformServiceJpaRepositoryImpl.java | 8 +- ...nPaymentTypeRepaymentTransactionsTest.java | 272 ++++++++++++++++++ 3 files changed, 280 insertions(+), 4 deletions(-) create mode 100644 integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanChargebackOnPaymentTypeRepaymentTransactionsTest.java diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java index e0bbdaad4..aae4aaf1c 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanTransaction.java @@ -567,6 +567,10 @@ public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom { || isChargeAdjustment(); } + public boolean isTypeAllowedForChargeback() { + return isRepayment() || isMerchantIssuedRefund() || isPayoutRefund() || isGoodwillCredit(); + } + public boolean isRepayment() { return LoanTransactionType.REPAYMENT.equals(getTypeOf()) && isNotReversed(); } diff --git a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java index ac24bc47d..816e343fb 100644 --- a/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java +++ b/fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java @@ -1235,10 +1235,10 @@ public class LoanWritePlatformServiceJpaRepositoryImpl implements LoanWritePlatf transactionId); } - if (!loanTransaction.isRepaymentLikeType()) { - throw new PlatformServiceUnavailableException("error.msg.loan.chargeback.operation.not.allowed", - "Loan transaction:" + transactionId + " chargeback not allowed as loan transaction is not repayment type, its type is " - + loanTransaction.getTypeOf().getCode(), + if (!loanTransaction.isTypeAllowedForChargeback()) { + throw new PlatformServiceUnavailableException( + "error.msg.loan.chargeback.operation.not.allowed", "Loan transaction:" + transactionId + + " chargeback not allowed for loan transaction type, its type is " + loanTransaction.getTypeOf().getCode(), transactionId); } diff --git a/integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanChargebackOnPaymentTypeRepaymentTransactionsTest.java b/integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanChargebackOnPaymentTypeRepaymentTransactionsTest.java new file mode 100644 index 000000000..c6e2962b7 --- /dev/null +++ b/integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanChargebackOnPaymentTypeRepaymentTransactionsTest.java @@ -0,0 +1,272 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.fineract.integrationtests; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import io.restassured.builder.RequestSpecBuilder; +import io.restassured.builder.ResponseSpecBuilder; +import io.restassured.http.ContentType; +import io.restassured.specification.RequestSpecification; +import io.restassured.specification.ResponseSpecification; +import java.util.HashMap; +import java.util.UUID; +import org.apache.fineract.client.models.GetDelinquencyBucketsResponse; +import org.apache.fineract.client.models.GetLoanProductsProductIdResponse; +import org.apache.fineract.client.models.GetLoansLoanIdResponse; +import org.apache.fineract.client.models.GetLoansLoanIdTransactionsTransactionIdResponse; +import org.apache.fineract.client.models.PostLoansLoanIdTransactionsRequest; +import org.apache.fineract.client.models.PostLoansLoanIdTransactionsResponse; +import org.apache.fineract.client.models.PostLoansLoanIdTransactionsTransactionIdRequest; +import org.apache.fineract.integrationtests.common.ClientHelper; +import org.apache.fineract.integrationtests.common.Utils; +import org.apache.fineract.integrationtests.common.loans.LoanApplicationTestBuilder; +import org.apache.fineract.integrationtests.common.loans.LoanProductTestBuilder; +import org.apache.fineract.integrationtests.common.loans.LoanTestLifecycleExtension; +import org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper; +import org.apache.fineract.integrationtests.common.products.DelinquencyBucketsHelper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; + +@ExtendWith(LoanTestLifecycleExtension.class) +public class LoanChargebackOnPaymentTypeRepaymentTransactionsTest { + + private ResponseSpecification responseSpec; + private ResponseSpecification responseSpecErr400; + private ResponseSpecification responseSpecErr503; + private RequestSpecification requestSpec; + private ClientHelper clientHelper; + private LoanTransactionHelper loanTransactionHelper; + + @BeforeEach + public void setup() { + Utils.initializeRESTAssured(); + this.requestSpec = new RequestSpecBuilder().setContentType(ContentType.JSON).build(); + this.requestSpec.header("Authorization", "Basic " + Utils.loginIntoServerAndGetBase64EncodedAuthenticationKey()); + this.responseSpec = new ResponseSpecBuilder().expectStatusCode(200).build(); + this.responseSpecErr400 = new ResponseSpecBuilder().expectStatusCode(400).build(); + this.responseSpecErr503 = new ResponseSpecBuilder().expectStatusCode(503).build(); + this.loanTransactionHelper = new LoanTransactionHelper(this.requestSpec, this.responseSpec); + this.clientHelper = new ClientHelper(this.requestSpec, this.responseSpec); + } + + @Test + public void loanTransactionChargebackForPaymentTypeRepaymentTransactionTest() { + // Loan ExternalId + String loanExternalIdStr = UUID.randomUUID().toString(); + + // Delinquency Bucket + final Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec); + final GetDelinquencyBucketsResponse delinquencyBucket = DelinquencyBucketsHelper.getDelinquencyBucket(requestSpec, responseSpec, + delinquencyBucketId); + + // Client and Loan account creation + + final Integer clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId().intValue(); + final GetLoanProductsProductIdResponse getLoanProductsProductResponse = createLoanProduct(loanTransactionHelper, + delinquencyBucketId); + assertNotNull(getLoanProductsProductResponse); + + final Integer loanId = createLoanAccount(clientId, getLoanProductsProductResponse.getId(), loanExternalIdStr); + + // make Repayment + final PostLoansLoanIdTransactionsResponse repaymentTransaction_1 = loanTransactionHelper.makeLoanRepayment(loanExternalIdStr, + new PostLoansLoanIdTransactionsRequest().dateFormat("dd MMMM yyyy").transactionDate("5 September 2022").locale("en") + .transactionAmount(500.0)); + + // verify transaction relation and outstanding balance + reviewLoanTransactionRelations(loanId, repaymentTransaction_1.getResourceId(), 0, Double.valueOf("500.00")); + + GetLoansLoanIdResponse loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 500.0); + + // chargeback on Repayment + PostLoansLoanIdTransactionsResponse chargebackTransactionResponse = loanTransactionHelper.chargebackLoanTransaction( + loanExternalIdStr, repaymentTransaction_1.getResourceId(), + new PostLoansLoanIdTransactionsTransactionIdRequest().locale("en").transactionAmount(500.0).paymentTypeId(1L)); + + // verify transaction relation and outstanding balance + assertNotNull(chargebackTransactionResponse); + reviewLoanTransactionRelations(loanId, repaymentTransaction_1.getResourceId(), 1, Double.valueOf("500.00")); + reviewLoanTransactionRelations(loanId, chargebackTransactionResponse.getResourceId(), 0, Double.valueOf("1000.00")); + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 1000.0); + + // Goodwill Credit + final PostLoansLoanIdTransactionsResponse goodwillCredit_1 = loanTransactionHelper.makeGoodwillCredit((long) loanId, + new PostLoansLoanIdTransactionsRequest().dateFormat("dd MMMM yyyy").transactionDate("6 September 2022").locale("en") + .transactionAmount(200.0)); + + // verify transaction relation and outstanding balance + reviewLoanTransactionRelations(loanId, goodwillCredit_1.getResourceId(), 0, Double.valueOf("300.00")); + + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 800.0); + + // chargeback on Goodwill Credit Transaction + chargebackTransactionResponse = loanTransactionHelper.chargebackLoanTransaction(loanExternalIdStr, goodwillCredit_1.getResourceId(), + new PostLoansLoanIdTransactionsTransactionIdRequest().locale("en").transactionAmount(200.0).paymentTypeId(1L)); + + // verify transaction relation and outstanding balance + assertNotNull(chargebackTransactionResponse); + reviewLoanTransactionRelations(loanId, goodwillCredit_1.getResourceId(), 1, Double.valueOf("300.00")); + reviewLoanTransactionRelations(loanId, chargebackTransactionResponse.getResourceId(), 0, Double.valueOf("1000.00")); + + // Payout Refund + + final PostLoansLoanIdTransactionsResponse payoutRefund_1 = loanTransactionHelper.makePayoutRefund((long) loanId, + new PostLoansLoanIdTransactionsRequest().dateFormat("dd MMMM yyyy").transactionDate("7 September 2022").locale("en") + .transactionAmount(300.0)); + + // verify transaction relation and outstanding balance + reviewLoanTransactionRelations(loanId, payoutRefund_1.getResourceId(), 0, Double.valueOf("0.00")); + + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 700.0); + + // chargeback on Payout Refund Transaction + chargebackTransactionResponse = loanTransactionHelper.chargebackLoanTransaction(loanExternalIdStr, payoutRefund_1.getResourceId(), + new PostLoansLoanIdTransactionsTransactionIdRequest().locale("en").transactionAmount(300.0).paymentTypeId(1L)); + + // verify transaction relation and outstanding balance + assertNotNull(chargebackTransactionResponse); + reviewLoanTransactionRelations(loanId, payoutRefund_1.getResourceId(), 1, Double.valueOf("0.00")); + reviewLoanTransactionRelations(loanId, chargebackTransactionResponse.getResourceId(), 0, Double.valueOf("1000.00")); + + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 1000.0); + + // Merchant Issued Refund + + final PostLoansLoanIdTransactionsResponse merchantIssuedRefund_1 = loanTransactionHelper.makeMerchantIssuedRefund((long) loanId, + new PostLoansLoanIdTransactionsRequest().dateFormat("dd MMMM yyyy").transactionDate("8 September 2022").locale("en") + .transactionAmount(100.0)); + + // verify transaction relation and outstanding balance + reviewLoanTransactionRelations(loanId, merchantIssuedRefund_1.getResourceId(), 0, Double.valueOf("0.00")); + + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 900.0); + + // chargeback on Merchant Issued Refund Transaction + chargebackTransactionResponse = loanTransactionHelper.chargebackLoanTransaction(loanExternalIdStr, + merchantIssuedRefund_1.getResourceId(), + new PostLoansLoanIdTransactionsTransactionIdRequest().locale("en").transactionAmount(100.0).paymentTypeId(1L)); + + // verify transaction relation and outstanding balance + assertNotNull(chargebackTransactionResponse); + reviewLoanTransactionRelations(loanId, merchantIssuedRefund_1.getResourceId(), 1, Double.valueOf("0.00")); + reviewLoanTransactionRelations(loanId, chargebackTransactionResponse.getResourceId(), 0, Double.valueOf("1000.00")); + + loanDetails = loanTransactionHelper.getLoanDetails((long) loanId); + assertNotNull(loanDetails); + assertTrue(loanDetails.getStatus().getActive()); + assertNotNull(loanDetails.getSummary()); + assertEquals(loanDetails.getSummary().getTotalOutstanding(), 1000.0); + + } + + @Test + public void loanChargebackNotAllowedForReversedPaymentTypeRepaymentTest() { + // Loan ExternalId + String loanExternalIdStr = UUID.randomUUID().toString(); + + // Delinquency Bucket + final Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec); + final GetDelinquencyBucketsResponse delinquencyBucket = DelinquencyBucketsHelper.getDelinquencyBucket(requestSpec, responseSpec, + delinquencyBucketId); + + // Client and Loan account creation + + final Integer clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId().intValue(); + final GetLoanProductsProductIdResponse getLoanProductsProductResponse = createLoanProduct(loanTransactionHelper, + delinquencyBucketId); + assertNotNull(getLoanProductsProductResponse); + + final Integer loanId = createLoanAccount(clientId, getLoanProductsProductResponse.getId(), loanExternalIdStr); + + // Merchant Refund + final PostLoansLoanIdTransactionsResponse merchantIssuedRefund_2 = loanTransactionHelper.makeMerchantIssuedRefund((long) loanId, + new PostLoansLoanIdTransactionsRequest().dateFormat("dd MMMM yyyy").transactionDate("8 September 2022").locale("en") + .transactionAmount(50.0)); + + // reverse Merchant Refund + loanTransactionHelper.reverseRepayment(loanId, merchantIssuedRefund_2.getResourceId().intValue(), "8 September 2022"); + + // apply Chargeback should give 503 error + final Long chargebackTransactionId = loanTransactionHelper.applyChargebackTransaction(loanId, + merchantIssuedRefund_2.getResourceId(), "50.00", 1, responseSpecErr503); + + } + + private GetLoanProductsProductIdResponse createLoanProduct(final LoanTransactionHelper loanTransactionHelper, + final Integer delinquencyBucketId) { + final HashMap loanProductMap = new LoanProductTestBuilder().build(null, delinquencyBucketId); + final Integer loanProductId = loanTransactionHelper.getLoanProductId(Utils.convertToJson(loanProductMap)); + return loanTransactionHelper.getLoanProduct(loanProductId); + } + + private Integer createLoanAccount(final Integer clientID, final Long loanProductID, final String externalId) { + + String loanApplicationJSON = new LoanApplicationTestBuilder().withPrincipal("1000").withLoanTermFrequency("1") + .withLoanTermFrequencyAsMonths().withNumberOfRepayments("1").withRepaymentEveryAfter("1") + .withRepaymentFrequencyTypeAsMonths().withInterestRatePerPeriod("0").withInterestTypeAsFlatBalance() + .withAmortizationTypeAsEqualPrincipalPayments().withInterestCalculationPeriodTypeSameAsRepaymentPeriod() + .withExpectedDisbursementDate("03 September 2022").withSubmittedOnDate("01 September 2022").withLoanType("individual") + .withExternalId(externalId).build(clientID.toString(), loanProductID.toString(), null); + + final Integer loanId = loanTransactionHelper.getLoanId(loanApplicationJSON); + loanTransactionHelper.approveLoan("02 September 2022", "1000", loanId, null); + loanTransactionHelper.disburseLoanWithNetDisbursalAmount("03 September 2022", loanId, "1000"); + return loanId; + } + + private void reviewLoanTransactionRelations(final Integer loanId, final Long transactionId, final Integer expectedSize, + final Double outstandingBalance) { + + GetLoansLoanIdTransactionsTransactionIdResponse getLoansTransactionResponse = loanTransactionHelper.getLoanTransaction(loanId, + transactionId.intValue()); + assertNotNull(getLoansTransactionResponse); + assertNotNull(getLoansTransactionResponse.getTransactionRelations()); + assertEquals(expectedSize, getLoansTransactionResponse.getTransactionRelations().size()); + // Outstanding amount + assertEquals(outstandingBalance, getLoansTransactionResponse.getOutstandingLoanBalance()); + } +}