org.broadleafcommerce.common.payment.service

Interface PaymentGatewayTransactionService

All Known Implementing Classes:

AbstractPaymentGatewayTransactionService, PassthroughPaymentTransactionService

public interface PaymentGatewayTransactionService

This is a decoupled interface that provides the basic functions needed to create the normal BILLABLE Credit Card Transactions

The intention of these method implementations are to make a Server to Server API call. Depending on the Gateway implementation, the overall goal and meaning of the method may vary: For example, a module can implement the AUTHORIZE method:

• Either to send Credit Card information directly (Server to Server) to the gateway to perform the transaction
• Or to confirm an AUTHORIZATION process (some gateways dont handle a token based process through a Transparent Redirect)
• OR handle both (the implementation will do one or the other based on the passed in parameters)

Please check the documentation of the implementing module to determine intended goal.

Note: in the case where a gateway doesn't support confirming the transaction before it is submitted (i.e. paymentGatewayConfigurationService.completeCheckoutOnCallback() == true) The PaymentGatewayWebResponseService will handle translation of the final transaction response from the gateway. There is no need to re-call this service if the gateway doesn't support confirming the transaction.

Author:

Elbert Bautista (elbertbautista)

See Also:

PaymentGatewayWebResponseService}

Method Summary

Modifier and Type	Method and Description
PaymentResponseDTO	authorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	authorizeAndCapture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	capture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	refund(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	reverseAuthorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	voidPayment(PaymentRequestDTO paymentRequestDTO)

Method Detail

authorize

PaymentResponseDTO authorize(PaymentRequestDTO paymentRequestDTO)
                      throws PaymentException

Throws:

PaymentException

capture

PaymentResponseDTO capture(PaymentRequestDTO paymentRequestDTO)
                    throws PaymentException

Throws:

PaymentException

authorizeAndCapture

PaymentResponseDTO authorizeAndCapture(PaymentRequestDTO paymentRequestDTO)
                                throws PaymentException

Throws:

PaymentException

reverseAuthorize

PaymentResponseDTO reverseAuthorize(PaymentRequestDTO paymentRequestDTO)
                             throws PaymentException

Throws:

PaymentException

refund

PaymentResponseDTO refund(PaymentRequestDTO paymentRequestDTO)
                   throws PaymentException

Throws:

PaymentException

voidPayment

PaymentResponseDTO voidPayment(PaymentRequestDTO paymentRequestDTO)
                        throws PaymentException

Throws:

PaymentException