Package com.adyen.service.balanceplatform

Class BalanceAccountsApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.BalanceAccountsApi

public class BalanceAccountsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
BalanceAccountsApi(Client client)	Balance accounts constructor in package.
BalanceAccountsApi(Client client, String baseURL)	Balance accounts constructor in package.

Method Summary

Modifier and Type	Method	Description
BalanceAccount	createBalanceAccount(BalanceAccountInfo balanceAccountInfo)	Create a balance account
BalanceAccount	createBalanceAccount(BalanceAccountInfo balanceAccountInfo, RequestOptions requestOptions)	Create a balance account
SweepConfigurationV2	createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2)	Create a sweep
SweepConfigurationV2	createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2, RequestOptions requestOptions)	Create a sweep
void	deleteSweep(String balanceAccountId, String sweepId)	Delete a sweep
void	deleteSweep(String balanceAccountId, String sweepId, RequestOptions requestOptions)	Delete a sweep
BalanceSweepConfigurationsResponse	getAllSweepsForBalanceAccount(String balanceAccountId)	Get all sweeps for a balance account
BalanceSweepConfigurationsResponse	getAllSweepsForBalanceAccount(String balanceAccountId, Integer offset, Integer limit, RequestOptions requestOptions)	Get all sweeps for a balance account
TransactionRulesResponse	getAllTransactionRulesForBalanceAccount(String id)	Get all transaction rules for a balance account
TransactionRulesResponse	getAllTransactionRulesForBalanceAccount(String id, RequestOptions requestOptions)	Get all transaction rules for a balance account
BalanceAccount	getBalanceAccount(String id)	Get a balance account
BalanceAccount	getBalanceAccount(String id, RequestOptions requestOptions)	Get a balance account
PaginatedPaymentInstrumentsResponse	getPaymentInstrumentsLinkedToBalanceAccount(String id)	Get payment instruments linked to a balance account
PaginatedPaymentInstrumentsResponse	getPaymentInstrumentsLinkedToBalanceAccount(String id, Integer offset, Integer limit, String status, RequestOptions requestOptions)	Get payment instruments linked to a balance account
SweepConfigurationV2	getSweep(String balanceAccountId, String sweepId)	Get a sweep
SweepConfigurationV2	getSweep(String balanceAccountId, String sweepId, RequestOptions requestOptions)	Get a sweep
BalanceAccount	updateBalanceAccount(String id, BalanceAccountUpdateRequest balanceAccountUpdateRequest)	Update a balance account
BalanceAccount	updateBalanceAccount(String id, BalanceAccountUpdateRequest balanceAccountUpdateRequest, RequestOptions requestOptions)	Update a balance account
SweepConfigurationV2	updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2)	Update a sweep
SweepConfigurationV2	updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2, RequestOptions requestOptions)	Update a sweep

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

BalanceAccountsApi

public BalanceAccountsApi(Client client)

Balance accounts constructor in package.

Parameters:

client - Client (required)

BalanceAccountsApi

public BalanceAccountsApi(Client client,
                          String baseURL)

Balance accounts 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

createBalanceAccount

public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo)
                                    throws ApiException,
                                           IOException

Create a balance account

Parameters:

balanceAccountInfo - BalanceAccountInfo (required)

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

createBalanceAccount

public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Create a balance account

Parameters:

balanceAccountInfo - BalanceAccountInfo (required)

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

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

createSweep

public SweepConfigurationV2 createSweep(String balanceAccountId,
                                        CreateSweepConfigurationV2 createSweepConfigurationV2)
                                 throws ApiException,
                                        IOException

Create a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

createSweepConfigurationV2 - CreateSweepConfigurationV2 (required)

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException

createSweep

public SweepConfigurationV2 createSweep(String balanceAccountId,
                                        CreateSweepConfigurationV2 createSweepConfigurationV2,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Create a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

createSweepConfigurationV2 - CreateSweepConfigurationV2 (required)

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

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException

deleteSweep

public void deleteSweep(String balanceAccountId,
                        String sweepId)
                 throws ApiException,
                        IOException

Delete a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteSweep

public void deleteSweep(String balanceAccountId,
                        String sweepId,
                        RequestOptions requestOptions)
                 throws ApiException,
                        IOException

Delete a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getAllSweepsForBalanceAccount

public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId)
                                                                 throws ApiException,
                                                                        IOException

