Package com.broadleafcommerce.paymenttransaction.service

Interface TransactionExecutionService

All Known Implementing Classes:

DefaultTransactionExecutionService

public interface TransactionExecutionService

Method Summary

Modifier and Type	Method	Description
TransactionExecutionResponse	authorize(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute an DefaultTransactionTypes.AUTHORIZE transaction.
TransactionExecutionResponse	authorizeAndCapture(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute an DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction.
TransactionExecutionResponse	capture(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.CAPTURE transaction.
TransactionExecutionResponse	detachedCredit(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.DETACHED_CREDIT transaction.
TransactionExecutionResponse	recordGatewayTransactionResults(@NonNull String paymentId, Map<String,Object> transactionResults, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Records transaction results that are processed by the gateway outside the checkout workflow.
TransactionExecutionResponse	refund(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.REFUND transaction.
TransactionExecutionResponse	reverseAuthorize(@NonNull TransactionExecutionRequest request, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.REVERSE_AUTH transaction.
Payment	updatePaymentBasedOnTransactionResult(@NonNull Payment payment, @NonNull PaymentTransaction transaction, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Based on the results of the payment gateway authorize transaction, update the Payment and SavedPaymentMethod.

Method Details

authorize

TransactionExecutionResponse authorize(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute an DefaultTransactionTypes.AUTHORIZE transaction.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

authorizeAndCapture

TransactionExecutionResponse authorizeAndCapture(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute an DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

capture

TransactionExecutionResponse capture(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.CAPTURE transaction.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

reverseAuthorize

TransactionExecutionResponse reverseAuthorize(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.REVERSE_AUTH transaction.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

refund

TransactionExecutionResponse refund(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.REFUND transaction.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

detachedCredit

TransactionExecutionResponse detachedCredit(@NonNull
 @NonNull TransactionExecutionRequest request,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway to execute a DefaultTransactionTypes.DETACHED_CREDIT transaction.

If TransactionExecutionRequest.getParentTransactionId() is provided, then we'll consider it to be acting as a refund. In this case, the parent transaction should have DefaultTransactionTypes.CAPTURE or DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE type, and TransactionExecutionRequest.getTransactionAmount() must be less than or equal to the parent transaction's amount.

Parameters:

request - The TransactionExecutionRequest describing the desired details of the transaction.

lockToken - Token granted to resource that owns the payment lock.

Returns:

The TransactionExecutionDetail describing the resulting transaction and PaymentSummary.

Throws:

com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if a Payment cannot be found for the given TransactionExecutionRequest.getPaymentId().

InvalidTransactionExecutionRequestException - if the TransactionExecutionRequest is invalid.

PaymentTransactionExecutionException - if an unexpected error was encountered while executing the transaction.

recordGatewayTransactionResults

TransactionExecutionResponse recordGatewayTransactionResults(@NonNull
 @NonNull String paymentId,
 Map<String,Object> transactionResults,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Records transaction results that are processed by the gateway outside the checkout workflow.

Parameters:

paymentId - the ID of the payment for this transaction

transactionResults - a map of the gateway's results for this transaction

context - Context information around sandbox and multitenant state.

Returns:

The TransactionExecutionResponse describing the resulting transaction and PaymentSummary.

updatePaymentBasedOnTransactionResult

@Nullable
Payment updatePaymentBasedOnTransactionResult(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull PaymentTransaction transaction,
 @NonNull
 @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Based on the results of the payment gateway authorize transaction, update the Payment and SavedPaymentMethod.

Parameters:

payment - the payment that is to be updated based on the transaction

transaction - the transaction that was just executed

response - the payment gateway's response to the transaction

lockToken - Token granted to resource that owns the payment lock.

contextInfo - Context information related to multitenancy.

Returns:

the updated payment