com.mangopay.core.APIs.implementation

Class KycDocumentApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.KycDocumentApiImpl

All Implemented Interfaces:

KycDocumentApi

public class KycDocumentApiImpl
extends ApiBase
implements KycDocumentApi

API for KycDocuments.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
KycDocumentApiImpl(MangoPayApi root) Instantiates new KycDocumentApiImpl object.

Method Summary

Modifier and Type	Method and Description
java.util.List<DocumentPageConsult>	createKycDocumentConsult(java.lang.String kycDocumentId) Creates temporary URLs where each page of a KYC document can be viewed.
java.util.List<KycDocument>	getAll(Pagination pagination, Sorting sorting) Gets all KYC documents.
KycDocument	getKycDocument(java.lang.String kycDocumentId) Gets KYC document.

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KycDocumentApiImpl

public KycDocumentApiImpl(MangoPayApi root)

Instantiates new KycDocumentApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance

Method Detail

getAll

public java.util.List<KycDocument> getAll(Pagination pagination,
                                          Sorting sorting)
                                   throws java.lang.Exception

Description copied from interface: KycDocumentApi

Gets all KYC documents.

Specified by:

getAll in interface KycDocumentApi

Parameters:

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of KycDocuments returned from API.

Throws:

java.lang.Exception

getKycDocument

public KycDocument getKycDocument(java.lang.String kycDocumentId)
                           throws java.lang.Exception

Description copied from interface: KycDocumentApi

Gets KYC document.

Specified by:

getKycDocument in interface KycDocumentApi

Parameters:

kycDocumentId - KYC document identifier.

Returns:

KYC document returned from API.

Throws:

java.lang.Exception

createKycDocumentConsult

public java.util.List<DocumentPageConsult> createKycDocumentConsult(java.lang.String kycDocumentId)
                                                             throws java.lang.Exception

Description copied from interface: KycDocumentApi

Creates temporary URLs where each page of a KYC document can be viewed.

Specified by:

createKycDocumentConsult in interface KycDocumentApi

Parameters:

kycDocumentId - Identification of the document whose pages to view

Throws:

java.lang.Exception