com.liferay.commerce.payment.method

Interface CommercePaymentMethod

All Known Implementing Classes:

TestCommercePaymentMethod

public interface CommercePaymentMethod

Method Summary

Modifier and Type	Method and Description
default boolean	activateRecurringPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	authorizePayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	cancelPayment(CommercePaymentRequest commercePaymentRequest)
default boolean	cancelRecurringPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	capturePayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	completePayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	completeRecurringPayment(CommercePaymentRequest commercePaymentRequest)
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getKey()
java.lang.String	getName(java.util.Locale locale)
default int	getOrderStatusUpdateMaxIntervalMinutes() Deprecated. As of Mueller (7.2.x), this method will be removed
int	getPaymentType()
java.lang.String	getServletPath()
default CommerceSubscriptionStatusResult	getSubscriptionPaymentDetails(CommercePaymentRequest commercePaymentRequest)
default boolean	getSubscriptionValidity(CommercePaymentRequest commercePaymentRequest)
default boolean	isAuthorizeEnabled()
default boolean	isCancelEnabled()
default boolean	isCancelRecurringEnabled()
default boolean	isCaptureEnabled()
default boolean	isCompleteEnabled()
default boolean	isCompleteRecurringEnabled()
default boolean	isPartialRefundEnabled()
default boolean	isPostProcessEnabled()
default boolean	isProcessPaymentEnabled()
default boolean	isProcessRecurringEnabled()
default boolean	isRefundEnabled()
default boolean	isVoidEnabled()
default CommercePaymentResult	partiallyRefundPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	postProcessPayment()
default CommercePaymentResult	processPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	processRecurringPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	refundPayment(CommercePaymentRequest commercePaymentRequest)
default boolean	suspendRecurringPayment(CommercePaymentRequest commercePaymentRequest)
default CommercePaymentResult	voidTransaction(CommercePaymentRequest commercePaymentRequest)

Method Detail

activateRecurringPayment

default boolean activateRecurringPayment(CommercePaymentRequest commercePaymentRequest)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

authorizePayment

default CommercePaymentResult authorizePayment(CommercePaymentRequest commercePaymentRequest)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

cancelPayment

default CommercePaymentResult cancelPayment(CommercePaymentRequest commercePaymentRequest)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

cancelRecurringPayment

default boolean cancelRecurringPayment(CommercePaymentRequest commercePaymentRequest)
                                throws java.lang.Exception

Throws:

java.lang.Exception

capturePayment

default CommercePaymentResult capturePayment(CommercePaymentRequest commercePaymentRequest)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

completePayment

default CommercePaymentResult completePayment(CommercePaymentRequest commercePaymentRequest)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

completeRecurringPayment

default CommercePaymentResult completeRecurringPayment(CommercePaymentRequest commercePaymentRequest)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

java.lang.String getDescription(java.util.Locale locale)

getKey

java.lang.String getKey()

getName

java.lang.String getName(java.util.Locale locale)

getOrderStatusUpdateMaxIntervalMinutes

@Deprecated
default int getOrderStatusUpdateMaxIntervalMinutes()

Deprecated. As of Mueller (7.2.x), this method will be removed

getPaymentType

int getPaymentType()

getServletPath

java.lang.String getServletPath()

getSubscriptionPaymentDetails

default CommerceSubscriptionStatusResult getSubscriptionPaymentDetails(CommercePaymentRequest commercePaymentRequest)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionValidity

default boolean getSubscriptionValidity(CommercePaymentRequest commercePaymentRequest)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isAuthorizeEnabled

default boolean isAuthorizeEnabled()

isCancelEnabled

default boolean isCancelEnabled()

isCancelRecurringEnabled

default boolean isCancelRecurringEnabled()

isCaptureEnabled

default boolean isCaptureEnabled()

isCompleteEnabled

default boolean isCompleteEnabled()

isCompleteRecurringEnabled

default boolean isCompleteRecurringEnabled()

isPartialRefundEnabled

default boolean isPartialRefundEnabled()

isPostProcessEnabled

default boolean isPostProcessEnabled()

isProcessPaymentEnabled

default boolean isProcessPaymentEnabled()

isProcessRecurringEnabled

default boolean isProcessRecurringEnabled()

isRefundEnabled

default boolean isRefundEnabled()

isVoidEnabled

default boolean isVoidEnabled()

partiallyRefundPayment

default CommercePaymentResult partiallyRefundPayment(CommercePaymentRequest commercePaymentRequest)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

postProcessPayment

default CommercePaymentResult postProcessPayment()
                                          throws java.lang.Exception

Throws:

java.lang.Exception

processPayment

default CommercePaymentResult processPayment(CommercePaymentRequest commercePaymentRequest)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

processRecurringPayment

default CommercePaymentResult processRecurringPayment(CommercePaymentRequest commercePaymentRequest)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

refundPayment

default CommercePaymentResult refundPayment(CommercePaymentRequest commercePaymentRequest)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

suspendRecurringPayment

default boolean suspendRecurringPayment(CommercePaymentRequest commercePaymentRequest)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

voidTransaction

default CommercePaymentResult voidTransaction(CommercePaymentRequest commercePaymentRequest)
                                       throws java.lang.Exception

Throws:

java.lang.Exception