org.broadleafcommerce.core.payment.service.module

Interface PaymentModule

All Known Implementing Classes:

AbstractModule, AcceptAndPassthroughModule, DefaultModule, NullCreditCardPaymentModule

public interface PaymentModule

Method Summary

Modifier and Type	Method and Description
PaymentResponseItem	authorize(PaymentContext paymentContext)
PaymentResponseItem	authorizeAndDebit(PaymentContext paymentContext)
PaymentResponseItem	balance(PaymentContext paymentContext)
PaymentResponseItem	credit(PaymentContext paymentContext)
PaymentResponseItem	debit(PaymentContext paymentContext)
Boolean	isValidCandidate(PaymentInfoType paymentType)
PaymentResponseItem	partialPayment(PaymentContext paymentContext)
PaymentResponseItem	processAuthorize(PaymentContext paymentContext, Money amountToAuthorize, PaymentResponseItem responseItem)
PaymentResponseItem	processAuthorizeAndDebit(PaymentContext paymentContext, Money amountToDebit, PaymentResponseItem responseItem)
PaymentResponseItem	processBalance(PaymentContext paymentContext, PaymentResponseItem responseItem)
PaymentResponseItem	processCredit(PaymentContext paymentContext, Money amountToCredit, PaymentResponseItem responseItem)
PaymentResponseItem	processDebit(PaymentContext paymentContext, Money amountToDebit, PaymentResponseItem responseItem)
PaymentResponseItem	processPartialPayment(PaymentContext paymentContext, Money amountToDebit, PaymentResponseItem responseItem)
PaymentResponseItem	processReverseAuthorize(PaymentContext paymentContext, Money amountToReverseAuthorize, PaymentResponseItem responseItem)
PaymentResponseItem	processVoidPayment(PaymentContext paymentContext, Money amountToVoid, PaymentResponseItem responseItem)
PaymentResponseItem	reverseAuthorize(PaymentContext paymentContext)
PaymentResponseItem	voidPayment(PaymentContext paymentContext)

Method Detail

authorize

PaymentResponseItem authorize(PaymentContext paymentContext)
                       throws PaymentException

Throws:

PaymentException

reverseAuthorize

PaymentResponseItem reverseAuthorize(PaymentContext paymentContext)
                              throws PaymentException

Throws:

PaymentException

debit

PaymentResponseItem debit(PaymentContext paymentContext)
                   throws PaymentException

Throws:

PaymentException

authorizeAndDebit

PaymentResponseItem authorizeAndDebit(PaymentContext paymentContext)
                               throws PaymentException

Throws:

PaymentException

credit

PaymentResponseItem credit(PaymentContext paymentContext)
                    throws PaymentException

Throws:

PaymentException

voidPayment

PaymentResponseItem voidPayment(PaymentContext paymentContext)
                         throws PaymentException

Throws:

PaymentException

balance

PaymentResponseItem balance(PaymentContext paymentContext)
                     throws PaymentException

Throws:

PaymentException

partialPayment

PaymentResponseItem partialPayment(PaymentContext paymentContext)
                            throws PaymentException

Throws:

PaymentException

isValidCandidate

Boolean isValidCandidate(PaymentInfoType paymentType)

processReverseAuthorize

PaymentResponseItem processReverseAuthorize(PaymentContext paymentContext,
                                            Money amountToReverseAuthorize,
                                            PaymentResponseItem responseItem)
                                     throws PaymentException

Throws:

PaymentException

processAuthorize

PaymentResponseItem processAuthorize(PaymentContext paymentContext,
                                     Money amountToAuthorize,
                                     PaymentResponseItem responseItem)
                              throws PaymentException

Throws:

PaymentException

processDebit

PaymentResponseItem processDebit(PaymentContext paymentContext,
                                 Money amountToDebit,
                                 PaymentResponseItem responseItem)
                          throws PaymentException

Throws:

PaymentException

processAuthorizeAndDebit

PaymentResponseItem processAuthorizeAndDebit(PaymentContext paymentContext,
                                             Money amountToDebit,
                                             PaymentResponseItem responseItem)
                                      throws PaymentException

Throws:

PaymentException

processCredit

PaymentResponseItem processCredit(PaymentContext paymentContext,
                                  Money amountToCredit,
                                  PaymentResponseItem responseItem)
                           throws PaymentException

Throws:

PaymentException

processVoidPayment

PaymentResponseItem processVoidPayment(PaymentContext paymentContext,
                                       Money amountToVoid,
                                       PaymentResponseItem responseItem)
                                throws PaymentException

Throws:

PaymentException

processBalance

PaymentResponseItem processBalance(PaymentContext paymentContext,
                                   PaymentResponseItem responseItem)
                            throws PaymentException

Throws:

PaymentException

processPartialPayment

PaymentResponseItem processPartialPayment(PaymentContext paymentContext,
                                          Money amountToDebit,
                                          PaymentResponseItem responseItem)
                                   throws PaymentException

Throws:

PaymentException