Package com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayHostedService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewayHostedService
extends PaymentGatewayTypeAware

Certain Payment Integrations allow you to use a Hosted Solution, such as PayPal Express and SagePay Form. This API allows you to create the call to send a user to the Gateway's Hosted page and to capture and record transaction responses back from them.

Author:

Elbert Bautista (elbertbautista)

Method Summary

Modifier and Type	Method	Description
default ExternalFulfillmentCallbackTransformedResponse	buildShippingCallbackResponse(ExternalFulfillmentCallbackInfo callbackInfo)	Builds the response to the gateway for the fulfillment callback.
default PaymentResponse	requestHostedEndpoint(PaymentRequest paymentRequest, boolean capture)
default List<ExternalGatewayFulfillmentUpdate>	updateShippingCallback(ExternalFulfillmentCallbackDTO callbackDTO)	Returns the list of fulfillment updates parsed from the ExternalFulfillmentCallbackDTO for this gateway.

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

getGatewayType

Method Details

updateShippingCallback

default List<ExternalGatewayFulfillmentUpdate> updateShippingCallback(ExternalFulfillmentCallbackDTO callbackDTO)
                                                               throws PaymentException

Returns the list of fulfillment updates parsed from the ExternalFulfillmentCallbackDTO for this gateway.

Parameters:

callbackDTO - The fulfillment information from the gateway

Returns:

a list of fulfillment updates

Throws:

PaymentException

buildShippingCallbackResponse

default ExternalFulfillmentCallbackTransformedResponse buildShippingCallbackResponse(ExternalFulfillmentCallbackInfo callbackInfo)
                                                                              throws PaymentException

Builds the response to the gateway for the fulfillment callback.

Parameters:

callbackInfo - The information needed to build a response to the gateway.

Returns:

The response to the gateway transformed into a generic payload.

Throws:

PaymentException

requestHostedEndpoint

default PaymentResponse requestHostedEndpoint(PaymentRequest paymentRequest,
 boolean capture)
                                       throws PaymentException

Throws:

PaymentException