Package com.adyen.service.classicplatforms

Class ClassicPlatformAccountApi

java.lang.Object

com.adyen.Service

com.adyen.service.classicplatforms.ClassicPlatformAccountApi

public class ClassicPlatformAccountApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ClassicPlatformAccountApi(Client client)	Verification constructor in package.
ClassicPlatformAccountApi(Client client, String baseURL)	Verification constructor in package.

Method Summary

Modifier and Type	Method	Description
GenericResponse	checkAccountHolder(PerformVerificationRequest performVerificationRequest)	Trigger verification
GenericResponse	checkAccountHolder(PerformVerificationRequest performVerificationRequest, RequestOptions requestOptions)	Trigger verification
CloseAccountResponse	closeAccount(CloseAccountRequest closeAccountRequest)	Close an account
CloseAccountResponse	closeAccount(CloseAccountRequest closeAccountRequest, RequestOptions requestOptions)	Close an account
CloseAccountHolderResponse	closeAccountHolder(CloseAccountHolderRequest closeAccountHolderRequest)	Close an account holder
CloseAccountHolderResponse	closeAccountHolder(CloseAccountHolderRequest closeAccountHolderRequest, RequestOptions requestOptions)	Close an account holder
GenericResponse	closeStores(CloseStoresRequest closeStoresRequest)	Close stores
GenericResponse	closeStores(CloseStoresRequest closeStoresRequest, RequestOptions requestOptions)	Close stores
CreateAccountResponse	createAccount(CreateAccountRequest createAccountRequest)	Create an account
CreateAccountResponse	createAccount(CreateAccountRequest createAccountRequest, RequestOptions requestOptions)	Create an account
CreateAccountHolderResponse	createAccountHolder(CreateAccountHolderRequest createAccountHolderRequest)	Create an account holder
CreateAccountHolderResponse	createAccountHolder(CreateAccountHolderRequest createAccountHolderRequest, RequestOptions requestOptions)	Create an account holder
GenericResponse	deleteBankAccounts(DeleteBankAccountRequest deleteBankAccountRequest)	Delete bank accounts
GenericResponse	deleteBankAccounts(DeleteBankAccountRequest deleteBankAccountRequest, RequestOptions requestOptions)	Delete bank accounts
GenericResponse	deleteLegalArrangements(DeleteLegalArrangementRequest deleteLegalArrangementRequest)	Delete legal arrangements
GenericResponse	deleteLegalArrangements(DeleteLegalArrangementRequest deleteLegalArrangementRequest, RequestOptions requestOptions)	Delete legal arrangements
GenericResponse	deletePayoutMethods(DeletePayoutMethodRequest deletePayoutMethodRequest)	Delete payout methods
GenericResponse	deletePayoutMethods(DeletePayoutMethodRequest deletePayoutMethodRequest, RequestOptions requestOptions)	Delete payout methods
GenericResponse	deleteShareholders(DeleteShareholderRequest deleteShareholderRequest)	Delete shareholders
GenericResponse	deleteShareholders(DeleteShareholderRequest deleteShareholderRequest, RequestOptions requestOptions)	Delete shareholders
GenericResponse	deleteSignatories(DeleteSignatoriesRequest deleteSignatoriesRequest)	Delete signatories
GenericResponse	deleteSignatories(DeleteSignatoriesRequest deleteSignatoriesRequest, RequestOptions requestOptions)	Delete signatories
GetAccountHolderResponse	getAccountHolder(GetAccountHolderRequest getAccountHolderRequest)	Get an account holder
GetAccountHolderResponse	getAccountHolder(GetAccountHolderRequest getAccountHolderRequest, RequestOptions requestOptions)	Get an account holder
GetTaxFormResponse	getTaxForm(GetTaxFormRequest getTaxFormRequest)	Get a tax form
GetTaxFormResponse	getTaxForm(GetTaxFormRequest getTaxFormRequest, RequestOptions requestOptions)	Get a tax form
GetUploadedDocumentsResponse	getUploadedDocuments(GetUploadedDocumentsRequest getUploadedDocumentsRequest)	Get documents
GetUploadedDocumentsResponse	getUploadedDocuments(GetUploadedDocumentsRequest getUploadedDocumentsRequest, RequestOptions requestOptions)	Get documents
SuspendAccountHolderResponse	suspendAccountHolder(SuspendAccountHolderRequest suspendAccountHolderRequest)	Suspend an account holder
SuspendAccountHolderResponse	suspendAccountHolder(SuspendAccountHolderRequest suspendAccountHolderRequest, RequestOptions requestOptions)	Suspend an account holder
UnSuspendAccountHolderResponse	unSuspendAccountHolder(UnSuspendAccountHolderRequest unSuspendAccountHolderRequest)	Unsuspend an account holder
UnSuspendAccountHolderResponse	unSuspendAccountHolder(UnSuspendAccountHolderRequest unSuspendAccountHolderRequest, RequestOptions requestOptions)	Unsuspend an account holder
UpdateAccountResponse	updateAccount(UpdateAccountRequest updateAccountRequest)	Update an account
UpdateAccountResponse	updateAccount(UpdateAccountRequest updateAccountRequest, RequestOptions requestOptions)	Update an account
UpdateAccountHolderResponse	updateAccountHolder(UpdateAccountHolderRequest updateAccountHolderRequest)	Update an account holder
UpdateAccountHolderResponse	updateAccountHolder(UpdateAccountHolderRequest updateAccountHolderRequest, RequestOptions requestOptions)	Update an account holder
GetAccountHolderStatusResponse	updateAccountHolderState(UpdateAccountHolderStateRequest updateAccountHolderStateRequest)	Update payout or processing state
GetAccountHolderStatusResponse	updateAccountHolderState(UpdateAccountHolderStateRequest updateAccountHolderStateRequest, RequestOptions requestOptions)	Update payout or processing state
UpdateAccountHolderResponse	uploadDocument(UploadDocumentRequest uploadDocumentRequest)	Upload a document
UpdateAccountHolderResponse	uploadDocument(UploadDocumentRequest uploadDocumentRequest, RequestOptions requestOptions)	Upload a document

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