Get all sweeps for a balance account

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

Returns:

BalanceSweepConfigurationsResponse

Throws:

ApiException - if fails to make API call

IOException

getAllSweepsForBalanceAccount

public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId,
                                                                        Integer offset,
                                                                        Integer limit,
                                                                        RequestOptions requestOptions)
                                                                 throws ApiException,
                                                                        IOException

Get all sweeps for a balance account

Parameters:

balanceAccountId - String The unique identifier of the balance account. (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:

BalanceSweepConfigurationsResponse

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForBalanceAccount

public TransactionRulesResponse getAllTransactionRulesForBalanceAccount(String id)
                                                                 throws ApiException,
                                                                        IOException

Get all transaction rules for a balance account

Parameters:

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

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForBalanceAccount

public TransactionRulesResponse getAllTransactionRulesForBalanceAccount(String id,
                                                                        RequestOptions requestOptions)
                                                                 throws ApiException,
                                                                        IOException

Get all transaction rules for a balance account

Parameters:

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

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

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getBalanceAccount

public BalanceAccount getBalanceAccount(String id)
                                 throws ApiException,
                                        IOException

Get a balance account

Parameters:

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

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

getBalanceAccount

public BalanceAccount getBalanceAccount(String id,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Get a balance account

Parameters:

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

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

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrumentsLinkedToBalanceAccount

public PaginatedPaymentInstrumentsResponse getPaymentInstrumentsLinkedToBalanceAccount(String id)
                                                                                throws ApiException,
                                                                                       IOException

Get payment instruments linked to a balance account

Parameters:

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

Returns:

PaginatedPaymentInstrumentsResponse

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrumentsLinkedToBalanceAccount

public PaginatedPaymentInstrumentsResponse getPaymentInstrumentsLinkedToBalanceAccount(String id,
                                                                                       Integer offset,
                                                                                       Integer limit,
                                                                                       String status,
                                                                                       RequestOptions requestOptions)
                                                                                throws ApiException,
                                                                                       IOException

Get payment instruments linked to a balance account

Parameters:

id - String The unique identifier of the balance account. (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)

status - String Query: The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status. (optional)

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

Returns:

PaginatedPaymentInstrumentsResponse

Throws:

ApiException - if fails to make API call

IOException

getSweep

public SweepConfigurationV2 getSweep(String balanceAccountId,
                                     String sweepId)
                              throws ApiException,
                                     IOException

Get a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException

getSweep

public SweepConfigurationV2 getSweep(String balanceAccountId,
                                     String sweepId,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Get a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

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

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException

updateBalanceAccount

public BalanceAccount updateBalanceAccount(String id,
                                           BalanceAccountUpdateRequest balanceAccountUpdateRequest)
                                    throws ApiException,
                                           IOException

Update a balance account

Parameters:

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

balanceAccountUpdateRequest - BalanceAccountUpdateRequest (required)

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

updateBalanceAccount

public BalanceAccount updateBalanceAccount(String id,
                                           BalanceAccountUpdateRequest balanceAccountUpdateRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Update a balance account

Parameters:

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

balanceAccountUpdateRequest - BalanceAccountUpdateRequest (required)

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

Returns:

BalanceAccount

Throws:

ApiException - if fails to make API call

IOException

updateSweep

public SweepConfigurationV2 updateSweep(String balanceAccountId,
                                        String sweepId,
                                        UpdateSweepConfigurationV2 updateSweepConfigurationV2)
                                 throws ApiException,
                                        IOException

Update a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

updateSweepConfigurationV2 - UpdateSweepConfigurationV2 (required)

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException

updateSweep

public SweepConfigurationV2 updateSweep(String balanceAccountId,
                                        String sweepId,
                                        UpdateSweepConfigurationV2 updateSweepConfigurationV2,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Update a sweep

Parameters:

balanceAccountId - String The unique identifier of the balance account. (required)

sweepId - String The unique identifier of the sweep. (required)

updateSweepConfigurationV2 - UpdateSweepConfigurationV2 (required)

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

Returns:

SweepConfigurationV2

Throws:

ApiException - if fails to make API call

IOException