com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayConfiguration

All Superinterfaces:

PaymentGatewayTypeAware

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
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.
default boolean	handlesAuthorize()
default boolean	handlesAuthorizeAndCapture()
default boolean	handlesCapture()
default boolean	handlesMultiplePayments() Denotes whether or not this payment provider supports multiple payments on an order.
default boolean	handlesMultipleShipment()
default boolean	handlesPartialCapture()
default boolean	handlesRecurringPayment()
default boolean	handlesRefund()
default boolean	handlesReverseAuthorize()
default boolean	handlesSavedCustomerPayment()
default boolean	handlesVoid()
default boolean	isPerformAuthorizeAndCapture() Whether the 'AUTHORIZE AND CAPTURE' or 'AUTHORIZE' transaction type should be used for this gateway.
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.
void	setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture) Whether the 'AUTHORIZE AND CAPTURE' or 'AUTHORIZE' transaction type should be used for this gateway.

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

getGatewayType

Method Detail

isPerformAuthorizeAndCapture

default boolean isPerformAuthorizeAndCapture()

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

See Also:

TransactionType

setPerformAuthorizeAndCapture

void setPerformAuthorizeAndCapture(boolean performAuthorizeAndCapture)

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

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()

handlesMultipleShipment

default boolean handlesMultipleShipment()

handlesRecurringPayment

default boolean handlesRecurringPayment()

handlesSavedCustomerPayment

default boolean handlesSavedCustomerPayment()

handlesMultiplePayments

default boolean handlesMultiplePayments()

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.

See Also:

PaymentGatewayCheckoutService