Package com.adyen.service.legalentitymanagement

Class DocumentsApi

java.lang.Object

com.adyen.Service

com.adyen.service.legalentitymanagement.DocumentsApi

public class DocumentsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
DocumentsApi(Client client)	Documents constructor in package.
DocumentsApi(Client client, String baseURL)	Documents constructor in package.

Method Summary

Modifier and Type	Method	Description
void	deleteDocument(String id)	Delete a document
void	deleteDocument(String id, RequestOptions requestOptions)	Delete a document
Document	getDocument(String id)	Get a document
Document	getDocument(String id, Boolean skipContent, RequestOptions requestOptions)	Get a document
Document	updateDocument(String id, Document document)	Update a document
Document	updateDocument(String id, Document document, RequestOptions requestOptions)	Update a document
Document	uploadDocumentForVerificationChecks(Document document)	Upload a document for verification checks
Document	uploadDocumentForVerificationChecks(Document document, RequestOptions requestOptions)	Upload a document for verification checks

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

DocumentsApi

public DocumentsApi(Client client)

Documents constructor in package.

Parameters:

client - Client (required)

DocumentsApi

public DocumentsApi(Client client,
                    String baseURL)

Documents constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

deleteDocument

public void deleteDocument(String id)
                    throws ApiException,
                           IOException

Delete a document

Parameters:

id - String The unique identifier of the document to be deleted. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteDocument

public void deleteDocument(String id,
                           RequestOptions requestOptions)
                    throws ApiException,
                           IOException

Delete a document

Parameters:

id - String The unique identifier of the document to be deleted. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Throws:

ApiException - if fails to make API call

IOException

getDocument

public Document getDocument(String id)
                     throws ApiException,
                            IOException

Get a document

Parameters:

id - String The unique identifier of the document. (required)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException

getDocument

public Document getDocument(String id,
                            Boolean skipContent,
                            RequestOptions requestOptions)
                     throws ApiException,
                            IOException

Get a document

Parameters:

id - String The unique identifier of the document. (required)

skipContent - Boolean Query: Do not load document content while fetching the document. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException

updateDocument

public Document updateDocument(String id,
                               Document document)
                        throws ApiException,
                               IOException

Update a document

Parameters:

id - String The unique identifier of the document to be updated. (required)

document - Document (required)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException

updateDocument

public Document updateDocument(String id,
                               Document document,
                               RequestOptions requestOptions)
                        throws ApiException,
                               IOException

Update a document

Parameters:

id - String The unique identifier of the document to be updated. (required)

document - Document (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException

uploadDocumentForVerificationChecks

public Document uploadDocumentForVerificationChecks(Document document)
                                             throws ApiException,
                                                    IOException

Upload a document for verification checks

Parameters:

document - Document (required)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException

uploadDocumentForVerificationChecks

public Document uploadDocumentForVerificationChecks(Document document,
                                                    RequestOptions requestOptions)
                                             throws ApiException,
                                                    IOException

Upload a document for verification checks

Parameters:

document - Document (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Document

Throws:

ApiException - if fails to make API call

IOException