Enum Class DefaultTransactionFailureTypes
java.lang.Object
java.lang.Enum<DefaultTransactionFailureTypes>
com.broadleafcommerce.cartoperation.domain.enums.DefaultTransactionFailureTypes
- All Implemented Interfaces:
TransactionFailureType
,Serializable
,Comparable<DefaultTransactionFailureTypes>
,Constable
public enum DefaultTransactionFailureTypes
extends Enum<DefaultTransactionFailureTypes>
implements TransactionFailureType
The default set of
transactionFailureTypes
that we expect to
encounter with payment gateway interactions- Author:
- Chris Kittrell (ckittrell)
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionAn error that occurs when too many requests hit the gateway's API too quicklyThe transaction has been cancelled by the customer.The transaction has expired.The gateway is incorrectly configured or is not configured to handle the attempted type of requestThe provided payment gateway credentials are not validThere was an unexpected error with the payment gateway itself.There was an error in our preparation of the gateway interaction or in our interpretation/storing of the response.The provided payment method data is invalid.There was a failure to process the request because the request itself is invalid.There was an error in communicating with the payment gateway.The payment gateway failed to successfully process the transaction.Additional verification is required from the customer for the gateway to successfully process the transactionAdditional action is required for the transaction to be successfully processedThis transaction requires additional interaction from the customer from an external source.Requires interaction with the gateway's hosted payment page.There was an error when checking the validity of the response. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
isAPIRateLimitError
(String failureType) static boolean
isCanceled
(String failureType) static boolean
static boolean
isGatewayConfigurationError
(String failureType) static boolean
isGatewayCredentialsError
(String failureType) static boolean
isGatewayError
(String failureType) static boolean
isInternalError
(String failureType) static boolean
isInvalidPaymentMethod
(String failureType) static boolean
isInvalidRequest
(String failureType) static boolean
isNetworkError
(String failureType) static boolean
isProcessingFailure
(String failureType) static boolean
isRequires3DSVerification
(String failureType) static boolean
isRequiresAdditionalAction
(String failureType) static boolean
isRequiresExternalInteraction
(String failureType) static boolean
isRequiresHostedPaymentPageInteraction
(String failureType) static boolean
isResponseValidationFailure
(String failureType) Returns the enum constant of this class with the specified name.static DefaultTransactionFailureTypes[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface com.broadleafcommerce.cartoperation.domain.enums.TransactionFailureType
name
-
Enum Constant Details
-
GATEWAY_CREDENTIALS_ERROR
The provided payment gateway credentials are not valid -
GATEWAY_CONFIGURATION_ERROR
The gateway is incorrectly configured or is not configured to handle the attempted type of request -
INVALID_REQUEST
There was a failure to process the request because the request itself is invalid. -
INVALID_PAYMENT_METHOD
The provided payment method data is invalid. This could be an incorrect card number, expiration date, etc. -
PROCESSING_FAILURE
The payment gateway failed to successfully process the transaction. This primarily represents a declined payment. -
REQUIRES_3DS_VERIFICATION
Additional verification is required from the customer for the gateway to successfully process the transaction -
REQUIRES_ADDITIONAL_ACTION
Additional action is required for the transaction to be successfully processed -
GATEWAY_ERROR
There was an unexpected error with the payment gateway itself. -
NETWORK_ERROR
There was an error in communicating with the payment gateway. This can correlate to a known network failure/timeout or connection issue. -
RESPONSE_VALIDATION_FAILURE
There was an error when checking the validity of the response. Therefore, we're unsure if we can trust the contents of the response. In this case, it's best to treat the transaction as a failure and investigate it offline. -
API_RATE_LIMIT_ERROR
An error that occurs when too many requests hit the gateway's API too quickly -
INTERNAL_ERROR
There was an error in our preparation of the gateway interaction or in our interpretation/storing of the response. -
REQUIRES_EXTERNAL_INTERACTION
This transaction requires additional interaction from the customer from an external source. This typically requires a external redirect to provide or verify customer banking details. -
REQUIRES_HOSTED_PAYMENT_PAGE_INTERACTION
Requires interaction with the gateway's hosted payment page. Completion of that interaction will trigger the execution of the transaction. -
CANCELED
The transaction has been cancelled by the customer. This is typically used for 3DS/HPP interactions where the customer has decided that they no longer want to use that payment method. -
EXPIRED
The transaction has expired. This typically happens when an action was required by the customer to complete the transaction, but they failed to complete the action.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isGatewayCredentialsError
-
isGatewayConfigurationError
-
isInvalidRequest
-
isInvalidPaymentMethod
-
isProcessingFailure
-
isRequires3DSVerification
-
isRequiresAdditionalAction
-
isGatewayError
-
isNetworkError
-
isResponseValidationFailure
-
isAPIRateLimitError
-
isInternalError
-
isRequiresExternalInteraction
-
isRequiresHostedPaymentPageInteraction
-
isCanceled
-
isExpired
-