Package com.broadleafcommerce.billing.job.service

Interface PaymentTransactionExecutionService<P extends BillingProcessingRequest>

All Known Implementing Classes:

DefaultPaymentTransactionExecutionService

public interface PaymentTransactionExecutionService<P extends BillingProcessingRequest>

Simple abstraction for executing payment transactions based on a provided BillingProcessingRequest. The expectation is that the implementation executes the necessary transaction & populates the relevant fields on the BillingProcessingRequest.currentAccountProcessingRequest() to communicate the result of the interaction.

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method	Description
P	authorizeAndCapture(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes an AuthorizeAndCapture (aka Charge) transaction based on the provided BillingProcessingRequest
P	lookupAndRecordTransactionResults(PaymentTransactionDetail paymentTransactionDetail, P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Looks up transaction results for the provided PaymentTransactionDetail, & if present, stores the transaction results on the BillingProcessingRequest.currentAccountProcessingRequest()
P	refund(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes a Refund transaction based on the provided BillingProcessingRequest

Method Details

authorizeAndCapture

P authorizeAndCapture(P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Executes an AuthorizeAndCapture (aka Charge) transaction based on the provided BillingProcessingRequest

Parameters:

request - the BillingProcessingRequest describing the payment method & amount to be charged

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest()

Throws:

DuplicateTransactionAttemptException - if the requested transaction has already been executed

refund

P refund(P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Executes a Refund transaction based on the provided BillingProcessingRequest

Parameters:

request - the BillingProcessingRequest describing the payment method & amount to be refunded

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest()

Throws:

DuplicateTransactionAttemptException - if the requested transaction has already been executed

lookupAndRecordTransactionResults

P lookupAndRecordTransactionResults(PaymentTransactionDetail paymentTransactionDetail,
 P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Looks up transaction results for the provided PaymentTransactionDetail, & if present, stores the transaction results on the BillingProcessingRequest.currentAccountProcessingRequest()

Parameters:

paymentTransactionDetail - The transaction whose result is unknown, & therefore needs to be looked up

request - the BillingProcessingRequest describing the payment method & amount that was expected to be charged or refunded

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest(), if the transaction results are found