Package com.broadleafcommerce.paymenttransaction.service.summary

Class DefaultPaymentSummaryService

java.lang.Object

com.broadleafcommerce.paymenttransaction.service.summary.DefaultPaymentSummaryService

All Implemented Interfaces:

PaymentSummaryService

public class DefaultPaymentSummaryService
extends Object
implements PaymentSummaryService

Default implementation of the PaymentSummaryService.

Author:

Dima Myroniuk (dmyroniuk)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREDIT_ACCOUNT_NUMBER_ATTR_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultPaymentSummaryService(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider paymentGatewayResourceProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected PaymentSummary	buildBasePaymentSummary(Payment payment)	Builds the base PaymentSummary from the given Payment.
PaymentSummary	buildPaymentSummary(@NonNull Payment payment, @NonNull Set<String> sourceEntityTypes)	Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().
PaymentSummary	buildPaymentSummary(@NonNull Payment payment, String sourceEntityType, String sourceEntityId)	Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().
protected javax.money.MonetaryAmount	determineAmountAwaiting3DSResults(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the amount awaiting 3DS results.
protected javax.money.MonetaryAmount	determineAmountAwaitingExternalResults(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the amount awaiting external results.
protected javax.money.MonetaryAmount	determineAuthorizeAmountAwaitingResult(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the authorize amount awaiting payment gateway result from the payment transactions.
protected javax.money.MonetaryAmount	determineAuthorizedAmount(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the authorized amount of the payment transactions - "total authorized - total reverse-authed".
protected javax.money.MonetaryAmount	determineCaptureAmountAwaitingResult(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the capture amount awaiting payment gateway result from the payment transactions.
protected javax.money.MonetaryAmount	determineCapturedAmount(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the captured amount of the payment transactions - "total captured - total refunded".
protected javax.money.MonetaryAmount	determineDetachedCreditAmount(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the detached amount of the payment transactions.
protected javax.money.MonetaryAmount	determineRefundAmountAwaitingResult(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the refund amount awaiting payment gateway result from the payment transactions.
protected javax.money.MonetaryAmount	determineRefundedAmount(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the refunded amount of the payment transactions.
protected javax.money.MonetaryAmount	determineReverseAuthAmountAwaitingResult(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the reverse authorize amount awaiting payment gateway result from the payment transactions.
protected javax.money.MonetaryAmount	determineTotalEverCaptured(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions)	Determines the total amount ever captured by the payment transactions.
protected List<PaymentTransaction>	filterByTransactionSourceEntity(@NonNull List<PaymentTransaction> transactions, String sourceEntityType, String sourceEntityId)	Filters the PaymentTransactions by PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().
protected List<PaymentTransaction>	filterByTransactionSourceEntityTypes(List<PaymentTransaction> transactions, Set<String> sourceEntityTypes)	Filters the PaymentTransactions by PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().
protected List<PaymentTransaction>	filterOutNonSuccessfulAndReversedTransactions(@NonNull List<PaymentTransaction> transactions)
protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider	getPaymentGatewayResourceProvider()
protected String	getTenantId(@NonNull Payment payment)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	hasTransactionFlaggedForManualReview(@NonNull List<PaymentTransaction> filteredTransactions)
protected Optional<PaymentTransaction>	identifyTransactionRequiringNextAction(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions, String tenantId)	Returns the list of transactions that requires to execute the NextAction.
protected boolean	isDetachedCreditActingAsRefund(@NonNull PaymentTransaction transaction)
protected boolean	isPartialReverseAuthSupported(@NonNull Payment payment)
protected boolean	isReverseAuthRemainder(@NonNull Payment payment)
protected void	setNextActionIfNeeded(@NonNull PaymentSummary paymentSummary, @NonNull List<PaymentTransaction> transactions, String tenantId)	Sets the PaymentSummary.getNextAction() for the PaymentTransaction.getNextAction() if exists.
protected void	updatePaymentSummaryForAmountAwaiting3DSResults(PaymentSummary paymentSummary, List<PaymentTransaction> transactions)	Update PaymentSummary for PaymentTransactions that are awaiting 3DS results.
protected void	updatePaymentSummaryForAmountAwaitingExternalResults(PaymentSummary paymentSummary, List<PaymentTransaction> transactions)	Update PaymentSummary for PaymentTransactions that are awaiting external results.
protected void	updatePaymentSummaryForPendingAmounts(PaymentSummary paymentSummary, List<PaymentTransaction> transactions)	Update PaymentSummary for PaymentTransactions that are awaiting async results or 3DS results.
protected void	updatePaymentSummaryProcessedAmounts(PaymentSummary paymentSummary, List<PaymentTransaction> nonReversedTransactions)	Update PaymentSummary for PaymentTransactions that are successful.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.paymenttransaction.service.summary.PaymentSummaryService

buildPaymentSummaries, buildPaymentSummary

Field Details

CREDIT_ACCOUNT_NUMBER_ATTR_NAME

public static final String CREDIT_ACCOUNT_NUMBER_ATTR_NAME

See Also:

• Constant Field Values

Constructor Details

DefaultPaymentSummaryService

public DefaultPaymentSummaryService(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider paymentGatewayResourceProvider,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

buildPaymentSummary

public PaymentSummary buildPaymentSummary(@NonNull
 @NonNull Payment payment,
 @Nullable
 String sourceEntityType,
 @Nullable
 String sourceEntityId)

Description copied from interface: PaymentSummaryService

Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Specified by:

buildPaymentSummary in interface PaymentSummaryService

Parameters:

payment - the payment to determine the summary

sourceEntityType - the PaymentTransaction.getSourceEntityType() to filter the Payment.getTransactions() by

sourceEntityId - the PaymentTransaction.getSourceEntityId() to filter the Payment.getTransactions() by

Returns:

the payment summary for the specified payment

buildPaymentSummary

public PaymentSummary buildPaymentSummary(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull Set<String> sourceEntityTypes)

Description copied from interface: PaymentSummaryService

Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Specified by:

buildPaymentSummary in interface PaymentSummaryService

Parameters:

payment - the payment to determine the summary

sourceEntityTypes - the set of PaymentTransaction.getSourceEntityType() to filter the Payment.getTransactions() by

Returns:

the payment summary for the specified payment

updatePaymentSummaryForAmountAwaiting3DSResults

protected void updatePaymentSummaryForAmountAwaiting3DSResults(PaymentSummary paymentSummary,
 List<PaymentTransaction> transactions)

Update PaymentSummary for PaymentTransactions that are awaiting 3DS results.

Parameters:

paymentSummary - the PaymentSummary to update

transactions - the PaymentTransactions

updatePaymentSummaryForAmountAwaitingExternalResults

protected void updatePaymentSummaryForAmountAwaitingExternalResults(PaymentSummary paymentSummary,
 List<PaymentTransaction> transactions)

Update PaymentSummary for PaymentTransactions that are awaiting external results.

Parameters:

paymentSummary - the PaymentSummary to update

transactions - the PaymentTransactions

setNextActionIfNeeded

protected void setNextActionIfNeeded(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions,
 @Nullable
 String tenantId)

Sets the PaymentSummary.getNextAction() for the PaymentTransaction.getNextAction() if exists.

Parameters:

paymentSummary - the PaymentSummary to update

transactions - the PaymentTransactions

tenantId - the id of the payment's tenant

identifyTransactionRequiringNextAction

protected Optional<PaymentTransaction> identifyTransactionRequiringNextAction(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions,
 @Nullable
 String tenantId)

Returns the list of transactions that requires to execute the NextAction.

Parameters:

paymentSummary - the PaymentSummary owning the provided transactions

transactions - the PaymentTransactions

tenantId - the id of the payment's tenant

Returns:

the list of transactions that requires to execute the NextAction

updatePaymentSummaryProcessedAmounts

protected void updatePaymentSummaryProcessedAmounts(PaymentSummary paymentSummary,
 List<PaymentTransaction> nonReversedTransactions)

Update PaymentSummary for PaymentTransactions that are successful.

Parameters:

paymentSummary - the PaymentSummary to update

nonReversedTransactions - the non-reversed or reversal PaymentTransactions

updatePaymentSummaryForPendingAmounts

protected void updatePaymentSummaryForPendingAmounts(PaymentSummary paymentSummary,
 List<PaymentTransaction> transactions)

Update PaymentSummary for PaymentTransactions that are awaiting async results or 3DS results.

Parameters:

paymentSummary - the PaymentSummary to update

transactions - the PaymentTransactions

filterOutNonSuccessfulAndReversedTransactions

protected List<PaymentTransaction> filterOutNonSuccessfulAndReversedTransactions(@NonNull
 @NonNull List<PaymentTransaction> transactions)

filterByTransactionSourceEntity

protected List<PaymentTransaction> filterByTransactionSourceEntity(@NonNull
 @NonNull List<PaymentTransaction> transactions,
 @Nullable
 String sourceEntityType,
 @Nullable
 String sourceEntityId)

Filters the PaymentTransactions by PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Parameters:

transactions - the PaymentTransactions to filter

sourceEntityType - the PaymentTransaction.getSourceEntityType() to filter by

sourceEntityId - the PaymentTransaction.getSourceEntityId() to filter by

Returns:

the PaymentTransactions matching the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

filterByTransactionSourceEntityTypes

protected List<PaymentTransaction> filterByTransactionSourceEntityTypes(List<PaymentTransaction> transactions,
 Set<String> sourceEntityTypes)

Filters the PaymentTransactions by PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Parameters:

transactions - the PaymentTransactions to filter

sourceEntityTypes - the set of PaymentTransaction.getSourceEntityType() to filter by

Returns:

the PaymentTransactions matching the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

buildBasePaymentSummary

protected PaymentSummary buildBasePaymentSummary(Payment payment)

Builds the base PaymentSummary from the given Payment.

Parameters:

payment - the Payment to build the PaymentSummary from

Returns:

the base PaymentSummary from the given Payment

isPartialReverseAuthSupported

protected boolean isPartialReverseAuthSupported(@NonNull
 @NonNull Payment payment)

isReverseAuthRemainder

protected boolean isReverseAuthRemainder(@NonNull
 @NonNull Payment payment)

determineAuthorizedAmount

protected javax.money.MonetaryAmount determineAuthorizedAmount(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the authorized amount of the payment transactions - "total authorized - total reverse-authed".

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the authorized amount of the payment transactions

determineCapturedAmount

protected javax.money.MonetaryAmount determineCapturedAmount(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the captured amount of the payment transactions - "total captured - total refunded".

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the captured amount of the payment transactions

determineTotalEverCaptured

protected javax.money.MonetaryAmount determineTotalEverCaptured(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the total amount ever captured by the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the total amount ever captured by the payment transactions

determineDetachedCreditAmount

protected javax.money.MonetaryAmount determineDetachedCreditAmount(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the detached amount of the payment transactions. If the transaction has the parent transaction with DefaultTransactionTypes.CAPTURE or DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE type the detached amount is skipped and will be added to PaymentSummary.getAmountRefunded().

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the detached amount of the payment transactions

determineRefundedAmount

protected javax.money.MonetaryAmount determineRefundedAmount(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the refunded amount of the payment transactions. If there is the DefaultTransactionTypes.DETACHED_CREDIT transaction with the DefaultTransactionTypes.CAPTURE or DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE parent transaction the detached amount will be included in refunded amount.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the refunded amount of the payment transactions

determineAmountAwaiting3DSResults

protected javax.money.MonetaryAmount determineAmountAwaiting3DSResults(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the amount awaiting 3DS results.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment's collection of transactions

Returns:

the amount awaiting 3DS results.

determineAmountAwaitingExternalResults

protected javax.money.MonetaryAmount determineAmountAwaitingExternalResults(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the amount awaiting external results.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment's collection of transactions

Returns:

the amount awaiting external results.

determineAuthorizeAmountAwaitingResult

protected javax.money.MonetaryAmount determineAuthorizeAmountAwaitingResult(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the authorize amount awaiting payment gateway result from the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the authorize amount awaiting payment gateway result from the payment transactions

determineCaptureAmountAwaitingResult

protected javax.money.MonetaryAmount determineCaptureAmountAwaitingResult(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the capture amount awaiting payment gateway result from the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the capture amount awaiting payment gateway result from the payment transactions

determineReverseAuthAmountAwaitingResult

protected javax.money.MonetaryAmount determineReverseAuthAmountAwaitingResult(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the reverse authorize amount awaiting payment gateway result from the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the reverse authorize amount awaiting payment gateway result from the payment transactions

determineRefundAmountAwaitingResult

protected javax.money.MonetaryAmount determineRefundAmountAwaitingResult(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Determines the refund amount awaiting payment gateway result from the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the refund amount awaiting payment gateway result from the payment transactions

isDetachedCreditActingAsRefund

protected boolean isDetachedCreditActingAsRefund(@NonNull
 @NonNull PaymentTransaction transaction)

hasTransactionFlaggedForManualReview

protected boolean hasTransactionFlaggedForManualReview(@NonNull
 @NonNull List<PaymentTransaction> filteredTransactions)

getTenantId

@Nullable
protected String getTenantId(@NonNull
 @NonNull Payment payment)

getPaymentGatewayResourceProvider

protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider getPaymentGatewayResourceProvider()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()