com.mangopay.core.APIs.TransferApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mangopay2-java-sdk Show documentation
Java SDK for Mangopay
The newest version!
package com.mangopay.core.APIs;

import com.mangopay.core.Pagination;
import com.mangopay.core.Sorting;
import com.mangopay.entities.Refund;
import com.mangopay.entities.Transfer;

import java.util.List;

/**
 * Created by thepa on 18-Jan-17.
 */
public interface TransferApi {
    /**
     * Creates new transfer.
     * @param transfer  Instance of Transfer class to be created.
     * @return          Transfer object returned from API.
     * @throws Exception
     */
    Transfer create(Transfer transfer) throws Exception;

    /**
     * Creates new transfer.
     * @param idempotencyKey    idempotency key for this request.
     * @param transfer          Instance of Transfer class to be created.
     * @return                  Transfer object returned from API.
     * @throws Exception
     */
    Transfer create(String idempotencyKey, Transfer transfer) throws Exception;

    /**
     * Gets the transfer.
     * @param transferId    Transfer identifier.
     * @return              Transfer instance returned from API.
     * @throws Exception
     */
    Transfer get(String transferId) throws Exception;

    /**
     * Creates refund for transfer object.
     * @param transferId Transfer identifier.
     * @param refund Refund object to create.
     * @return Refund entity instance returned from API.
     * @throws Exception
     */
    Refund createRefund(String transferId, Refund refund) throws Exception;

    /**
     * Creates refund for transfer object.
     * @param idempotencyKey    idempotency key for this request.
     * @param transferId        Transfer identifier.
     * @param refund            Refund object to create.
     * @return Refund entity instance returned from API.
     * @throws Exception
     */
    Refund createRefund(String idempotencyKey, String transferId, Refund refund) throws Exception;

    /**
     * Gets refund for transfer object.
     * @param transferId Transfer identifier.
     * @return Refund entity instance returned from API.
     * @throws Exception
     */
    Refund getRefund(String transferId) throws Exception;

    /**
     * Get first page of transfer's refunds
     * @param transferId Transfer identifier
     * @return Collection of transfer refunds
     * @throws Exception
     */
    List getRefunds(String transferId) throws Exception;

    /**
     * Get a page of transfer's refunds
     * @param transferId Transfer identifier
     * @param pagination Pagination object
     * @param sorting Sorting object
     * @return Collection of refunds
     * @throws Exception
     */
    List getRefunds(String transferId, Pagination pagination, Sorting sorting) throws Exception;
}