Package org.broadleafcommerce.common.payment.service

Interface PaymentGatewayTransparentRedirectService

All Known Implementing Classes:

AbstractPaymentGatewayTransparentRedirectService

public interface PaymentGatewayTransparentRedirectService

The purpose of this class, is to provide an API that will create any gateway specific parameters needed for a Transparent Redirect/Silent Order Post etc...

Some payment gateways provide this ability and will generate either a Secure Token or some hashed parameters that will be placed as hidden fields on your Credit Card form. These parameters (along with the Credit Card information) will be placed on the ResponseDTO and your HTML should include these fields to be POSTed directly to the implementing gateway for processing.

In addition, some gateways also support the creation of a payment token (i.e. a tokenized version of a Credit Card that can be used on subsequent requests) outside the scope of an authorize or sale transaction.

Author:

Elbert Bautista (elbertbautista)

Method Summary

Modifier and Type	Method	Description
PaymentResponseDTO	createAuthorizeAndCaptureForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	createAuthorizeForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	createCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
String	getCreateCustomerPaymentTokenCancelURLFieldKey(PaymentResponseDTO responseDTO)	Return the PaymentResponseDTO.responseMap key that corresponds to creating the customer token cancel url
String	getCreateCustomerPaymentTokenReturnURLFieldKey(PaymentResponseDTO responseDTO)	Return the PaymentResponseDTO.responseMap key that corresponds to creating the customer token return url
String	getUpdateCustomerPaymentTokenCancelURLFieldKey(PaymentResponseDTO responseDTO)	Return the PaymentResponseDTO.responseMap key that corresponds to updating the customer token cancel url
String	getUpdateCustomerPaymentTokenReturnURLFieldKey(PaymentResponseDTO responseDTO)	Return the PaymentResponseDTO.responseMap key that corresponds to updating the customer token return url
PaymentResponseDTO	updateCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)

Method Details

createAuthorizeForm

PaymentResponseDTO createAuthorizeForm(PaymentRequestDTO requestDTO)
                                throws PaymentException

Throws:

PaymentException

createAuthorizeAndCaptureForm

PaymentResponseDTO createAuthorizeAndCaptureForm(PaymentRequestDTO requestDTO)
                                          throws PaymentException

Throws:

PaymentException

createCustomerPaymentTokenForm

PaymentResponseDTO createCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
                                           throws PaymentException

Throws:

PaymentException

updateCustomerPaymentTokenForm

PaymentResponseDTO updateCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
                                           throws PaymentException

Throws:

PaymentException

getCreateCustomerPaymentTokenReturnURLFieldKey

String getCreateCustomerPaymentTokenReturnURLFieldKey(PaymentResponseDTO responseDTO)

Return the PaymentResponseDTO.responseMap key that corresponds to creating the customer token return url

getCreateCustomerPaymentTokenCancelURLFieldKey

String getCreateCustomerPaymentTokenCancelURLFieldKey(PaymentResponseDTO responseDTO)

Return the PaymentResponseDTO.responseMap key that corresponds to creating the customer token cancel url

getUpdateCustomerPaymentTokenReturnURLFieldKey

String getUpdateCustomerPaymentTokenReturnURLFieldKey(PaymentResponseDTO responseDTO)

Return the PaymentResponseDTO.responseMap key that corresponds to updating the customer token return url

getUpdateCustomerPaymentTokenCancelURLFieldKey

String getUpdateCustomerPaymentTokenCancelURLFieldKey(PaymentResponseDTO responseDTO)

Return the PaymentResponseDTO.responseMap key that corresponds to updating the customer token cancel url