Package com.broadleafcommerce.cartoperation.service.payment.autoconfigure

Class ExternalPaymentTransactionProperties.CartPaymentFinalizationProperties

java.lang.Object
com.broadleafcommerce.cartoperation.service.payment.autoconfigure.ExternalPaymentTransactionProperties.CartPaymentFinalizationProperties
Enclosing class:
ExternalPaymentTransactionProperties
public static class ExternalPaymentTransactionProperties.CartPaymentFinalizationProperties extends Object
Properties related to managing a cart in the DefaultCartStatuses.AWAITING_PAYMENT_FINALIZATION status

  • Constructor Details

    • CartPaymentFinalizationProperties

      public CartPaymentFinalizationProperties()

  • Method Details

    • isEnterAwaitingPaymentFinalizationOnPaymentFailure

      public boolean isEnterAwaitingPaymentFinalizationOnPaymentFailure()
      If true, then the cart will enter the DefaultCartStatuses.AWAITING_PAYMENT_FINALIZATION status when any non-3DS & non-HPP payment failure is encountered. Otherwise, this status is only entered if the cart's payments have failures requiring 3DS verification or a HPP interaction, & if any other payment failure is encountered, then the cart status is returned to DefaultCartStatuses.IN_PROCESS

    • getCartLockTtl

      public Duration getCartLockTtl()
      The amount of time before the cart's payment finalization lock expires. Once this duration is exceeded, the cart status will be reset to DefaultCartStatuses.IN_PROCESS & the cart's payments will be archived or have their customer mutability block removed.

      Note: It's very important that the transaction reversal candidate time-to-live (broadleaf.paymenttransaction.reversal.reversal-candidate-ttl) used within PaymentTransactionServices.

    • isArchivePaymentsWhenCartIsUnlocked

      public boolean isArchivePaymentsWhenCartIsUnlocked()
      If true, then the cart's payments will be archived when the cart is unlocked via CartOperationService.releasePaymentFinalizationLock(Cart, ContextInfo). If false, then the DefaultPaymentManagementAccessRestrictions.CUSTOMER_MUTABILITY_BLOCKED_FOR_PAYMENT_FINALIZATION access restriction is removed from the cart's relevant payments. This property defaults to true.

    • setEnterAwaitingPaymentFinalizationOnPaymentFailure

      public void setEnterAwaitingPaymentFinalizationOnPaymentFailure(boolean enterAwaitingPaymentFinalizationOnPaymentFailure)
      If true, then the cart will enter the DefaultCartStatuses.AWAITING_PAYMENT_FINALIZATION status when any non-3DS & non-HPP payment failure is encountered. Otherwise, this status is only entered if the cart's payments have failures requiring 3DS verification or a HPP interaction, & if any other payment failure is encountered, then the cart status is returned to DefaultCartStatuses.IN_PROCESS

    • setCartLockTtl

      public void setCartLockTtl(Duration cartLockTtl)
      The amount of time before the cart's payment finalization lock expires. Once this duration is exceeded, the cart status will be reset to DefaultCartStatuses.IN_PROCESS & the cart's payments will be archived or have their customer mutability block removed.

      Note: It's very important that the transaction reversal candidate time-to-live (broadleaf.paymenttransaction.reversal.reversal-candidate-ttl) used within PaymentTransactionServices.

    • setArchivePaymentsWhenCartIsUnlocked

      public void setArchivePaymentsWhenCartIsUnlocked(boolean archivePaymentsWhenCartIsUnlocked)
      If true, then the cart's payments will be archived when the cart is unlocked via CartOperationService.releasePaymentFinalizationLock(Cart, ContextInfo). If false, then the DefaultPaymentManagementAccessRestrictions.CUSTOMER_MUTABILITY_BLOCKED_FOR_PAYMENT_FINALIZATION access restriction is removed from the cart's relevant payments. This property defaults to true.