com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayConfiguration

All Superinterfaces:

PaymentGatewayTypeAware

All Known Subinterfaces:

PassthroughConfiguration

All Known Implementing Classes:

DefaultPassthroughConfiguration

public interface PaymentGatewayConfiguration
extends PaymentGatewayTypeAware

This API is intended to define the specific configuration parameters that this gateway implementation currently supports.

Author:

Elbert Bautista (elbertbautista)

Method Summary

Modifier and Type	Method and Description
String	getCheckoutTransactionType() Returns the TransactionType that should be performed during checkout.
default int	getFailureReportingThreshold() All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.
Set<String>	getSupportedFeatures() The set of features this gateway supports such as 3D Secure, multi-use payment methods, and pay later.
Set<String>	getSupportedTransactionTypes() Returns the set of TransactionTypes that the gateway supports.
default boolean	handlesAuthorize()
default boolean	handlesAuthorizeAndCapture()
default boolean	handlesCapture()
default boolean	handlesMultiplePayments() Deprecated. This is not relevant for the gateways
default boolean	handlesMultipleShipment() Deprecated. This is not relevant for gateways
default boolean	handlesPartialCapture()
default boolean	handlesRecurringPayment()
default boolean	handlesRefund()
default boolean	handlesReverseAuthorize()
default boolean	handlesSavedCustomerPayment()
default boolean	handlesVoid()
boolean	isCheckoutTransactionExternal() Whether the checkout transaction occurs externally such as for transparent redirect or MyFatoorah.
default boolean	isPerformAuthorizeAndCapture() Deprecated. Check getCheckoutTransactionType(). The value is not necessarily restricted to only DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE.
void	setCheckoutTransactionType(String checkoutTransactionType) Set the TransactionType that should be performed during checkout.
default void	setFailureReportingThreshold(int failureReportingThreshold) All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.
default void	setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture) Deprecated. Use setCheckoutTransactionType(String)

Methods inherited from interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware

getGatewayType

Method Detail

getSupportedTransactionTypes

Set<String> getSupportedTransactionTypes()

Returns the set of TransactionTypes that the gateway supports.

Returns:

The set of TransactionTypes that the gateway supports.

getSupportedFeatures

Set<String> getSupportedFeatures()

The set of features this gateway supports such as 3D Secure, multi-use payment methods, and pay later.

Returns:

The set of features this gateway supports.

See Also:

DefaultGatewayFeatureType

getCheckoutTransactionType

String getCheckoutTransactionType()

Returns the TransactionType that should be performed during checkout. Typically this will be DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE.

Returns:

The TransactionType that should be performed during checkout.

setCheckoutTransactionType

void setCheckoutTransactionType(String checkoutTransactionType)

Set the TransactionType that should be performed during checkout. Typically this will be DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE.

Parameters:

checkoutTransactionType - The TransactionType that should be performed during checkout.

isCheckoutTransactionExternal

boolean isCheckoutTransactionExternal()

Whether the checkout transaction occurs externally such as for transparent redirect or MyFatoorah. Otherwise, the transaction is created in Broadleaf during the checkout workflow. The system can use this when validating payments to make sure that they have been executed in the external service.

Returns:

Whether the checkout transaction occurs externally

isPerformAuthorizeAndCapture

@Deprecated
default boolean isPerformAuthorizeAndCapture()

Deprecated. Check getCheckoutTransactionType(). The value is not necessarily restricted to only DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE.

Whether the 'AUTHORIZE AND CAPTURE' or 'AUTHORIZE' transaction type should be used for this gateway.

See Also:

TransactionType

setPerformAuthorizeAndCapture

@Deprecated
default void setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture)

Deprecated. Use setCheckoutTransactionType(String)

Whether the 'AUTHORIZE AND CAPTURE' or 'AUTHORIZE' transaction type should be used for this gateway. If this is set to 'FALSE', then the gateway will only issue an authorization request.

See Also:

TransactionType

getFailureReportingThreshold

default int getFailureReportingThreshold()

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class. One of the configuration parameters is the failure reporting threshold.

See Also:

AbstractExternalPaymentGatewayCall

setFailureReportingThreshold

default void setFailureReportingThreshold(int failureReportingThreshold)

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class. One of the configuration parameters is the failure reporting threshold.

See Also:

AbstractExternalPaymentGatewayCall

handlesAuthorize

default boolean handlesAuthorize()

handlesCapture

default boolean handlesCapture()

handlesAuthorizeAndCapture

default boolean handlesAuthorizeAndCapture()

handlesReverseAuthorize

default boolean handlesReverseAuthorize()

handlesVoid

default boolean handlesVoid()

handlesRefund

default boolean handlesRefund()

handlesPartialCapture

default boolean handlesPartialCapture()

handlesRecurringPayment

default boolean handlesRecurringPayment()

handlesSavedCustomerPayment

default boolean handlesSavedCustomerPayment()

handlesMultipleShipment

@Deprecated
default boolean handlesMultipleShipment()

Deprecated. This is not relevant for gateways

handlesMultiplePayments

@Deprecated
default boolean handlesMultiplePayments()

Deprecated. This is not relevant for the gateways

Denotes whether or not this payment provider supports multiple payments on an order. For instance, a gift card provider might want to support multiple gift cards on a single order but a credit card provider may not support payment with multiple credit cards.

If a provider does not support multiple payments in an order then that means that all payments are deleted (archived) on an order whenever a new payment of that type is attempted to be added to the order.