Package com.adyen.service.management

Class PayoutSettingsMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.PayoutSettingsMerchantLevelApi

public class PayoutSettingsMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PayoutSettingsMerchantLevelApi(Client client)	Payout settings - merchant level constructor in package.
PayoutSettingsMerchantLevelApi(Client client, String baseURL)	Payout settings - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
PayoutSettings	addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest)	Add a payout setting
PayoutSettings	addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest, RequestOptions requestOptions)	Add a payout setting
void	deletePayoutSetting(String merchantId, String payoutSettingsId)	Delete a payout setting
void	deletePayoutSetting(String merchantId, String payoutSettingsId, RequestOptions requestOptions)	Delete a payout setting
PayoutSettings	getPayoutSetting(String merchantId, String payoutSettingsId)	Get a payout setting
PayoutSettings	getPayoutSetting(String merchantId, String payoutSettingsId, RequestOptions requestOptions)	Get a payout setting
PayoutSettingsResponse	listPayoutSettings(String merchantId)	Get a list of payout settings
PayoutSettingsResponse	listPayoutSettings(String merchantId, RequestOptions requestOptions)	Get a list of payout settings
PayoutSettings	updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest)	Update a payout setting
PayoutSettings	updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest, RequestOptions requestOptions)	Update a payout setting

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

PayoutSettingsMerchantLevelApi

public PayoutSettingsMerchantLevelApi(Client client)

Payout settings - merchant level constructor in package.

Parameters:

client - Client (required)

PayoutSettingsMerchantLevelApi

public PayoutSettingsMerchantLevelApi(Client client,
                                      String baseURL)

Payout settings - merchant 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

addPayoutSetting

public PayoutSettings addPayoutSetting(String merchantId,
                                       PayoutSettingsRequest payoutSettingsRequest)
                                throws ApiException,
                                       IOException

Add a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsRequest - PayoutSettingsRequest (required)

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException

addPayoutSetting

public PayoutSettings addPayoutSetting(String merchantId,
                                       PayoutSettingsRequest payoutSettingsRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Add a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsRequest - PayoutSettingsRequest (required)

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

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException

deletePayoutSetting

public void deletePayoutSetting(String merchantId,
                                String payoutSettingsId)
                         throws ApiException,
                                IOException

Delete a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

Throws:

ApiException - if fails to make API call

IOException

deletePayoutSetting

public void deletePayoutSetting(String merchantId,
                                String payoutSettingsId,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Delete a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getPayoutSetting

public PayoutSettings getPayoutSetting(String merchantId,
                                       String payoutSettingsId)
                                throws ApiException,
                                       IOException

Get a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException

getPayoutSetting

public PayoutSettings getPayoutSetting(String merchantId,
                                       String payoutSettingsId,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Get a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

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

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException

listPayoutSettings

public PayoutSettingsResponse listPayoutSettings(String merchantId)
                                          throws ApiException,
                                                 IOException

Get a list of payout settings

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

PayoutSettingsResponse

Throws:

ApiException - if fails to make API call

IOException

listPayoutSettings

public PayoutSettingsResponse listPayoutSettings(String merchantId,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of payout settings

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

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

Returns:

PayoutSettingsResponse

Throws:

ApiException - if fails to make API call

IOException

updatePayoutSetting

public PayoutSettings updatePayoutSetting(String merchantId,
                                          String payoutSettingsId,
                                          UpdatePayoutSettingsRequest updatePayoutSettingsRequest)
                                   throws ApiException,
                                          IOException

Update a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

updatePayoutSettingsRequest - UpdatePayoutSettingsRequest (required)

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException

updatePayoutSetting

public PayoutSettings updatePayoutSetting(String merchantId,
                                          String payoutSettingsId,
                                          UpdatePayoutSettingsRequest updatePayoutSettingsRequest,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Update a payout setting

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

payoutSettingsId - String The unique identifier of the payout setting. (required)

updatePayoutSettingsRequest - UpdatePayoutSettingsRequest (required)

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

Returns:

PayoutSettings

Throws:

ApiException - if fails to make API call

IOException