Package com.adyen.service.management

Class AccountCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.AccountCompanyLevelApi

public class AccountCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
AccountCompanyLevelApi(Client client)	Account - company level constructor in package.
AccountCompanyLevelApi(Client client, String baseURL)	Account - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
Company	getCompanyAccount(String companyId)	Get a company account
Company	getCompanyAccount(String companyId, RequestOptions requestOptions)	Get a company account
ListCompanyResponse	listCompanyAccounts()	Get a list of company accounts
ListCompanyResponse	listCompanyAccounts(Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of company accounts
ListMerchantResponse	listMerchantAccounts(String companyId)	Get a list of merchant accounts
ListMerchantResponse	listMerchantAccounts(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of merchant accounts

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

AccountCompanyLevelApi

public AccountCompanyLevelApi(Client client)

Account - company level constructor in package.

Parameters:

client - Client (required)

AccountCompanyLevelApi

public AccountCompanyLevelApi(Client client,
                              String baseURL)

Account - company level 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

getCompanyAccount

public Company getCompanyAccount(String companyId)
                          throws ApiException,
                                 IOException

Get a company account

Parameters:

companyId - String The unique identifier of the company account. (required)

Returns:

Company

Throws:

ApiException - if fails to make API call

IOException

getCompanyAccount

public Company getCompanyAccount(String companyId,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Get a company account

Parameters:

companyId - String The unique identifier of the company account. (required)

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

Returns:

Company

Throws:

ApiException - if fails to make API call

IOException

listCompanyAccounts

public ListCompanyResponse listCompanyAccounts()
                                        throws ApiException,
                                               IOException

Get a list of company accounts

Returns:

ListCompanyResponse

Throws:

ApiException - if fails to make API call

IOException

listCompanyAccounts

public ListCompanyResponse listCompanyAccounts(Integer pageNumber,
                                               Integer pageSize,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Get a list of company accounts

Parameters:

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

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

Returns:

ListCompanyResponse

Throws:

ApiException - if fails to make API call

IOException

listMerchantAccounts

public ListMerchantResponse listMerchantAccounts(String companyId)
                                          throws ApiException,
                                                 IOException

Get a list of merchant accounts

Parameters:

companyId - String The unique identifier of the company account. (required)

Returns:

ListMerchantResponse

Throws:

ApiException - if fails to make API call

IOException

listMerchantAccounts

public ListMerchantResponse listMerchantAccounts(String companyId,
                                                 Integer pageNumber,
                                                 Integer pageSize,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of merchant accounts

Parameters:

companyId - String The unique identifier of the company account. (required)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

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

Returns:

ListMerchantResponse

Throws:

ApiException - if fails to make API call

IOException