Package com.broadleafcommerce.paymentgateway.domain.enums

Enum Class DefaultGatewayFeatureType

java.lang.Object

java.lang.Enum<DefaultGatewayFeatureType>

com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

All Implemented Interfaces:

Serializable, Comparable<DefaultGatewayFeatureType>, Constable

public enum DefaultGatewayFeatureType
extends Enum<DefaultGatewayFeatureType>

Defines common features that gateways implement.

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUY_NOW_PAY_LATER	Whether the gateway supports a buy-now-pay-later feature.
FORCED_REVERSE_AUTH_WITH_PARTIAL_CAPTURE	Declares that when a partial capture is executed for the gateway, they ALWAYS automatically execute a reverse-authorization for the remaining authorized amount.
MULTI_USE_PAYMENT_METHODS	Whether payment methods (a.k.a tokens in some systems) can be reused to initiate a future line of transaction.
PARTIAL_CAPTURE	Whether this gateway allows capturing less than the full amount.
PARTIAL_REFUND	Similar to PARTIAL_CAPTURE but with refunds.
PARTIAL_REVERSE_AUTH	Similar to PARTIAL_CAPTURE but with reverse-authorizations.
RECURRING_PAYMENTS	Whether the gateway supports recurring or subscription payments.
REVERSE_AUTH_REMAINDER	Declares that this gateway's reverse authorize transaction can only be applied to the full remaining non-captured amount.
SAVED_PAYMENTS	Whether the gateway supports saving customer payments for future use.
THREE_D_SECURE	Whether the payment gateway supports 3D Secure fraud detection.

Method Summary

Modifier and Type	Method	Description
static DefaultGatewayFeatureType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultGatewayFeatureType[]	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

THREE_D_SECURE

public static final DefaultGatewayFeatureType THREE_D_SECURE

Whether the payment gateway supports 3D Secure fraud detection.

PARTIAL_CAPTURE

public static final DefaultGatewayFeatureType PARTIAL_CAPTURE

Whether this gateway allows capturing less than the full amount. For example, the full price of an order is $100, but you can capture just the amount for item 1 which is $10.

WARNING: This does not imply that the same transaction can be captured on again. For some gateways, after doing a partial capture, the rest of the funds are released back to the customer. To capture the rest, a new transaction will need to be created.

FORCED_REVERSE_AUTH_WITH_PARTIAL_CAPTURE

public static final DefaultGatewayFeatureType FORCED_REVERSE_AUTH_WITH_PARTIAL_CAPTURE

Declares that when a partial capture is executed for the gateway, they ALWAYS automatically execute a reverse-authorization for the remaining authorized amount.

PARTIAL_REFUND

public static final DefaultGatewayFeatureType PARTIAL_REFUND

Similar to PARTIAL_CAPTURE but with refunds.

PARTIAL_REVERSE_AUTH

public static final DefaultGatewayFeatureType PARTIAL_REVERSE_AUTH

Similar to PARTIAL_CAPTURE but with reverse-authorizations.

REVERSE_AUTH_REMAINDER

public static final DefaultGatewayFeatureType REVERSE_AUTH_REMAINDER

Declares that this gateway's reverse authorize transaction can only be applied to the full remaining non-captured amount.

BUY_NOW_PAY_LATER

public static final DefaultGatewayFeatureType BUY_NOW_PAY_LATER

Whether the gateway supports a buy-now-pay-later feature. Some gateways call these "installments".

MULTI_USE_PAYMENT_METHODS

public static final DefaultGatewayFeatureType MULTI_USE_PAYMENT_METHODS

Whether payment methods (a.k.a tokens in some systems) can be reused to initiate a future line of transaction. For example, can the system create multiple authorization transactions using the same payment method or does each authorization require the user to re-enter their payment info? Another way to phrase this, does the gateway allow reauthorizing with the same payment method?

Payment gateways that don't support multi-use methods/tokens, usually have some other means for allowing storing and reusing payment information such as Customer or Wallet features.

RECURRING_PAYMENTS

public static final DefaultGatewayFeatureType RECURRING_PAYMENTS

Whether the gateway supports recurring or subscription payments.

SAVED_PAYMENTS

public static final DefaultGatewayFeatureType SAVED_PAYMENTS

Whether the gateway supports saving customer payments for future use.

Method Details

values

public static DefaultGatewayFeatureType[] 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 DefaultGatewayFeatureType 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