com.mangopay.core.APIs.KycDocumentApi 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

There is a newer version: 2.42.0

package com.mangopay.core.APIs;

import com.mangopay.core.DocumentPageConsult;
import com.mangopay.core.Pagination;
import com.mangopay.core.Sorting;
import com.mangopay.entities.KycDocument;

import java.util.List;

/**
 * Created by thepa on 18-Jan-17.
 */
public interface KycDocumentApi {
    /**
     * Gets all KYC documents.
     * @param pagination    Pagination object.
     * @param sorting       Sorting object.
     * @return              Collection of KycDocuments returned from API.
     * @throws Exception
     */
    List getAll(Pagination pagination, Sorting sorting) throws Exception;

    /**
     * Gets KYC document.
     * @param kycDocumentId KYC document identifier.
     * @return              KYC document returned from API.
     * @throws Exception
     */
    KycDocument getKycDocument(String kycDocumentId) throws Exception;

    /**
     * Creates temporary URLs where each page of a KYC document can be viewed.
     *
     * @param kycDocumentId Identification of the document whose pages to view
     * @throws Exception
     */
    List createKycDocumentConsult(String kycDocumentId) throws Exception;
}