Package com.broadleafcommerce.cartoperation.service.payment

Interface ExternalPaymentTransactionCallbackService

All Known Implementing Classes:

DefaultExternalPaymentTransactionCallbackService

public interface ExternalPaymentTransactionCallbackService

Service used to interpret the results of an external payment transaction callback, possibly trigger the finalization of the cart, & communicate the result of the interaction via the ExternalPaymentTransactionCallbackDTO.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
ExternalPaymentTransactionCallbackDTO	handleCallback(ExternalPaymentTransactionCallbackDTO callbackDTO, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Interprets the results of an external payment transaction callback, possibly triggers the finalization of the cart, & communicates the result of the interaction via the ExternalPaymentTransactionCallbackDTO.
ExternalPaymentTransactionCallbackDTO	validatePaymentCallback(@NonNull ExternalPaymentTransactionCallbackDTO callbackDTO, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the results of an external payment transaction callback.

Method Details

validatePaymentCallback

ExternalPaymentTransactionCallbackDTO validatePaymentCallback(@NonNull
 @NonNull ExternalPaymentTransactionCallbackDTO callbackDTO,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates the results of an external payment transaction callback. If invalid, should return an empty ExternalPaymentTransactionCallbackDTO so that no sensitive information can be returned to a potentially malicious request.

Parameters:

callbackDTO - The DTO used to communicate the cart & transaction data provided by the callback request

contextInfo - context information related to multitenancy

Returns:

the validated ExternalPaymentTransactionCallbackDTO

handleCallback

ExternalPaymentTransactionCallbackDTO handleCallback(ExternalPaymentTransactionCallbackDTO callbackDTO,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Interprets the results of an external payment transaction callback, possibly triggers the finalization of the cart, & communicates the result of the interaction via the ExternalPaymentTransactionCallbackDTO.

Parameters:

callbackDTO - The DTO used to communicate the cart & transaction data provided by the callback request

contextInfo - context information related to multitenancy

Returns:

An updated ExternalPaymentTransactionCallbackDTO describing the result of the external payment interaction