com.broadleafcommerce.cartoperation.service.payment

Interface PaymentConfirmationService

All Known Implementing Classes:

DefaultPaymentConfirmationService

public interface PaymentConfirmationService

This service is meant to coordinate the confirmation (and possible rollback) of a cart's payments in the context of a checkout submission.

Author:

Chris Kittrell (ckittrell)

See Also:

PaymentSummaryService#shouldConfirmPayment(Payment)

Method Summary

Modifier and Type	Method and Description
com.broadleafcommerce.cart.client.domain.Cart	confirmCartPayments(com.broadleafcommerce.cart.client.domain.Cart cart, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to confirm all unconfirmed, active payments related to the provided Cart.
com.broadleafcommerce.cart.client.domain.Cart	confirmCartPayments(com.broadleafcommerce.cart.client.domain.Cart cart, String requestId, Map<String,String> securityCodes, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to confirm all unconfirmed, active payments related to the provided Cart.
List<com.broadleafcommerce.order.common.domain.Payment>	getConfirmedPaymentsToRollback(com.broadleafcommerce.cart.client.domain.Cart cart, String requestId) Gather confirmed payments that have a successful transactions tied to the provided requestId
com.broadleafcommerce.cart.client.domain.Cart	rollbackConfirmedPayments(com.broadleafcommerce.cart.client.domain.Cart cart, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to roll back all authorized, active payments related to the provided Cart.

Method Detail

confirmCartPayments

com.broadleafcommerce.cart.client.domain.Cart confirmCartPayments(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                  String requestId,
                                                                  Map<String,String> securityCodes,
                                                                  @Nullable
                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Intended to confirm all unconfirmed, active payments related to the provided Cart. Ultimately the confirmation of each unconfirmed payment should lead to a payment gateway transaction (usually an DefaultTransactionTypes.AUTHORIZE transaction) & the recording of a PaymentTransaction on the cart.

Parameters:

cart - the cart that owns the list of payments

requestId - the id representing the customer's request to confirm their payments

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

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with confirmed payments

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while processing the payments

confirmCartPayments

com.broadleafcommerce.cart.client.domain.Cart confirmCartPayments(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                  String requestId,
                                                                  @Nullable
                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Intended to confirm all unconfirmed, active payments related to the provided Cart. Ultimately the confirmation of each unconfirmed payment should lead to a payment gateway transaction (usually an DefaultTransactionTypes.AUTHORIZE transaction) & the recording of a PaymentTransaction on the cart.

Parameters:

cart - the cart that owns the list of payments

requestId - the id representing the customer's request to confirm their payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with confirmed payments

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while processing the payments

getConfirmedPaymentsToRollback

List<com.broadleafcommerce.order.common.domain.Payment> getConfirmedPaymentsToRollback(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                       String requestId)

Gather confirmed payments that have a successful transactions tied to the provided requestId

Parameters:

cart - The cart whose checkout submission is being processed

requestId - the unique identifier of this checkout attempt

Returns:

the list of confirmed payments that have a successful transactions tied to the provided requestId

rollbackConfirmedPayments

com.broadleafcommerce.cart.client.domain.Cart rollbackConfirmedPayments(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                        String requestId,
                                                                        @Nullable
                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Intended to roll back all authorized, active payments related to the provided Cart. The rollback of each authorized payment should lead to a DefaultTransactionTypes.REVERSE_AUTH payment gateway transaction & an updating of the relevant PaymentTransaction to have a unconfirmed status.

Parameters:

cart - the cart that owns the list of payments that are to be rolled back

requestId - the id representing the customer's request to confirm their payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with rolled back payments

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while processing the payment rollbacks