Package com.adyen.service.balanceplatform

Class BalancesApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.BalancesApi

public class BalancesApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
BalancesApi(Client client)	Balances constructor in package.
BalancesApi(Client client, String baseURL)	Balances constructor in package.

Method Summary

Modifier and Type	Method	Description
WebhookSetting	createWebhookSetting(String balancePlatformId, String webhookId, BalanceWebhookSettingInfo balanceWebhookSettingInfo)	Create a balance webhook setting
WebhookSetting	createWebhookSetting(String balancePlatformId, String webhookId, BalanceWebhookSettingInfo balanceWebhookSettingInfo, RequestOptions requestOptions)	Create a balance webhook setting
void	deleteWebhookSetting(String balancePlatformId, String webhookId, String settingId)	Delete a balance webhook setting by id
void	deleteWebhookSetting(String balancePlatformId, String webhookId, String settingId, RequestOptions requestOptions)	Delete a balance webhook setting by id
WebhookSettings	getAllWebhookSettings(String balancePlatformId, String webhookId)	Get all balance webhook settings
WebhookSettings	getAllWebhookSettings(String balancePlatformId, String webhookId, RequestOptions requestOptions)	Get all balance webhook settings
WebhookSetting	getWebhookSetting(String balancePlatformId, String webhookId, String settingId)	Get a balance webhook setting by id
WebhookSetting	getWebhookSetting(String balancePlatformId, String webhookId, String settingId, RequestOptions requestOptions)	Get a balance webhook setting by id
WebhookSetting	updateWebhookSetting(String balancePlatformId, String webhookId, String settingId, BalanceWebhookSettingInfoUpdate balanceWebhookSettingInfoUpdate)	Update a balance webhook setting by id
WebhookSetting	updateWebhookSetting(String balancePlatformId, String webhookId, String settingId, BalanceWebhookSettingInfoUpdate balanceWebhookSettingInfoUpdate, RequestOptions requestOptions)	Update a balance webhook setting by id

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

BalancesApi

public BalancesApi(Client client)

Balances constructor in package.

Parameters:

client - Client (required)

BalancesApi

public BalancesApi(Client client,
                   String baseURL)

Balances 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

createWebhookSetting

public WebhookSetting createWebhookSetting(String balancePlatformId,
                                           String webhookId,
                                           BalanceWebhookSettingInfo balanceWebhookSettingInfo)
                                    throws ApiException,
                                           IOException

Create a balance webhook setting

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

balanceWebhookSettingInfo - BalanceWebhookSettingInfo (required)

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException

createWebhookSetting

public WebhookSetting createWebhookSetting(String balancePlatformId,
                                           String webhookId,
                                           BalanceWebhookSettingInfo balanceWebhookSettingInfo,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Create a balance webhook setting

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

balanceWebhookSettingInfo - BalanceWebhookSettingInfo (required)

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

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException

deleteWebhookSetting

public void deleteWebhookSetting(String balancePlatformId,
                                 String webhookId,
                                 String settingId)
                          throws ApiException,
                                 IOException

Delete a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteWebhookSetting

public void deleteWebhookSetting(String balancePlatformId,
                                 String webhookId,
                                 String settingId,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Delete a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getAllWebhookSettings

public WebhookSettings getAllWebhookSettings(String balancePlatformId,
                                             String webhookId)
                                      throws ApiException,
                                             IOException

Get all balance webhook settings

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

Returns:

WebhookSettings

Throws:

ApiException - if fails to make API call

IOException

getAllWebhookSettings

public WebhookSettings getAllWebhookSettings(String balancePlatformId,
                                             String webhookId,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get all balance webhook settings

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

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

Returns:

WebhookSettings

Throws:

ApiException - if fails to make API call

IOException

getWebhookSetting

public WebhookSetting getWebhookSetting(String balancePlatformId,
                                        String webhookId,
                                        String settingId)
                                 throws ApiException,
                                        IOException

Get a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException

getWebhookSetting

public WebhookSetting getWebhookSetting(String balancePlatformId,
                                        String webhookId,
                                        String settingId,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Get a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

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

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException

updateWebhookSetting

public WebhookSetting updateWebhookSetting(String balancePlatformId,
                                           String webhookId,
                                           String settingId,
                                           BalanceWebhookSettingInfoUpdate balanceWebhookSettingInfoUpdate)
                                    throws ApiException,
                                           IOException

Update a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

balanceWebhookSettingInfoUpdate - BalanceWebhookSettingInfoUpdate (required)

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException

updateWebhookSetting

public WebhookSetting updateWebhookSetting(String balancePlatformId,
                                           String webhookId,
                                           String settingId,
                                           BalanceWebhookSettingInfoUpdate balanceWebhookSettingInfoUpdate,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Update a balance webhook setting by id

Parameters:

balancePlatformId - String The unique identifier of the balance platform. (required)

webhookId - String The unique identifier of the balance webhook. (required)

settingId - String The unique identifier of the balance webhook setting. (required)

balanceWebhookSettingInfoUpdate - BalanceWebhookSettingInfoUpdate (required)

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

Returns:

WebhookSetting

Throws:

ApiException - if fails to make API call

IOException