com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayTransactionConfirmationService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewayTransactionConfirmationService
extends PaymentGatewayTypeAware

This API is intended to be called by the Checkout Workflow to confirm all Payments on the order that have not yet been confirmed/finalized. In the case where an error is thrown by the gateway and confirming is not possible, the workflow should invoke the rollback handlers on any Payments that have already been successfully confirmed.

Not all Gateways allow confirmation. The this can be determined using the PaymentRequest.isCompleteCheckoutOnCallback() flag. If this value is set to true, then the gateway does not support confirming the transaction, as it assumes to be the final step in the completion process. Most Credit Card integrations do not support confirming the transaction, Third Party providers like PayPal Express, or the BLC Gift Card Module do and should implement this interface.

Author:

Elbert Bautista (elbertbautista)

See Also:

PaymentGatewayRollbackService}, PaymentGatewayConfiguration}

Method Summary

Modifier and Type	Method and Description
default PaymentResponse	confirmTransaction(PaymentRequest paymentRequest)

Methods inherited from interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware

getGatewayType

Method Detail

confirmTransaction

default PaymentResponse confirmTransaction(PaymentRequest paymentRequest)
                                    throws PaymentException

Throws:

PaymentException