Uses of Class
com.broadleafcommerce.cartoperation.domain.payment.PaymentSummary

Packages that use PaymentSummary

Package	Description
com.broadleafcommerce.cartoperation.service
com.broadleafcommerce.cartoperation.service.autoconfigure
com.broadleafcommerce.cartoperation.service.checkout
com.broadleafcommerce.cartoperation.service.checkout.workflow
com.broadleafcommerce.cartoperation.service.checkout.workflow.activity
com.broadleafcommerce.cartoperation.service.csr
com.broadleafcommerce.cartoperation.service.fulfillment.address
com.broadleafcommerce.cartoperation.service.messaging.completion
com.broadleafcommerce.cartoperation.service.payment
com.broadleafcommerce.cartoperation.service.provider
com.broadleafcommerce.cartoperation.service.provider.external.domain.payment
com.broadleafcommerce.cartoperation.service.provider.external.payments
com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service

Methods in com.broadleafcommerce.cartoperation.service that return PaymentSummary

Modifier and Type	Method	Description
protected PaymentSummary	DefaultCartOperationService.allocateCartTotalToPayment(@NonNull PaymentSummary paymentSummary, @NonNull javax.money.MonetaryAmount cartTotal, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total to the cart's single payment.
protected PaymentSummary	DefaultCartOperationService.allocateCartTotalToPayment(@NonNull PaymentSummary paymentSummary, @NonNull javax.money.MonetaryAmount cartTotal, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total to the cart's single payment.

Methods in com.broadleafcommerce.cartoperation.service that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	DefaultCartOperationService.getPaymentProvider()
protected PaymentProvider<PaymentSummary>	DefaultGuestCartProtectionService.getPaymentProvider()

Methods in com.broadleafcommerce.cartoperation.service with parameters of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentSummary	DefaultCartOperationService.allocateCartTotalToPayment(@NonNull PaymentSummary paymentSummary, @NonNull javax.money.MonetaryAmount cartTotal, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total to the cart's single payment.
protected PaymentSummary	DefaultCartOperationService.allocateCartTotalToPayment(@NonNull PaymentSummary paymentSummary, @NonNull javax.money.MonetaryAmount cartTotal, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total to the cart's single payment.

Method parameters in com.broadleafcommerce.cartoperation.service with type arguments of type PaymentSummary

Modifier and Type	Method	Description
protected void	DefaultCartOperationService.reallocateCartTotalAmongstPayments(@NonNull List<PaymentSummary> paymentSummaries, @NonNull javax.money.MonetaryAmount cartTotal, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total amongst the cart's payments.
protected void	DefaultCartOperationService.reallocateCartTotalAmongstPayments(@NonNull List<PaymentSummary> paymentSummaries, @NonNull javax.money.MonetaryAmount cartTotal, Map<String,String> paymentLockTokens, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to automatically reallocate the cart total amongst the cart's payments.
void	DefaultCartOperationService.setPaymentProvider(PaymentProvider<PaymentSummary> paymentProvider)

Constructor parameters in com.broadleafcommerce.cartoperation.service with type arguments of type PaymentSummary

Constructor	Description
DefaultGuestCartProtectionService(GuestTokenProvider tokenProvider, GuestTokenGenerator tokenGenerator, PaymentProvider<PaymentSummary> paymentProvider)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.autoconfigure

Methods in com.broadleafcommerce.cartoperation.service.autoconfigure with type parameters of type PaymentSummary

Modifier and Type	Method	Description
<T extends PaymentSummary> PaymentProvider<T>	CartOperationServiceAutoConfiguration.paymentProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalPaymentProperties externalPaymentsProperties)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.checkout

Methods in com.broadleafcommerce.cartoperation.service.checkout that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	DefaultCheckoutService.getPaymentProvider()

Constructor parameters in com.broadleafcommerce.cartoperation.service.checkout with type arguments of type PaymentSummary

Constructor

Description

DefaultCheckoutService(CartStatusValidationHelper cartStatusValidationHelper, CheckoutWorkflow checkoutWorkflow, CartProvider cartProvider, com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer checkoutCompletionProducer, ExternalCartProperties externalCartProperties, PaymentProvider<PaymentSummary> paymentProvider, org.springframework.context.MessageSource messageSource, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.checkout.workflow

Methods in com.broadleafcommerce.cartoperation.service.checkout.workflow that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	DefaultCheckoutWorkflow.getPaymentProvider()

Method parameters in com.broadleafcommerce.cartoperation.service.checkout.workflow with type arguments of type PaymentSummary

Modifier and Type	Method	Description
void	DefaultCheckoutWorkflow.setPaymentProvider(PaymentProvider<PaymentSummary> paymentProvider)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity

Methods in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	CartPaymentMethodValidationActivity.getPaymentProvider()

Methods in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity with parameters of type PaymentSummary

Modifier and Type	Method	Description
protected boolean	CartPaymentMethodValidationActivity.hasValidAmountAuthorizedOrCaptured(@NonNull javax.money.MonetaryAmount amountAuthorizedOrCapturedOrPending, @NonNull PaymentSummary paymentSummary, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates that the amount authorized or captured fully covers the payment total amount.
protected boolean	CartPaymentMethodValidationActivity.isExternalTransactionExpected(@NonNull PaymentSummary paymentSummary, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Based on the provided PaymentGatewayType, determine if the expected transaction is external.

Method parameters in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity with type arguments of type PaymentSummary

Modifier and Type	Method	Description
protected void	CartPaymentMethodValidationActivity.validateCartHasActivePayment(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> paymentSummaries)	Validate that the cart has at least one active payment.
protected void	CartPaymentMethodValidationActivity.validatePaymentAmount(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> paymentSummaries)	Validate that each of the PaymentSummaries are responsible for a zero or greater amount.
protected void	CartPaymentMethodValidationActivity.validatePaymentAmountSum(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> paymentSummaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validate that the sum of the PaymentSummary amounts is equal to the cart total (CartPricing.getTotal()).
protected void	CartPaymentMethodValidationActivity.validatePaymentMethodAvailability(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> paymentSummaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validate that the payments on the cart are available in the current context.
protected void	CartPaymentMethodValidationActivity.validatePaymentTransactionAmountSums(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> paymentSummaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates that the sum of authorized/captured amount of the successful transactions equal to the payment amount.

Constructor parameters in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity with type arguments of type PaymentSummary

Constructor	Description
CartPaymentMethodValidationActivity(PaymentProvider<PaymentSummary> paymentProvider, CartOperationCheckoutProperties properties, org.springframework.context.MessageSource messageSource)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.csr

Methods in com.broadleafcommerce.cartoperation.service.csr that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	DefaultCartTransferService.getPaymentProvider()
protected PaymentProvider<PaymentSummary>	DefaultCsrCartOperationService.getPaymentProvider()

Constructor parameters in com.broadleafcommerce.cartoperation.service.csr with type arguments of type PaymentSummary

Constructor	Description
DefaultCartTransferService(CartOperationService cartOperationService, CartProvider cartProvider, com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils, com.broadleafcommerce.common.extension.TypeFactory typeFactory, TransferCartTokenEncoder transferCartTokenEncoder, TransferCartTokenDecoder transferCartTokenDecoder, PaymentProvider<PaymentSummary> paymentProvider)
DefaultCsrCartOperationService(CartOperationService cartOperationService, CartProvider cartProvider, com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils, PaymentProvider<PaymentSummary> paymentProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.fulfillment.address

Methods in com.broadleafcommerce.cartoperation.service.fulfillment.address that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	PaymentTaxAddressSourceHandler.getPaymentProvider()

Constructor parameters in com.broadleafcommerce.cartoperation.service.fulfillment.address with type arguments of type PaymentSummary

Constructor	Description
PaymentTaxAddressSourceHandler(PaymentProvider<PaymentSummary> paymentProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.messaging.completion

Methods in com.broadleafcommerce.cartoperation.service.messaging.completion that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
List<PaymentSummary>	CheckoutCompletionEvent.getPaymentSummaries()	The payments for the cart that completed the checkout workflow

Method parameters in com.broadleafcommerce.cartoperation.service.messaging.completion with type arguments of type PaymentSummary

Modifier and Type	Method	Description
void	CheckoutCompletionEvent.setPaymentSummaries(List<PaymentSummary> paymentSummaries)	The payments for the cart that completed the checkout workflow

Constructor parameters in com.broadleafcommerce.cartoperation.service.messaging.completion with type arguments of type PaymentSummary

Constructor	Description
CheckoutCompletionEvent(com.broadleafcommerce.cart.client.domain.CheckoutCart cart, List<PaymentSummary> paymentSummaries, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo info)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.payment

Methods in com.broadleafcommerce.cartoperation.service.payment that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
protected PaymentProvider<PaymentSummary>	DefaultPaymentTransactionExecutionService.getPaymentProvider()
List<PaymentSummary>	DefaultPaymentPriorityStrategy.sortByPaymentGatewayPriority(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<PaymentSummary>	PaymentPriorityStrategy.sortByPaymentGatewayPriority(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentSummaries, sorts them in order of which should be executed first based on getGatewayType().
protected List<PaymentSummary>	DefaultPaymentTransactionExecutionService.sortPayments(List<PaymentSummary> payments)	Deprecated. since 1.7.2, in favor of DefaultPaymentTransactionExecutionService.sortPayments(List, ContextInfo)
protected List<PaymentSummary>	DefaultPaymentTransactionExecutionService.sortPayments(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentSummaries, sorts them in order of which should be executed first based on the getGatewayType().

Methods in com.broadleafcommerce.cartoperation.service.payment with parameters of type PaymentSummary

Modifier and Type	Method	Description
protected TransactionExecutionRequest	DefaultPaymentTransactionExecutionService.buildTransactionExecutionRequest(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull PaymentSummary paymentSummary, @NonNull String requestId, String securityCode)	Builds a TransactionExecutionRequest to execute a transaction against the provided PaymentSummary.
protected com.broadleafcommerce.cart.client.domain.Cart	DefaultPaymentTransactionExecutionService.claimTransactionsForRequest(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull PaymentSummary paymentSummary, @NonNull String requestId, @NonNull String checkoutTransactionType, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.cart.client.domain.Cart	DefaultPaymentTransactionExecutionService.executePaymentTransaction(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, @NonNull PaymentSummary paymentSummary, @NonNull String checkoutTransactionType, String lockToken, String securityCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes a payment transaction against the provided PaymentSummary.
protected int	DefaultPaymentPriorityStrategy.getGatewayPriority(List<String> prioritizedPaymentGatewayTypes, PaymentSummary payment)	Gets the priority of the given PaymentSummary, which is represented by the index of the getGatewayType() in the given prioritizedPaymentGatewayTypes.
protected com.broadleafcommerce.cart.client.domain.Cart	DefaultPaymentTransactionExecutionService.lookup3DSTransactionResults(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull PaymentSummary paymentSummary, @NonNull String requestId, @NonNull String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected boolean	DefaultPaymentTransactionExecutionService.shouldClaimTransactionsForRequest(@NonNull PaymentSummary paymentSummary, @NonNull String checkoutTransactionType)
protected boolean	DefaultPaymentTransactionExecutionService.shouldExecutePaymentTransaction(PaymentSummary paymentSummary, String checkoutTransactionType)	Determine whether to execute a transaction for this payment.
protected boolean	DefaultPaymentTransactionExecutionService.shouldLookup3DSTransactionResults(@NonNull PaymentSummary paymentSummary, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Method parameters in com.broadleafcommerce.cartoperation.service.payment with type arguments of type PaymentSummary

Modifier and Type	Method	Description
List<PaymentSummary>	DefaultPaymentPriorityStrategy.sortByPaymentGatewayPriority(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<PaymentSummary>	PaymentPriorityStrategy.sortByPaymentGatewayPriority(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentSummaries, sorts them in order of which should be executed first based on getGatewayType().
protected List<PaymentSummary>	DefaultPaymentTransactionExecutionService.sortPayments(List<PaymentSummary> payments)	Deprecated. since 1.7.2, in favor of DefaultPaymentTransactionExecutionService.sortPayments(List, ContextInfo)
protected List<PaymentSummary>	DefaultPaymentTransactionExecutionService.sortPayments(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentSummaries, sorts them in order of which should be executed first based on the getGatewayType().

Constructor parameters in com.broadleafcommerce.cartoperation.service.payment with type arguments of type PaymentSummary

Constructor	Description
DefaultPaymentTransactionExecutionService(PaymentTransactionExecutionProvider transactionExecutionProvider, PaymentProvider<PaymentSummary> paymentProvider, CartOperationCheckoutProperties properties, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider

Classes in com.broadleafcommerce.cartoperation.service.provider with type parameters of type PaymentSummary

Modifier and Type	Interface	Description
interface	PaymentProvider<P extends PaymentSummary>	Provider for interfacing with a Payment Management system for operations around payment related entities.

Methods in com.broadleafcommerce.cartoperation.service.provider that return PaymentSummary

Modifier and Type	Method	Description
default PaymentSummary	PaymentProvider.patchPayment(@NonNull UpdatePaymentRequest updatePaymentRequest, @NonNull Integer version, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Updates the payment based on the provided UpdatePaymentRequest.
PaymentSummary	PaymentProvider.patchPayment(UpdatePaymentRequest updatePaymentRequest, Integer version, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Updates the payment based on the provided UpdatePaymentRequest.

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment

Methods in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment that return PaymentSummary

Modifier and Type	Method	Description
PaymentSummary	TransactionExecutionResponse.getPaymentSummary()	The updated PaymentSummary representation.

Methods in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
List<PaymentSummary>	UpdatePaymentsResponse.getFailedPayments()	List of payments that failed during processing.
List<PaymentSummary>	UpdatePaymentsResponse.getSuccessfulPayments()	List of payments that were successfully processed.

Methods in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment with parameters of type PaymentSummary

Modifier and Type	Method	Description
void	TransactionExecutionResponse.setPaymentSummary(PaymentSummary paymentSummary)	The updated PaymentSummary representation.

Method parameters in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment with type arguments of type PaymentSummary

Modifier and Type	Method	Description
void	UpdatePaymentsResponse.setFailedPayments(List<PaymentSummary> failedPayments)	List of payments that failed during processing.
void	UpdatePaymentsResponse.setSuccessfulPayments(List<PaymentSummary> successfulPayments)	List of payments that were successfully processed.

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider.external.payments

Classes in com.broadleafcommerce.cartoperation.service.provider.external.payments with type parameters of type PaymentSummary

Modifier and Type	Class	Description
class	ExternalPaymentProvider<P extends PaymentSummary>	This particular implementation of PaymentProvider is designed to interact with the payment transaction service.

Methods in com.broadleafcommerce.cartoperation.service.provider.external.payments that return PaymentSummary

Modifier and Type	Method	Description
PaymentSummary	ExternalPaymentProvider.patchPayment(UpdatePaymentRequest updatePaymentRequest, Integer version, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Uses of PaymentSummary in com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout

Methods in com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout that return types with arguments of type PaymentSummary

Modifier and Type	Method	Description
List<PaymentSummary>	CheckoutResponse.getPaymentSummaries()	A collection of PaymentSummaries related to the Cart.

Method parameters in com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout with type arguments of type PaymentSummary

Modifier and Type	Method	Description
void	CheckoutResponse.setPaymentSummaries(List<PaymentSummary> paymentSummaries)	A collection of PaymentSummaries related to the Cart.