Package com.broadleafcommerce.payment.service.gateway.autoconfigure

Class CheckoutConfigurationProperties.FlowSessionConfiguration

java.lang.Object

com.broadleafcommerce.payment.service.gateway.autoconfigure.CheckoutConfigurationProperties.FlowSessionConfiguration

Enclosing class:

CheckoutConfigurationProperties

public static class CheckoutConfigurationProperties.FlowSessionConfiguration
extends Object

Properties used to configure Flow Sessions for Checkout.com.

Constructor Summary

Constructors

Constructor	Description
FlowSessionConfiguration()

Method Summary

Modifier and Type	Method	Description
int	getCustomerRetryMaxAttempts()	The maximum number of authorization retry attempts for a Flow Payment Session, excluding the initial authorization.
List<String>	getDisabledPaymentMethods()	The list of payment method options to hide on the payment form in Flow.
List<String>	getEnabledPaymentMethods()	The list of payment method options to show on the payment form in Flow.
Duration	getExpirationDuration()	What the duration of the Flow payment session should be before it expires.
boolean	isEnableStoredCards()	Whether or not to enable the stored cards consent collection in Flow.
void	setCustomerRetryMaxAttempts(int customerRetryMaxAttempts)	The maximum number of authorization retry attempts for a Flow Payment Session, excluding the initial authorization.
void	setDisabledPaymentMethods(List<String> disabledPaymentMethods)	The list of payment method options to hide on the payment form in Flow.
void	setEnabledPaymentMethods(List<String> enabledPaymentMethods)	The list of payment method options to show on the payment form in Flow.
void	setEnableStoredCards(boolean enableStoredCards)	Whether or not to enable the stored cards consent collection in Flow.
void	setExpirationDuration(Duration expirationDuration)	What the duration of the Flow payment session should be before it expires.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlowSessionConfiguration

public FlowSessionConfiguration()

Method Details

setExpirationDuration

public void setExpirationDuration(Duration expirationDuration)

What the duration of the Flow payment session should be before it expires.

setCustomerRetryMaxAttempts

public void setCustomerRetryMaxAttempts(int customerRetryMaxAttempts)

The maximum number of authorization retry attempts for a Flow Payment Session, excluding the initial authorization. If on submission, the authorization of the payment method fails, the customer will be given additional attempts to add a payment via Flow. The Flow payment form will display error messages to the customer, with suggested next actions to improve retry success.

The valid range for this property is [0-5].

See Also:

• CreatPaymentSession customerRetry maxAttempts property

setEnableStoredCards

public void setEnableStoredCards(boolean enableStoredCards)

Whether or not to enable the stored cards consent collection in Flow.

If true, sets the `payment_method_configuration.card.store_payment_details` property to `collect_consent`. This is set to false by default and the "Remember Me" functionality is used by default. If enabled and consent was collected, the payment source will be included in the payment response and can be stored for future use.

setEnabledPaymentMethods

public void setEnabledPaymentMethods(List<String> enabledPaymentMethods)

The list of payment method options to show on the payment form in Flow.

If the same payment method is listed both here and in disabledPaymentMethods, this enabled list takes precedence and will override to display the payment.

See Also:

• CreatPaymentSession enabledPaymentMethods property

setDisabledPaymentMethods

public void setDisabledPaymentMethods(List<String> disabledPaymentMethods)

The list of payment method options to hide on the payment form in Flow.

If the same payment method is listed both here and in enabledPaymentMethods, the enabled list takes precedence and will override to display the payment.

See Also:

• CreatPaymentSession enabledPaymentMethods property

getExpirationDuration

public Duration getExpirationDuration()

What the duration of the Flow payment session should be before it expires.

getCustomerRetryMaxAttempts

public int getCustomerRetryMaxAttempts()

The maximum number of authorization retry attempts for a Flow Payment Session, excluding the initial authorization. If on submission, the authorization of the payment method fails, the customer will be given additional attempts to add a payment via Flow. The Flow payment form will display error messages to the customer, with suggested next actions to improve retry success.

The valid range for this property is [0-5].

See Also:

• CreatPaymentSession customerRetry maxAttempts property

isEnableStoredCards

public boolean isEnableStoredCards()

Whether or not to enable the stored cards consent collection in Flow.

If true, sets the `payment_method_configuration.card.store_payment_details` property to `collect_consent`. This is set to false by default and the "Remember Me" functionality is used by default. If enabled and consent was collected, the payment source will be included in the payment response and can be stored for future use.

getEnabledPaymentMethods

public List<String> getEnabledPaymentMethods()

The list of payment method options to show on the payment form in Flow.

If the same payment method is listed both here and in disabledPaymentMethods, this enabled list takes precedence and will override to display the payment.

See Also:

• CreatPaymentSession enabledPaymentMethods property

getDisabledPaymentMethods

public List<String> getDisabledPaymentMethods()

The list of payment method options to hide on the payment form in Flow.

If the same payment method is listed both here and in enabledPaymentMethods, the enabled list takes precedence and will override to display the payment.

See Also:

• CreatPaymentSession enabledPaymentMethods property