Package com.adyen.service.legalentitymanagement

Class LegalEntitiesApi

java.lang.Object

com.adyen.Service

com.adyen.service.legalentitymanagement.LegalEntitiesApi

public class LegalEntitiesApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
LegalEntitiesApi(Client client)	Legal entities constructor in package.
LegalEntitiesApi(Client client, String baseURL)	Legal entities constructor in package.

Method Summary

Modifier and Type	Method	Description
VerificationErrors	checkLegalEntitysVerificationErrors(String id)	Check a legal entity's verification errors
VerificationErrors	checkLegalEntitysVerificationErrors(String id, RequestOptions requestOptions)	Check a legal entity's verification errors
LegalEntity	createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType)	Create a legal entity
LegalEntity	createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType, RequestOptions requestOptions)	Create a legal entity
BusinessLines	getAllBusinessLinesUnderLegalEntity(String id)	Get all business lines under a legal entity
BusinessLines	getAllBusinessLinesUnderLegalEntity(String id, RequestOptions requestOptions)	Get all business lines under a legal entity
LegalEntity	getLegalEntity(String id)	Get a legal entity
LegalEntity	getLegalEntity(String id, RequestOptions requestOptions)	Get a legal entity
LegalEntity	updateLegalEntity(String id, LegalEntityInfo legalEntityInfo)	Update a legal entity
LegalEntity	updateLegalEntity(String id, LegalEntityInfo legalEntityInfo, RequestOptions requestOptions)	Update a legal entity

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

LegalEntitiesApi

public LegalEntitiesApi(Client client)

Legal entities constructor in package.

Parameters:

client - Client (required)

LegalEntitiesApi

public LegalEntitiesApi(Client client,
                        String baseURL)

Legal entities 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

getLegalEntity

public LegalEntity getLegalEntity(String id)
                           throws ApiException,
                                  IOException

Get a legal entity

Parameters:

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

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

getLegalEntity

public LegalEntity getLegalEntity(String id,
                                  RequestOptions requestOptions)
                           throws ApiException,
                                  IOException

Get a legal entity

Parameters:

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

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

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

getAllBusinessLinesUnderLegalEntity

public BusinessLines getAllBusinessLinesUnderLegalEntity(String id)
                                                  throws ApiException,
                                                         IOException

Get all business lines under a legal entity

Parameters:

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

Returns:

BusinessLines

Throws:

ApiException - if fails to make API call

IOException

getAllBusinessLinesUnderLegalEntity

public BusinessLines getAllBusinessLinesUnderLegalEntity(String id,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Get all business lines under a legal entity

Parameters:

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

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

Returns:

BusinessLines

Throws:

ApiException - if fails to make API call

IOException

updateLegalEntity

public LegalEntity updateLegalEntity(String id,
                                     LegalEntityInfo legalEntityInfo)
                              throws ApiException,
                                     IOException

Update a legal entity

Parameters:

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

legalEntityInfo - LegalEntityInfo (required)

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

updateLegalEntity

public LegalEntity updateLegalEntity(String id,
                                     LegalEntityInfo legalEntityInfo,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Update a legal entity

Parameters:

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

legalEntityInfo - LegalEntityInfo (required)

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

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

createLegalEntity

public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType)
                              throws ApiException,
                                     IOException

Create a legal entity

Parameters:

legalEntityInfoRequiredType - LegalEntityInfoRequiredType (required)

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

createLegalEntity

public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Create a legal entity

Parameters:

legalEntityInfoRequiredType - LegalEntityInfoRequiredType (required)

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

Returns:

LegalEntity

Throws:

ApiException - if fails to make API call

IOException

checkLegalEntitysVerificationErrors

public VerificationErrors checkLegalEntitysVerificationErrors(String id)
                                                       throws ApiException,
                                                              IOException

Check a legal entity's verification errors

Parameters:

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

Returns:

VerificationErrors

Throws:

ApiException - if fails to make API call

IOException

checkLegalEntitysVerificationErrors

public VerificationErrors checkLegalEntitysVerificationErrors(String id,
                                                              RequestOptions requestOptions)
                                                       throws ApiException,
                                                              IOException

Check a legal entity's verification errors

Parameters:

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

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

Returns:

VerificationErrors

Throws:

ApiException - if fails to make API call

IOException