Package com.adyen.service.balanceplatform

Class AccountHoldersApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.AccountHoldersApi

public class AccountHoldersApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
AccountHoldersApi(Client client)	Account holders constructor in package.
AccountHoldersApi(Client client, String baseURL)	Account holders constructor in package.

Method Summary

Modifier and Type	Method	Description
AccountHolder	createAccountHolder(AccountHolderInfo accountHolderInfo)	Create an account holder
AccountHolder	createAccountHolder(AccountHolderInfo accountHolderInfo, RequestOptions requestOptions)	Create an account holder
AccountHolder	getAccountHolder(String id)	Get an account holder
AccountHolder	getAccountHolder(String id, RequestOptions requestOptions)	Get an account holder
PaginatedBalanceAccountsResponse	getAllBalanceAccountsOfAccountHolder(String id)	Get all balance accounts of an account holder
PaginatedBalanceAccountsResponse	getAllBalanceAccountsOfAccountHolder(String id, Integer offset, Integer limit, RequestOptions requestOptions)	Get all balance accounts of an account holder
GetTaxFormResponse	getTaxForm(String id, String formType, Integer year)	Get a tax form
GetTaxFormResponse	getTaxForm(String id, String formType, Integer year, RequestOptions requestOptions)	Get a tax form
AccountHolder	updateAccountHolder(String id, AccountHolderUpdateRequest accountHolderUpdateRequest)	Update an account holder
AccountHolder	updateAccountHolder(String id, AccountHolderUpdateRequest accountHolderUpdateRequest, RequestOptions requestOptions)	Update an account holder

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

AccountHoldersApi

public AccountHoldersApi(Client client)

Account holders constructor in package.

Parameters:

client - Client (required)

AccountHoldersApi

public AccountHoldersApi(Client client,
                         String baseURL)

Account holders 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

createAccountHolder

public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo)
                                  throws ApiException,
                                         IOException

Create an account holder

Parameters:

accountHolderInfo - AccountHolderInfo (required)

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException

createAccountHolder

public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Create an account holder

Parameters:

accountHolderInfo - AccountHolderInfo (required)

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

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException

getAccountHolder

public AccountHolder getAccountHolder(String id)
                               throws ApiException,
                                      IOException

Get an account holder

Parameters:

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

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException

getAccountHolder

public AccountHolder getAccountHolder(String id,
                                      RequestOptions requestOptions)
                               throws ApiException,
                                      IOException

Get an account holder

Parameters:

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

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

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException

getAllBalanceAccountsOfAccountHolder

public PaginatedBalanceAccountsResponse getAllBalanceAccountsOfAccountHolder(String id)
                                                                      throws ApiException,
                                                                             IOException

Get all balance accounts of an account holder

Parameters:

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

Returns:

PaginatedBalanceAccountsResponse

Throws:

ApiException - if fails to make API call

IOException

getAllBalanceAccountsOfAccountHolder

public PaginatedBalanceAccountsResponse getAllBalanceAccountsOfAccountHolder(String id,
                                                                             Integer offset,
                                                                             Integer limit,
                                                                             RequestOptions requestOptions)
                                                                      throws ApiException,
                                                                             IOException

Get all balance accounts of an account holder

Parameters:

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

offset - Integer Query: The number of items that you want to skip. (optional)

limit - Integer Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional)

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

Returns:

PaginatedBalanceAccountsResponse

Throws:

ApiException - if fails to make API call

IOException

getTaxForm

public GetTaxFormResponse getTaxForm(String id,
                                     String formType,
                                     Integer year)
                              throws ApiException,
                                     IOException

Get a tax form

Parameters:

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

formType - String The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec** (required)

year - Integer The tax year in YYYY format for the tax form you want to retrieve (required)

Returns:

GetTaxFormResponse

Throws:

ApiException - if fails to make API call

IOException

getTaxForm

public GetTaxFormResponse getTaxForm(String id,
                                     String formType,
                                     Integer year,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Get a tax form

Parameters:

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

formType - String Query: The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec** (required)

year - Integer Query: The tax year in YYYY format for the tax form you want to retrieve (required)

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

Returns:

GetTaxFormResponse

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolder

public AccountHolder updateAccountHolder(String id,
                                         AccountHolderUpdateRequest accountHolderUpdateRequest)
                                  throws ApiException,
                                         IOException

Update an account holder

Parameters:

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

accountHolderUpdateRequest - AccountHolderUpdateRequest (required)

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException

updateAccountHolder

public AccountHolder updateAccountHolder(String id,
                                         AccountHolderUpdateRequest accountHolderUpdateRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Update an account holder

Parameters:

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

accountHolderUpdateRequest - AccountHolderUpdateRequest (required)

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

Returns:

AccountHolder

Throws:

ApiException - if fails to make API call

IOException