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
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description 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 ofTransactionTypes
that the gateway supports.default boolean
handlesAuthorize()
default boolean
handlesAuthorizeAndCapture()
default boolean
handlesCapture()
default boolean
handlesMultiplePayments()
Deprecated.This is not relevant for the gatewaysdefault boolean
handlesMultipleShipment()
Deprecated.This is not relevant for gatewaysdefault boolean
handlesPartialCapture()
default boolean
handlesRecurringPayment()
default boolean
handlesRefund()
default boolean
handlesReverseAuthorize()
default boolean
handlesSavedCustomerPayment()
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.-
Methods inherited from interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware
getGatewayType
-
-
-
-
Method Detail
-
getSupportedTransactionTypes
Set<String> getSupportedTransactionTypes()
Returns the set ofTransactionTypes
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
-
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()
-
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 gatewaysDenotes 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.
-
-