com.commercetools.payment.model.CreatePaymentData Maven / Gradle / Ivy

Go to download

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

The commercetools java payment project intend is to make payment integration easy

The newest version!

package com.commercetools.payment.model;

import com.commercetools.payment.domain.PaymentServiceProvider;
import io.sphere.sdk.carts.Cart;
import io.sphere.sdk.customers.Customer;
import io.sphere.sdk.payments.PaymentMethodInfo;

import java.util.Optional;

/**
 * Provides a wrapper for all data that could possibly be needed by a {@link PaymentServiceProvider} implementation
 * to create a new payment object.
 *
 * Created by mgatz on 7/18/16.
 */
public interface CreatePaymentData extends PaymentInteractionData {

    /**
     * @return the {@link PaymentMethodInfo} the {@link io.sphere.sdk.payments.Payment} object should be created for
     */
    PaymentMethodInfo getPaymentMethodinInfo();

    /**
     * @return the cart object that is needed to create a payment for
     */
    Cart getCart();

    /**
     * @return the reference number that is unique for the whole payment process
     */
    String getReference();

    /**
     * @return the attached customer
     */
    Optional getCustomer();

    /**
     * @return the HTTP client request data wrapper
     */
    Optional getHttpRequestInfo();
}