com.secutix.plugin.paymentintegration.service

Interface ExternalPaymentService

All Known Implementing Classes:

ExternalPaymentServiceEmpty

public interface ExternalPaymentService

This interface appointed for calling a facade for public Web Service ExternalPaymentService For more detail information about Web Service, please refer to the link of API documentation below

See Also:

ExternalPaymentService_v1_23

Method Summary

Modifier and Type	Method and Description
default PaymentDetailResult	createPayment(Integer requestId, Long orderId, List<PaymentInfo> payments, PaymentParameters paymentParams) Create payment with specified parameters.
default Optional<Long>	getPaymentMethodIdFromCode(String paymentMethodCode) Utility method allowing to extract a payment method id from a code.
PaymentDetailResult	searchPaymentsByCriteria(Integer requestId, SearchPaymentsCriteria searchPaymentsCriteria, Integer minIndex, Integer nbMaxResults) Allows to search payments according to a criteria.
default PaymentDetailResult	updatePayments(Integer requestId, Long orderId, List<PaymentDetail> payments)

Method Detail

searchPaymentsByCriteria

PaymentDetailResult searchPaymentsByCriteria(Integer requestId,
                                             SearchPaymentsCriteria searchPaymentsCriteria,
                                             Integer minIndex,
                                             Integer nbMaxResults)

Allows to search payments according to a criteria.

Parameters:

requestId - Request Id as Integer

searchPaymentsCriteria - SearchPaymentsCriteria

minIndex - Maximal index as Integer

nbMaxResults - Maximal results as Integer

Returns:

PaymentDetailResult

createPayment

default PaymentDetailResult createPayment(Integer requestId,
                                          Long orderId,
                                          List<PaymentInfo> payments,
                                          PaymentParameters paymentParams)

Create payment with specified parameters.

Parameters:

orderId - Order Id

requestId - Request Id

payments - List of PaymentInfo

paymentParams - PaymentParameters

Returns:

PaymentDetailResult

getPaymentMethodIdFromCode

default Optional<Long> getPaymentMethodIdFromCode(String paymentMethodCode)

Utility method allowing to extract a payment method id from a code. Not referenced in service.

Parameters:

paymentMethodCode - Payment method code as String

Returns:

Optional object

updatePayments

default PaymentDetailResult updatePayments(Integer requestId,
                                           Long orderId,
                                           List<PaymentDetail> payments)