com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayTransparentRedirectService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewayTransparentRedirectService
extends PaymentGatewayTypeAware

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 and Description
default PaymentResponse	createAuthorizeAndCaptureForm(PaymentRequest requestDTO)
default PaymentResponse	createAuthorizeForm(PaymentRequest requestDTO)
default PaymentResponse	createCustomerPaymentTokenForm(PaymentRequest requestDTO)
default String	getCreateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse responseDTO) Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token cancel url
default String	getCreateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse responseDTO) Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token return url
default String	getUpdateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse responseDTO) Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token cancel url
default String	getUpdateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse responseDTO) Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token return url
default PaymentResponse	updateCustomerPaymentTokenForm(PaymentRequest requestDTO)

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

getGatewayType

Method Detail

createAuthorizeForm

default PaymentResponse createAuthorizeForm(PaymentRequest requestDTO)
                                     throws PaymentException

Throws:

PaymentException

createAuthorizeAndCaptureForm

default PaymentResponse createAuthorizeAndCaptureForm(PaymentRequest requestDTO)
                                               throws PaymentException

Throws:

PaymentException

createCustomerPaymentTokenForm

default PaymentResponse createCustomerPaymentTokenForm(PaymentRequest requestDTO)
                                                throws PaymentException

Throws:

PaymentException

updateCustomerPaymentTokenForm

default PaymentResponse updateCustomerPaymentTokenForm(PaymentRequest requestDTO)
                                                throws PaymentException

Throws:

PaymentException

getCreateCustomerPaymentTokenReturnURLFieldKey

default String getCreateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse responseDTO)

Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token return url

getCreateCustomerPaymentTokenCancelURLFieldKey

default String getCreateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse responseDTO)

Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token cancel url

getUpdateCustomerPaymentTokenReturnURLFieldKey

default String getUpdateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse responseDTO)

Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token return url

getUpdateCustomerPaymentTokenCancelURLFieldKey

default String getUpdateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse responseDTO)

Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token cancel url