com.liferay.commerce.payment.engine

Interface CommercePaymentEngine

@ProviderType
public interface CommercePaymentEngine

Method Summary

Modifier and Type	Method and Description
CommercePaymentResult	cancelPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	cancelRecurringPayment(long commerceOrderId) Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine
CommercePaymentResult	capturePayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	completePayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	completeRecurringPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest) Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine
java.lang.String	getCommerceOrderPaymentMethodName(CommerceOrder commerceOrder, javax.servlet.http.HttpServletRequest httpServletRequest, java.util.Locale locale)
int	getCommercePaymentMethodGroupRelsCount(long groupId)
int	getCommercePaymentMethodType(long commerceOrderId)
java.util.List<CommercePaymentMethod>	getEnabledCommercePaymentMethodsForOrder(long commerceOrderId) Deprecated. As of Mueller (7.2.x), this method is being replaced
java.util.List<CommercePaymentMethod>	getEnabledCommercePaymentMethodsForOrder(long groupId, long commerceOrderId)
int	getOrderStatusUpdateMaxIntervalMinutes(long commerceOrderId) Deprecated. As of Mueller (7.2.x), this method will be removed
java.lang.String	getPaymentMethodImageURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, java.lang.String paymentMethodKey)
java.lang.String	getPaymentMethodName(java.lang.String paymentMethodKey, java.util.Locale locale)
CommerceSubscriptionStatusResult	getSubscriptionPaymentDetails(long commerceOrderId) Deprecated. As of Mueller (7.2.x), this method will be removed
CommercePaymentResult	partiallyRefundPayment(long commerceOrderId)
CommercePaymentResult	postProcessPayment(long commerceOrderId)
CommercePaymentResult	processPayment(long commerceOrderId, java.lang.String nextUrl, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	processRecurringPayment(long commerceOrderId, java.lang.String nextUrl, javax.servlet.http.HttpServletRequest httpServletRequest) Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine
CommercePaymentResult	refundPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	startPayment(long commerceOrderId, java.lang.String checkoutStepUrl, javax.servlet.http.HttpServletRequest httpServletRequest)
boolean	suspendSubscription(long commerceSubscriptionEntryId) Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine
CommerceOrder	updateOrderPaymentStatus(long commerceOrderId, int paymentStatus, java.lang.String transactionId)
CommercePaymentResult	voidTransaction(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)

Method Detail

cancelPayment

CommercePaymentResult cancelPayment(long commerceOrderId,
                                    java.lang.String transactionId,
                                    javax.servlet.http.HttpServletRequest httpServletRequest)
                             throws java.lang.Exception

Throws:

java.lang.Exception

cancelRecurringPayment

@Deprecated
CommercePaymentResult cancelRecurringPayment(long commerceOrderId)

Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine

Parameters:

commerceOrderId -

Returns:

capturePayment

CommercePaymentResult capturePayment(long commerceOrderId,
                                     java.lang.String transactionId,
                                     javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws java.lang.Exception

Throws:

java.lang.Exception

completePayment

CommercePaymentResult completePayment(long commerceOrderId,
                                      java.lang.String transactionId,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)
                               throws java.lang.Exception

Throws:

java.lang.Exception

completeRecurringPayment

@Deprecated
CommercePaymentResult completeRecurringPayment(long commerceOrderId,
                                                           java.lang.String transactionId,
                                                           javax.servlet.http.HttpServletRequest httpServletRequest)
                                                    throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine

Parameters:

commerceOrderId -

transactionId -

httpServletRequest -

Returns:

Throws:

java.lang.Exception

getCommerceOrderPaymentMethodName

java.lang.String getCommerceOrderPaymentMethodName(CommerceOrder commerceOrder,
                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                   java.util.Locale locale)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommercePaymentMethodGroupRelsCount

int getCommercePaymentMethodGroupRelsCount(long groupId)

getCommercePaymentMethodType

int getCommercePaymentMethodType(long commerceOrderId)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getEnabledCommercePaymentMethodsForOrder

@Deprecated
java.util.List<CommercePaymentMethod> getEnabledCommercePaymentMethodsForOrder(long commerceOrderId)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Mueller (7.2.x), this method is being replaced

Parameters:

commerceOrderId -

Returns:

Throws:

com.liferay.portal.kernel.exception.PortalException

getEnabledCommercePaymentMethodsForOrder

java.util.List<CommercePaymentMethod> getEnabledCommercePaymentMethodsForOrder(long groupId,
                                                                               long commerceOrderId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOrderStatusUpdateMaxIntervalMinutes

@Deprecated
int getOrderStatusUpdateMaxIntervalMinutes(long commerceOrderId)
                                                throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commerceOrderId -

Returns:

Throws:

com.liferay.portal.kernel.exception.PortalException

getPaymentMethodImageURL

java.lang.String getPaymentMethodImageURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
                                          java.lang.String paymentMethodKey)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPaymentMethodName

java.lang.String getPaymentMethodName(java.lang.String paymentMethodKey,
                                      java.util.Locale locale)

getSubscriptionPaymentDetails

@Deprecated
CommerceSubscriptionStatusResult getSubscriptionPaymentDetails(long commerceOrderId)
                                                                    throws java.lang.Exception

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

Parameters:

commerceOrderId -

Returns:

Throws:

java.lang.Exception

partiallyRefundPayment

CommercePaymentResult partiallyRefundPayment(long commerceOrderId)

postProcessPayment

CommercePaymentResult postProcessPayment(long commerceOrderId)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

processPayment

CommercePaymentResult processPayment(long commerceOrderId,
                                     java.lang.String nextUrl,
                                     javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws java.lang.Exception

Throws:

java.lang.Exception

processRecurringPayment

@Deprecated
CommercePaymentResult processRecurringPayment(long commerceOrderId,
                                                          java.lang.String nextUrl,
                                                          javax.servlet.http.HttpServletRequest httpServletRequest)
                                                   throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine

Parameters:

commerceOrderId -

nextUrl -

httpServletRequest -

Returns:

Throws:

java.lang.Exception

refundPayment

CommercePaymentResult refundPayment(long commerceOrderId,
                                    java.lang.String transactionId,
                                    javax.servlet.http.HttpServletRequest httpServletRequest)
                             throws java.lang.Exception

Throws:

java.lang.Exception

startPayment

CommercePaymentResult startPayment(long commerceOrderId,
                                   java.lang.String checkoutStepUrl,
                                   javax.servlet.http.HttpServletRequest httpServletRequest)
                            throws java.lang.Exception

Throws:

java.lang.Exception

suspendSubscription

@Deprecated
boolean suspendSubscription(long commerceSubscriptionEntryId)
                                 throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), this method is being moved to Subscription Engine

Parameters:

commerceSubscriptionEntryId -

Returns:

Throws:

java.lang.Exception

updateOrderPaymentStatus

CommerceOrder updateOrderPaymentStatus(long commerceOrderId,
                                       int paymentStatus,
                                       java.lang.String transactionId)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

voidTransaction

CommercePaymentResult voidTransaction(long commerceOrderId,
                                      java.lang.String transactionId,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)
                               throws java.lang.Exception

Throws:

java.lang.Exception