com.logicommerce.sdk.services.PaymentService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation

SDK for developing Logicommerce plugins.

There is a newer version: 2.1.1

package com.logicommerce.sdk.services;

import java.util.List;
import com.logicommerce.sdk.models.RequestParams;
import com.logicommerce.sdk.models.order.Order;
import com.logicommerce.sdk.models.payment.Payment;
import com.logicommerce.sdk.models.payment.PaymentToken;
import com.logicommerce.sdk.models.payment.PaymentValidateResponse;

/**
 * PaymentService interface.
 *
 * @author Logicommerce
 * @since 1.0.16
 */
public interface PaymentService extends PluginService {

	/**
	 * getPayment.
	 *
	 * @param order a {@link com.logicommerce.sdk.models.order.Order} object
	 * @param transactionId a {@link java.lang.String} object
	 * @return a {@link com.logicommerce.sdk.models.payment.Payment} object
	 * @throws com.logicommerce.sdk.services.PluginServiceException if any.
	 */
	Payment getPayment(Order order, String transactionId) throws PluginServiceException;

	/**
	 * validate.
	 *
	 * @param order a {@link com.logicommerce.sdk.models.order.Order} object
	 * @param requestParams a {@link com.logicommerce.sdk.models.RequestParams} object
	 * @return a {@link com.logicommerce.sdk.models.payment.PaymentValidateResponse} object
	 * @throws com.logicommerce.sdk.services.PluginServiceException if any.
	 */
	PaymentValidateResponse validate(Order order, RequestParams requestParams) throws PluginServiceException;

	/**
	 * getPaymentTokens.
	 *
	 * @return a {@link java.util.List} object
	 */
	List getPaymentTokens();

	/**
	 * deletePaymentToken.
	 *
	 * @param token a {@link java.lang.String} object
	 */
	void deletePaymentToken(String token);

}