Uses of Class
com.broadleafcommerce.cartoperation.domain.payment.PaymentSummary
Package
Description
-
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.domain.checkout
Modifier and TypeMethodDescriptionCheckoutProcessDto.getPaymentById()
ResolvedPaymentSummaries
for this checkout process request.CheckoutProcessDto.getPaymentSummaries()
Convenient method to get a list ofPaymentSummaries
fromCheckoutProcessDto.getPaymentById()
.Modifier and TypeMethodDescriptionvoid
CheckoutProcessDto.setPaymentById
(Map<String, PaymentSummary> paymentById) ResolvedPaymentSummaries
for this checkout process request.void
CheckoutProcessDto.setPaymentSummaries
(List<PaymentSummary> paymentSummaries) Convenient method to setCheckoutProcessDto.getPaymentById()
from a list ofPaymentSummaries
-
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service
Modifier and TypeMethodDescriptionprotected 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.Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
DefaultCartOperationService.getPaymentProvider()
protected PaymentProvider<PaymentSummary>
DefaultGuestCartProtectionService.getPaymentProvider()
CartOperationService.reallocateCartTotalAmongstPayments
(javax.money.MonetaryAmount newCartTotal, List<PaymentSummary> paymentSummaries, Map<String, String> paymentLockTokens, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Reallocate the cart total among the cart's paymentsDefaultCartOperationService.reallocateCartTotalAmongstPayments
(@NonNull javax.money.MonetaryAmount newCartTotal, @NonNull List<PaymentSummary> paymentSummaries, @NonNull Map<String, String> paymentLockTokens, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) protected List<PaymentSummary>
DefaultCartOperationService.reallocateCartTotalMultiplePayments
(@NonNull javax.money.MonetaryAmount cartTotal, @NonNull List<PaymentSummary> paymentSummaries, 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.Modifier and TypeMethodDescriptionprotected 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.Modifier and TypeMethodDescriptionCartOperationService.reallocateCartTotalAmongstPayments
(javax.money.MonetaryAmount newCartTotal, List<PaymentSummary> paymentSummaries, Map<String, String> paymentLockTokens, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Reallocate the cart total among the cart's paymentsDefaultCartOperationService.reallocateCartTotalAmongstPayments
(@NonNull javax.money.MonetaryAmount newCartTotal, @NonNull List<PaymentSummary> paymentSummaries, @NonNull Map<String, String> paymentLockTokens, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) protected List<PaymentSummary>
DefaultCartOperationService.reallocateCartTotalMultiplePayments
(@NonNull javax.money.MonetaryAmount cartTotal, @NonNull List<PaymentSummary> paymentSummaries, 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) ModifierConstructorDescriptionDefaultGuestCartProtectionService
(GuestTokenProvider tokenProvider, GuestTokenGenerator tokenGenerator, PaymentProvider<PaymentSummary> paymentProvider) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.autoconfigure
Modifier and TypeMethodDescription<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) Modifier and TypeMethodDescriptionCartOperationServiceAutoConfiguration.CartCheckoutMessagingAutoConfiguration.finalizeCartAwaitingPaymentResultJobListener
(com.broadleafcommerce.common.extension.TypeFactory typeFactory, ResourceLockProvider resourceLockProvider, CartProvider cartProvider, PaymentProvider<PaymentSummary> paymentProvider, CheckoutWorkflow checkoutWorkflow, CheckoutService checkoutService, CartOperationCheckoutProperties checkoutProperties) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.checkout
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
DefaultCheckoutService.getPaymentProvider()
ModifierConstructorDescriptionDefaultCheckoutService
(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
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
DefaultCheckoutWorkflow.getPaymentProvider()
Modifier and TypeMethodDescriptionvoid
DefaultCheckoutWorkflow.setPaymentProvider
(PaymentProvider<PaymentSummary> paymentProvider) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.checkout.workflow.activity
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
CartPaymentMethodValidationActivity.getPaymentProvider()
Modifier and TypeMethodDescriptionprotected 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 providedPaymentGatewayType
, determine if the expected transaction is external.Modifier and TypeMethodDescriptionprotected boolean
CartPaymentMethodValidationActivity.hasCollectOnDeliveryPayments
(@NonNull List<PaymentSummary> paymentSummaries) ModifierConstructorDescriptionCartPaymentMethodValidationActivity
(PaymentProvider<PaymentSummary> paymentProvider, CartOperationCheckoutProperties properties, org.springframework.context.MessageSource messageSource) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.csr
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
DefaultCartTransferService.getPaymentProvider()
protected PaymentProvider<PaymentSummary>
DefaultCsrCartOperationService.getPaymentProvider()
ModifierConstructorDescriptionDefaultCartTransferService
(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
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
PaymentTaxAddressSourceHandler.getPaymentProvider()
ModifierConstructorDescriptionPaymentTaxAddressSourceHandler
(PaymentProvider<PaymentSummary> paymentProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.messaging.completion
Modifier and TypeMethodDescriptionCheckoutCompletionEvent.getPaymentSummaries()
The payments for the cart that completed the checkout workflowModifier and TypeMethodDescriptionvoid
CheckoutCompletionEvent.setPaymentSummaries
(List<PaymentSummary> paymentSummaries) The payments for the cart that completed the checkout workflowModifierConstructorDescriptionCheckoutCompletionEvent
(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.messaging.finalizecart
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
FinalizeCartAwaitingPaymentResultJobListener.getPaymentProvider()
Modifier and TypeMethodDescriptionprotected boolean
FinalizeCartAwaitingPaymentResultJobListener.allPaymentsHaveResult
(@NonNull List<PaymentSummary> payments) Determines if all the payments have a result from the payment gateway rather than pending.protected boolean
FinalizeCartAwaitingPaymentResultJobListener.paymentsMatchCartTotal
(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull List<PaymentSummary> cartPayments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Determines if all the payments for the givenCart
add up to cart's total.ModifierConstructorDescriptionFinalizeCartAwaitingPaymentResultJobListener
(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentMessageService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ResourceLockProvider resourceLockProvider, CartProvider cartProvider, PaymentProvider<PaymentSummary> paymentProvider, CheckoutWorkflow checkoutWorkflow, CheckoutService checkoutService, CartOperationCheckoutProperties checkoutProperties) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.payment
Modifier and TypeMethodDescriptionprotected PaymentProvider<PaymentSummary>
DefaultPaymentTransactionExecutionService.getPaymentProvider()
DefaultPaymentPriorityStrategy.sortByPaymentGatewayPriority
(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) PaymentPriorityStrategy.sortByPaymentGatewayPriority
(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Given a list ofPaymentSummaries
, sorts them in order of which should be executed first based ongetGatewayType()
.protected List<PaymentSummary>
DefaultPaymentTransactionExecutionService.sortPayments
(@NonNull List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Given a list ofPaymentSummaries
, sorts them in order of which should be executed first based on thegetGatewayType()
.protected List<PaymentSummary>
DefaultPaymentTransactionExecutionService.sortPayments
(List<PaymentSummary> payments) Deprecated.Modifier and TypeMethodDescriptionprotected TransactionExecutionRequest
DefaultPaymentTransactionExecutionService.buildTransactionExecutionRequest
(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull PaymentSummary paymentSummary, @NonNull String requestId, String securityCode) Builds aTransactionExecutionRequest
to execute a transaction against the providedPaymentSummary
.protected CheckoutProcessDto
DefaultPaymentTransactionExecutionService.claimTransactionsForRequest
(@NonNull CheckoutProcessDto processDto, @NonNull PaymentSummary paymentSummary, @NonNull String checkoutTransactionType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) protected CheckoutProcessDto
DefaultPaymentTransactionExecutionService.executePaymentTransaction
(@NonNull CheckoutProcessDto processDto, @NonNull PaymentSummary paymentSummary, String securityCode, @NonNull String checkoutTransactionType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Executes a payment transaction against the providedPaymentSummary
.protected TransactionExecutionResponse
DefaultPaymentTransactionExecutionService.executePaymentTransaction
(@NonNull String checkoutTransactionType, @NonNull PaymentSummary paymentSummary, @NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Executes a payment transaction based on the given checkout transaction type against the givenPaymentSummary
.protected int
DefaultPaymentPriorityStrategy.getGatewayPriority
(List<String> prioritizedPaymentGatewayTypes, PaymentSummary payment) Gets the priority of the givenPaymentSummary
, which is represented by the index of thegetGatewayType()
in the givenprioritizedPaymentGatewayTypes
.protected CheckoutProcessDto
DefaultPaymentTransactionExecutionService.lookup3DSTransactionResults
(@NonNull CheckoutProcessDto processDto, @NonNull PaymentSummary paymentSummary, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) protected boolean
DefaultPaymentTransactionExecutionService.paymentHasCheckoutAmountAwaitingResult
(@NonNull PaymentSummary paymentSummary, @NonNull String checkoutTransactionType) Determines if the givenPaymentSummary
has any amount awaiting result based on the given checkout transaction type.protected boolean
DefaultPaymentTransactionExecutionService.shouldClaimTransactionsForRequest
(@NonNull PaymentSummary paymentSummary, @NonNull String checkoutTransactionType) protected boolean
DefaultPaymentTransactionExecutionService.shouldExecutePaymentTransaction
(@NonNull PaymentSummary paymentSummary, @NonNull 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) Modifier and TypeMethodDescriptionDefaultPaymentPriorityStrategy.sortByPaymentGatewayPriority
(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) PaymentPriorityStrategy.sortByPaymentGatewayPriority
(List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Given a list ofPaymentSummaries
, sorts them in order of which should be executed first based ongetGatewayType()
.protected List<PaymentSummary>
DefaultPaymentTransactionExecutionService.sortPayments
(@NonNull List<PaymentSummary> payments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Given a list ofPaymentSummaries
, sorts them in order of which should be executed first based on thegetGatewayType()
.protected List<PaymentSummary>
DefaultPaymentTransactionExecutionService.sortPayments
(List<PaymentSummary> payments) Deprecated.since 1.7.2, in favor ofDefaultPaymentTransactionExecutionService.sortPayments(List, ContextInfo)
ModifierConstructorDescriptionDefaultPaymentTransactionExecutionService
(PaymentTransactionExecutionProvider transactionExecutionProvider, PaymentProvider<PaymentSummary> paymentProvider, CartOperationCheckoutProperties properties, com.broadleafcommerce.common.extension.TypeFactory typeFactory) -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider
Modifier and TypeInterfaceDescriptioninterface
PaymentProvider<P extends PaymentSummary>
Provider for interfacing with a Payment Management system for operations around payment related entities.Modifier and TypeMethodDescriptionPaymentProvider.claimTransactionsForRequest
(ClaimCheckoutTransactionsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Updates the payment transaction request id with the new value, stores the previous value, clears transaction management state and management state reason.default PaymentSummary
PaymentProvider.patchPayment
(@NonNull UpdatePaymentRequest updatePaymentRequest, @NonNull Integer version, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Updates the payment based on the providedUpdatePaymentRequest
.PaymentProvider.patchPayment
(UpdatePaymentRequest updatePaymentRequest, Integer version, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context) Updates the payment based on the providedUpdatePaymentRequest
. -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider.external.domain.payment
Modifier and TypeMethodDescriptionTransactionExecutionResponse.getPaymentSummary()
The updatedPaymentSummary
representation.Modifier and TypeMethodDescriptionUpdatePaymentsResponse.getFailedPayments()
List of payments that failed during processing.LockPaymentsResponse.getPaymentSummaries()
List of payments that were locked.UpdatePaymentsResponse.getSuccessfulPayments()
List of payments that were successfully processed.Modifier and TypeMethodDescriptionvoid
TransactionExecutionResponse.setPaymentSummary
(PaymentSummary paymentSummary) The updatedPaymentSummary
representation.Modifier and TypeMethodDescriptionvoid
UpdatePaymentsResponse.setFailedPayments
(List<PaymentSummary> failedPayments) List of payments that failed during processing.void
LockPaymentsResponse.setPaymentSummaries
(List<PaymentSummary> paymentSummaries) List of payments that were locked.void
UpdatePaymentsResponse.setSuccessfulPayments
(List<PaymentSummary> successfulPayments) List of payments that were successfully processed. -
Uses of PaymentSummary in com.broadleafcommerce.cartoperation.service.provider.external.payments
Modifier and TypeClassDescriptionclass
ExternalPaymentProvider<P extends PaymentSummary>
This particular implementation ofPaymentProvider
is designed to interact with the payment transaction service.Modifier and TypeMethodDescriptionExternalPaymentProvider.claimTransactionsForRequest
(@NonNull ClaimCheckoutTransactionsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) 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
Modifier and TypeMethodDescriptionCheckoutResponse.getPaymentSummaries()
A collection ofPaymentSummaries
related to theCart
.Modifier and TypeMethodDescriptionvoid
CheckoutResponse.setPaymentSummaries
(List<PaymentSummary> paymentSummaries) A collection ofPaymentSummaries
related to theCart
.
DefaultPaymentTransactionExecutionService.sortPayments(List, ContextInfo)