Enum Class PaymentDeclineType

java.lang.Object
java.lang.Enum<PaymentDeclineType>
com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
All Implemented Interfaces:
Serializable, Comparable<PaymentDeclineType>, Constable

public enum PaymentDeclineType extends Enum<PaymentDeclineType> implements Serializable
When a payment gateway declines a payment, this value indicates whether it is a "soft" (insufficient funds) or "hard" (stolen card) decline. Generally, soft declines may be resolved given some time, and therefore, these payment methods can be retried. On the other hand, if a payment method receives a hard decline, then it will continuously fail and should not be used again.
Author:
gdiaz, Chris Kittrell (ckittrell)
  • Enum Constant Details

  • Method Details

    • values

      public static PaymentDeclineType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PaymentDeclineType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • isSoftDecline

      public static boolean isSoftDecline(String declineType)
    • isHardDecline

      public static boolean isHardDecline(String declineType)
    • getFriendlyName

      public String getFriendlyName()