com.broadleafcommerce.paymentgateway.service

Class PassthroughPaymentTransactionService

java.lang.Object

com.broadleafcommerce.paymentgateway.service.PassthroughPaymentTransactionService

All Implemented Interfaces:

PassthroughTransactionService, PaymentGatewayTransactionService, PaymentGatewayTypeAware

public class PassthroughPaymentTransactionService
extends Object
implements PassthroughTransactionService

Constructor Summary

Constructors

Constructor and Description
PassthroughPaymentTransactionService()

Method Summary

Modifier and Type	Method and Description
PaymentResponse	authorize(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.AUTHORIZE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.
PaymentResponse	authorizeAndCapture(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.
PaymentResponse	capture(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.
String	getGatewayType() Each payment module should have a unique implementation of PaymentGatewayType with only a single type.
PaymentResponse	refund(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.REFUND transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.
PaymentResponse	reverseAuthorize(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.REVERSE_AUTH transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.
PaymentResponse	voidPayment(PaymentRequest paymentRequest) Responsible for executing a DefaultTransactionTypes.VOID transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PassthroughPaymentTransactionService

public PassthroughPaymentTransactionService()

Method Detail

authorize

public PaymentResponse authorize(PaymentRequest paymentRequest)
                          throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.AUTHORIZE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

authorize in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the authorization transaction

Throws:

PaymentException

capture

public PaymentResponse capture(PaymentRequest paymentRequest)
                        throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

capture in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the capture transaction

Throws:

PaymentException

authorizeAndCapture

public PaymentResponse authorizeAndCapture(PaymentRequest paymentRequest)
                                    throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

authorizeAndCapture in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the authorization & capture transaction

Throws:

PaymentException

reverseAuthorize

public PaymentResponse reverseAuthorize(PaymentRequest paymentRequest)
                                 throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.REVERSE_AUTH transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

reverseAuthorize in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the reverse authorization transaction

Throws:

PaymentException

refund

public PaymentResponse refund(PaymentRequest paymentRequest)
                       throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.REFUND transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

refund in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the refund transaction

Throws:

PaymentException

voidPayment

public PaymentResponse voidPayment(PaymentRequest paymentRequest)
                            throws PaymentException

Description copied from interface: PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.VOID transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

Specified by:

voidPayment in interface PaymentGatewayTransactionService

Parameters:

paymentRequest - The request payload that must be converted into the gateway's expected payload

Returns:

The results of the void transaction

Throws:

PaymentException

getGatewayType

public String getGatewayType()

Description copied from interface: PaymentGatewayTypeAware

Each payment module should have a unique implementation of PaymentGatewayType with only a single type. For instance, the Braintree module would have a 'BraintreePaymentGatewayType' implementation which defines its gateway type key.

Specified by:

getGatewayType in interface PaymentGatewayTypeAware

Returns:

The PaymentGatewayType related to implementing resource