Package com.broadleafcommerce.cartoperation.service.payment

Interface PaymentTransactionExecutionService

All Known Implementing Classes:

DefaultPaymentTransactionExecutionService

public interface PaymentTransactionExecutionService

This service is meant to coordinate the execution of payment transactions against the cart's PaymentSummaries in the context of a checkout submission.

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method	Description
CheckoutProcessDto	executeCartPaymentTransactions(CheckoutProcessDto processDto, List<SensitivePaymentMethodData> sensitivePaymentMethodData, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes set of payment transactions against the cart's PaymentSummaries.
CheckoutProcessDto	executeCartPaymentTransactions(CheckoutProcessDto processDto, Map<String,String> securityCodes, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of executeCartPaymentTransactions(CheckoutProcessDto, List, ContextInfo)

Method Details

executeCartPaymentTransactions

@Deprecated(since="2.1.3",
            forRemoval=true)
CheckoutProcessDto executeCartPaymentTransactions(CheckoutProcessDto processDto,
 Map<String,String> securityCodes,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of executeCartPaymentTransactions(CheckoutProcessDto, List, ContextInfo)

Executes set of payment transactions against the cart's PaymentSummaries.

Parameters:

processDto - The CheckoutProcessDto that we're attempting to checkout with and contains the related PaymentSummaries

securityCodes - The map of card security codes keyed by payment id for processing saved payments

contextInfo - The context of the user's request.

Returns:

The most up-to-date CheckoutProcessDto following the execution of the transaction

Throws:

PaymentTransactionFailureException - if the transaction was not successfully executed, either due to a transaction failure or an unexpected exception.

executeCartPaymentTransactions

CheckoutProcessDto executeCartPaymentTransactions(CheckoutProcessDto processDto,
 List<SensitivePaymentMethodData> sensitivePaymentMethodData,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Executes set of payment transactions against the cart's PaymentSummaries.

Parameters:

processDto - The CheckoutProcessDto that we're attempting to checkout with and contains the related PaymentSummaries

sensitivePaymentMethodData - Collection of SensitivePaymentMethodData used to communicate payment method properties that should not be persisted in Payment#paymentMethodProperties in PaymentTransactionServices.

contextInfo - The context of the user's request.

Returns:

The most up-to-date CheckoutProcessDto following the execution of the transaction

Throws:

PaymentTransactionFailureException - if the transaction was not successfully executed, either due to a transaction failure or an unexpected exception.