ClassicPlatformAccountApi

public ClassicPlatformAccountApi(Client client)

Verification constructor in package.

Parameters:

client - Client (required)

ClassicPlatformAccountApi

public ClassicPlatformAccountApi(Client client,
                                 String baseURL)

Verification 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

checkAccountHolder

public GenericResponse checkAccountHolder(PerformVerificationRequest performVerificationRequest)
                                   throws ApiException,
                                          IOException

Trigger verification

Parameters:

performVerificationRequest - PerformVerificationRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

checkAccountHolder

public GenericResponse checkAccountHolder(PerformVerificationRequest performVerificationRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Trigger verification

Parameters:

performVerificationRequest - PerformVerificationRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

closeAccount

public CloseAccountResponse closeAccount(CloseAccountRequest closeAccountRequest)
                                  throws ApiException,
                                         IOException

Close an account

Parameters:

closeAccountRequest - CloseAccountRequest (required)

Returns:

CloseAccountResponse

Throws:

ApiException - if fails to make API call

IOException

closeAccount

public CloseAccountResponse closeAccount(CloseAccountRequest closeAccountRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Close an account

Parameters:

closeAccountRequest - CloseAccountRequest (required)

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

Returns:

CloseAccountResponse

Throws:

ApiException - if fails to make API call

IOException

closeAccountHolder

public CloseAccountHolderResponse closeAccountHolder(CloseAccountHolderRequest closeAccountHolderRequest)
                                              throws ApiException,
                                                     IOException

Close an account holder

Parameters:

closeAccountHolderRequest - CloseAccountHolderRequest (required)

Returns:

CloseAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

closeAccountHolder

public CloseAccountHolderResponse closeAccountHolder(CloseAccountHolderRequest closeAccountHolderRequest,
                                                     RequestOptions requestOptions)
                                              throws ApiException,
                                                     IOException

Close an account holder

Parameters:

closeAccountHolderRequest - CloseAccountHolderRequest (required)

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

Returns:

CloseAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

closeStores

public GenericResponse closeStores(CloseStoresRequest closeStoresRequest)
                            throws ApiException,
                                   IOException

Close stores

Parameters:

closeStoresRequest - CloseStoresRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

closeStores

public GenericResponse closeStores(CloseStoresRequest closeStoresRequest,
                                   RequestOptions requestOptions)
                            throws ApiException,
                                   IOException

Close stores

Parameters:

closeStoresRequest - CloseStoresRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

createAccount

public CreateAccountResponse createAccount(CreateAccountRequest createAccountRequest)
                                    throws ApiException,
                                           IOException

Create an account

Parameters:

createAccountRequest - CreateAccountRequest (required)

Returns:

CreateAccountResponse

Throws:

ApiException - if fails to make API call

IOException

createAccount

public CreateAccountResponse createAccount(CreateAccountRequest createAccountRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Create an account

Parameters:

createAccountRequest - CreateAccountRequest (required)

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

Returns:

CreateAccountResponse

Throws:

ApiException - if fails to make API call

IOException

createAccountHolder

public CreateAccountHolderResponse createAccountHolder(CreateAccountHolderRequest createAccountHolderRequest)
                                                throws ApiException,
                                                       IOException

Create an account holder

Parameters:

createAccountHolderRequest - CreateAccountHolderRequest (required)

Returns:

CreateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

createAccountHolder

public CreateAccountHolderResponse createAccountHolder(CreateAccountHolderRequest createAccountHolderRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Create an account holder

Parameters:

createAccountHolderRequest - CreateAccountHolderRequest (required)

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

Returns:

CreateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

deleteBankAccounts

public GenericResponse deleteBankAccounts(DeleteBankAccountRequest deleteBankAccountRequest)
                                   throws ApiException,
                                          IOException

Delete bank accounts

Parameters:

deleteBankAccountRequest - DeleteBankAccountRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteBankAccounts

public GenericResponse deleteBankAccounts(DeleteBankAccountRequest deleteBankAccountRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Delete bank accounts

Parameters:

deleteBankAccountRequest - DeleteBankAccountRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteLegalArrangements

public GenericResponse deleteLegalArrangements(DeleteLegalArrangementRequest deleteLegalArrangementRequest)
                                        throws ApiException,
                                               IOException

Delete legal arrangements

Parameters:

deleteLegalArrangementRequest - DeleteLegalArrangementRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteLegalArrangements

public GenericResponse deleteLegalArrangements(DeleteLegalArrangementRequest deleteLegalArrangementRequest,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Delete legal arrangements

Parameters:

deleteLegalArrangementRequest - DeleteLegalArrangementRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deletePayoutMethods

public GenericResponse deletePayoutMethods(DeletePayoutMethodRequest deletePayoutMethodRequest)
                                    throws ApiException,
                                           IOException

Delete payout methods

Parameters:

deletePayoutMethodRequest - DeletePayoutMethodRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deletePayoutMethods

public GenericResponse deletePayoutMethods(DeletePayoutMethodRequest deletePayoutMethodRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Delete payout methods

Parameters:

deletePayoutMethodRequest - DeletePayoutMethodRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteShareholders

public GenericResponse deleteShareholders(DeleteShareholderRequest deleteShareholderRequest)
                                   throws ApiException,
                                          IOException

Delete shareholders

Parameters:

deleteShareholderRequest - DeleteShareholderRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteShareholders

public GenericResponse deleteShareholders(DeleteShareholderRequest deleteShareholderRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Delete shareholders

Parameters:

deleteShareholderRequest - DeleteShareholderRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteSignatories

public GenericResponse deleteSignatories(DeleteSignatoriesRequest deleteSignatoriesRequest)
                                  throws ApiException,
                                         IOException

Delete signatories

Parameters:

deleteSignatoriesRequest - DeleteSignatoriesRequest (required)

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

deleteSignatories

public GenericResponse deleteSignatories(DeleteSignatoriesRequest deleteSignatoriesRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Delete signatories

Parameters:

deleteSignatoriesRequest - DeleteSignatoriesRequest (required)

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

Returns:

GenericResponse

Throws:

ApiException - if fails to make API call

IOException

getAccountHolder

public GetAccountHolderResponse getAccountHolder(GetAccountHolderRequest getAccountHolderRequest)
                                          throws ApiException,
                                                 IOException

Get an account holder

Parameters:

getAccountHolderRequest - GetAccountHolderRequest (required)

Returns:

GetAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

getAccountHolder

public GetAccountHolderResponse getAccountHolder(GetAccountHolderRequest getAccountHolderRequest,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get an account holder

Parameters:

getAccountHolderRequest - GetAccountHolderRequest (required)

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

Returns:

GetAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

getTaxForm

public GetTaxFormResponse getTaxForm(GetTaxFormRequest getTaxFormRequest)
                              throws ApiException,
                                     IOException

Get a tax form

Parameters:

getTaxFormRequest - GetTaxFormRequest (required)

Returns:

GetTaxFormResponse

Throws:

ApiException - if fails to make API call

IOException

getTaxForm

public GetTaxFormResponse getTaxForm(GetTaxFormRequest getTaxFormRequest,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Get a tax form

Parameters:

getTaxFormRequest - GetTaxFormRequest (required)

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

Returns:

GetTaxFormResponse

Throws:

ApiException - if fails to make API call

IOException

getUploadedDocuments

public GetUploadedDocumentsResponse getUploadedDocuments(GetUploadedDocumentsRequest getUploadedDocumentsRequest)
                                                  throws ApiException,
                                                         IOException

Get documents

Parameters:

getUploadedDocumentsRequest - GetUploadedDocumentsRequest (required)

Returns:

GetUploadedDocumentsResponse

Throws:

ApiException - if fails to make API call

IOException

getUploadedDocuments

public GetUploadedDocumentsResponse getUploadedDocuments(GetUploadedDocumentsRequest getUploadedDocumentsRequest,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Get documents

Parameters:

getUploadedDocumentsRequest - GetUploadedDocumentsRequest (required)

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

Returns:

GetUploadedDocumentsResponse

Throws:

ApiException - if fails to make API call

IOException

suspendAccountHolder

public SuspendAccountHolderResponse suspendAccountHolder(SuspendAccountHolderRequest suspendAccountHolderRequest)
                                                  throws ApiException,
                                                         IOException

Suspend an account holder

Parameters:

suspendAccountHolderRequest - SuspendAccountHolderRequest (required)

Returns:

SuspendAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

suspendAccountHolder

public SuspendAccountHolderResponse suspendAccountHolder(SuspendAccountHolderRequest suspendAccountHolderRequest,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Suspend an account holder

Parameters:

suspendAccountHolderRequest - SuspendAccountHolderRequest (required)

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

Returns:

SuspendAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

unSuspendAccountHolder

public UnSuspendAccountHolderResponse unSuspendAccountHolder(UnSuspendAccountHolderRequest unSuspendAccountHolderRequest)
                                                      throws ApiException,
                                                             IOException

Unsuspend an account holder

Parameters:

unSuspendAccountHolderRequest - UnSuspendAccountHolderRequest (required)

Returns:

UnSuspendAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

unSuspendAccountHolder

public UnSuspendAccountHolderResponse unSuspendAccountHolder(UnSuspendAccountHolderRequest unSuspendAccountHolderRequest,
                                                             RequestOptions requestOptions)
                                                      throws ApiException,
                                                             IOException

Unsuspend an account holder

Parameters:

unSuspendAccountHolderRequest - UnSuspendAccountHolderRequest (required)

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

Returns:

UnSuspendAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccount

public UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest)
                                    throws ApiException,
                                           IOException

Update an account

Parameters:

updateAccountRequest - UpdateAccountRequest (required)

Returns:

UpdateAccountResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccount

public UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Update an account

Parameters:

updateAccountRequest - UpdateAccountRequest (required)

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

Returns:

UpdateAccountResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolder

public UpdateAccountHolderResponse updateAccountHolder(UpdateAccountHolderRequest updateAccountHolderRequest)
                                                throws ApiException,
                                                       IOException

Update an account holder

Parameters:

updateAccountHolderRequest - UpdateAccountHolderRequest (required)

Returns:

UpdateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolder

public UpdateAccountHolderResponse updateAccountHolder(UpdateAccountHolderRequest updateAccountHolderRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Update an account holder

Parameters:

updateAccountHolderRequest - UpdateAccountHolderRequest (required)

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

Returns:

UpdateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolderState

public GetAccountHolderStatusResponse updateAccountHolderState(UpdateAccountHolderStateRequest updateAccountHolderStateRequest)
                                                        throws ApiException,
                                                               IOException

Update payout or processing state

Parameters:

updateAccountHolderStateRequest - UpdateAccountHolderStateRequest (required)

Returns:

GetAccountHolderStatusResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolderState

public GetAccountHolderStatusResponse updateAccountHolderState(UpdateAccountHolderStateRequest updateAccountHolderStateRequest,
                                                               RequestOptions requestOptions)
                                                        throws ApiException,
                                                               IOException

Update payout or processing state

Parameters:

updateAccountHolderStateRequest - UpdateAccountHolderStateRequest (required)

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

Returns:

GetAccountHolderStatusResponse

Throws:

ApiException - if fails to make API call

IOException

uploadDocument

public UpdateAccountHolderResponse uploadDocument(UploadDocumentRequest uploadDocumentRequest)
                                           throws ApiException,
                                                  IOException

Upload a document

Parameters:

uploadDocumentRequest - UploadDocumentRequest (required)

Returns:

UpdateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException

uploadDocument

public UpdateAccountHolderResponse uploadDocument(UploadDocumentRequest uploadDocumentRequest,
                                                  RequestOptions requestOptions)
                                           throws ApiException,
                                                  IOException

Upload a document

Parameters:

uploadDocumentRequest - UploadDocumentRequest (required)

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

Returns:

UpdateAccountHolderResponse

Throws:

ApiException - if fails to make API call

IOException