Package com.adyen.service.management

Class WebhooksCompanyLevel

java.lang.Object

com.adyen.Service

com.adyen.ApiKeyAuthenticatedService

com.adyen.service.management.WebhooksCompanyLevel

public class WebhooksCompanyLevel
extends ApiKeyAuthenticatedService

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
WebhooksCompanyLevel(Client client)

Method Summary

Modifier and Type	Method	Description
GenerateHmacKeyResponse	generateHmacKey(String companyId, String webhookId)	Generate an HMAC key
Webhook	getWebhook(String companyId, String webhookId)	Get a webhook
ListWebhooksResponse	listAllWebhooks(String companyId, Map<String,String> queryParams)	List all webhooks
void	removeWebhook(String companyId, String webhookId)	Remove a webhook
Webhook	setUpWebhook(String companyId, CreateCompanyWebhookRequest createCompanyWebhookRequest)	Set up a webhook
TestWebhookResponse	testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest)	Test a webhook
Webhook	updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest)	Update a webhook

Methods inherited from class com.adyen.Service

getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksCompanyLevel

public WebhooksCompanyLevel(Client client)

Method Detail

removeWebhook

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

Remove a webhook

Parameters:

companyId - The unique identifier of the company account. (required)

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

Throws:

ApiException - if fails to make API call

IOException

listAllWebhooks

public ListWebhooksResponse listAllWebhooks(String companyId,
                                            Map<String,String> queryParams)
                                     throws ApiException,
                                            IOException

List all webhooks

Parameters:

companyId - Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

queryParams - (optional) pageNumber: The number of the page to fetch. (optional) pageSize: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

Returns:

ListWebhooksResponse

Throws:

ApiException - if fails to make API call

IOException

getWebhook

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

Get a webhook

Parameters:

companyId - Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

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

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

updateWebhook

public Webhook updateWebhook(String companyId,
                             String webhookId,
                             UpdateCompanyWebhookRequest updateCompanyWebhookRequest)
                      throws ApiException,
                             IOException

Update a webhook

Parameters:

companyId - The unique identifier of the company account. (required)

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

updateCompanyWebhookRequest - (optional)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

setUpWebhook

public Webhook setUpWebhook(String companyId,
                            CreateCompanyWebhookRequest createCompanyWebhookRequest)
                     throws ApiException,
                            IOException

Set up a webhook

Parameters:

companyId - Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

createCompanyWebhookRequest - (optional)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

generateHmacKey

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

Generate an HMAC key

Parameters:

companyId - The unique identifier of the company account. (required)

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

Returns:

GenerateHmacKeyResponse

Throws:

ApiException - if fails to make API call

IOException

testWebhook

public TestWebhookResponse testWebhook(String companyId,
                                       String webhookId,
                                       TestCompanyWebhookRequest testCompanyWebhookRequest)
                                throws ApiException,
                                       IOException

Test a webhook

Parameters:

companyId - The unique identifier of the company account. (required)

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

testCompanyWebhookRequest - (optional)

Returns:

TestWebhookResponse

Throws:

ApiException - if fails to make API call

IOException