Package com.adyen.service.management

Class WebhooksMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.WebhooksMerchantLevelApi

public class WebhooksMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
WebhooksMerchantLevelApi(Client client)	Webhooks - merchant level constructor in package.
WebhooksMerchantLevelApi(Client client, String baseURL)	Webhooks - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
GenerateHmacKeyResponse	generateHmacKey(String merchantId, String webhookId)	Generate an HMAC key
GenerateHmacKeyResponse	generateHmacKey(String merchantId, String webhookId, RequestOptions requestOptions)	Generate an HMAC key
Webhook	getWebhook(String merchantId, String webhookId)	Get a webhook
Webhook	getWebhook(String merchantId, String webhookId, RequestOptions requestOptions)	Get a webhook
ListWebhooksResponse	listAllWebhooks(String merchantId)	List all webhooks
ListWebhooksResponse	listAllWebhooks(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	List all webhooks
void	removeWebhook(String merchantId, String webhookId)	Remove a webhook
void	removeWebhook(String merchantId, String webhookId, RequestOptions requestOptions)	Remove a webhook
Webhook	setUpWebhook(String merchantId, CreateMerchantWebhookRequest createMerchantWebhookRequest)	Set up a webhook
Webhook	setUpWebhook(String merchantId, CreateMerchantWebhookRequest createMerchantWebhookRequest, RequestOptions requestOptions)	Set up a webhook
TestWebhookResponse	testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest)	Test a webhook
TestWebhookResponse	testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest, RequestOptions requestOptions)	Test a webhook
Webhook	updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest)	Update a webhook
Webhook	updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest, RequestOptions requestOptions)	Update a webhook

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

WebhooksMerchantLevelApi

public WebhooksMerchantLevelApi(Client client)

Webhooks - merchant level constructor in package.

Parameters:

client - Client (required)

WebhooksMerchantLevelApi

public WebhooksMerchantLevelApi(Client client,
                                String baseURL)

Webhooks - 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

generateHmacKey

public GenerateHmacKeyResponse generateHmacKey(String merchantId,
                                               String webhookId)
                                        throws ApiException,
                                               IOException

Generate an HMAC key

Parameters:

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

webhookId - String (required)

Returns:

GenerateHmacKeyResponse

Throws:

ApiException - if fails to make API call

IOException

generateHmacKey

public GenerateHmacKeyResponse generateHmacKey(String merchantId,
                                               String webhookId,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Generate an HMAC key

Parameters:

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

webhookId - String (required)

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

Returns:

GenerateHmacKeyResponse

Throws:

ApiException - if fails to make API call

IOException

getWebhook

public Webhook getWebhook(String merchantId,
                          String webhookId)
                   throws ApiException,
                          IOException

Get a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

getWebhook

public Webhook getWebhook(String merchantId,
                          String webhookId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Get a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

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

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

listAllWebhooks

public ListWebhooksResponse listAllWebhooks(String merchantId)
                                     throws ApiException,
                                            IOException

List all webhooks

Parameters:

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

Returns:

ListWebhooksResponse

Throws:

ApiException - if fails to make API call

IOException

listAllWebhooks

public ListWebhooksResponse listAllWebhooks(String merchantId,
                                            Integer pageNumber,
                                            Integer pageSize,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

List all webhooks

Parameters:

merchantId - String The unique identifier of the merchant 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:

ListWebhooksResponse

Throws:

ApiException - if fails to make API call

IOException

removeWebhook

public void removeWebhook(String merchantId,
                          String webhookId)
                   throws ApiException,
                          IOException

Remove a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

Throws:

ApiException - if fails to make API call

IOException

removeWebhook

public void removeWebhook(String merchantId,
                          String webhookId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Remove a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

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

Throws:

ApiException - if fails to make API call

IOException

setUpWebhook

public Webhook setUpWebhook(String merchantId,
                            CreateMerchantWebhookRequest createMerchantWebhookRequest)
                     throws ApiException,
                            IOException

Set up a webhook

Parameters:

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

createMerchantWebhookRequest - CreateMerchantWebhookRequest (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

setUpWebhook

public Webhook setUpWebhook(String merchantId,
                            CreateMerchantWebhookRequest createMerchantWebhookRequest,
                            RequestOptions requestOptions)
                     throws ApiException,
                            IOException

Set up a webhook

Parameters:

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

createMerchantWebhookRequest - CreateMerchantWebhookRequest (required)

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

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

testWebhook

public TestWebhookResponse testWebhook(String merchantId,
                                       String webhookId,
                                       TestWebhookRequest testWebhookRequest)
                                throws ApiException,
                                       IOException

Test a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

testWebhookRequest - TestWebhookRequest (required)

Returns:

TestWebhookResponse

Throws:

ApiException - if fails to make API call

IOException

testWebhook

public TestWebhookResponse testWebhook(String merchantId,
                                       String webhookId,
                                       TestWebhookRequest testWebhookRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Test a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

testWebhookRequest - TestWebhookRequest (required)

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

Returns:

TestWebhookResponse

Throws:

ApiException - if fails to make API call

IOException

updateWebhook

public Webhook updateWebhook(String merchantId,
                             String webhookId,
                             UpdateMerchantWebhookRequest updateMerchantWebhookRequest)
                      throws ApiException,
                             IOException

Update a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

updateMerchantWebhookRequest - UpdateMerchantWebhookRequest (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

updateWebhook

public Webhook updateWebhook(String merchantId,
                             String webhookId,
                             UpdateMerchantWebhookRequest updateMerchantWebhookRequest,
                             RequestOptions requestOptions)
                      throws ApiException,
                             IOException

Update a webhook

Parameters:

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

webhookId - String Unique identifier of the webhook configuration. (required)

updateMerchantWebhookRequest - UpdateMerchantWebhookRequest (required)

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

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException