Api

Class ManageWebhooksApi

java.lang.Object

Api.ManageWebhooksApi

public class ManageWebhooksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ManageWebhooksApi()
ManageWebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2014	notificationSubscriptionsV1WebhooksWebhookIdPost(String webhookId) Test a Webhook Configuration Test the webhook configuration by sending a sample webhook.
okhttp3.Call	notificationSubscriptionsV1WebhooksWebhookIdPostAsync(String webhookId, ApiCallback<InlineResponse2014> callback) Test a Webhook Configuration (asynchronously) Test the webhook configuration by sending a sample webhook.
okhttp3.Call	notificationSubscriptionsV1WebhooksWebhookIdPostCall(String webhookId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for notificationSubscriptionsV1WebhooksWebhookIdPost
ApiResponse<InlineResponse2014>	notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo(String webhookId) Test a Webhook Configuration Test the webhook configuration by sending a sample webhook.
InlineResponse2015	saveAsymEgressKey(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) Message Level Encryption Store and manage certificates that will be used to preform Message Level Encryption (MLE).
okhttp3.Call	saveAsymEgressKeyAsync(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId, ApiCallback<InlineResponse2015> callback) Message Level Encryption (asynchronously) Store and manage certificates that will be used to preform Message Level Encryption (MLE).
okhttp3.Call	saveAsymEgressKeyCall(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for saveAsymEgressKey
ApiResponse<InlineResponse2015>	saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) Message Level Encryption Store and manage certificates that will be used to preform Message Level Encryption (MLE).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ManageWebhooksApi

public ManageWebhooksApi()

ManageWebhooksApi

public ManageWebhooksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

notificationSubscriptionsV1WebhooksWebhookIdPostCall

public okhttp3.Call notificationSubscriptionsV1WebhooksWebhookIdPostCall(String webhookId,
                                                                         ProgressResponseBody.ProgressListener progressListener,
                                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                  throws ApiException

Build call for notificationSubscriptionsV1WebhooksWebhookIdPost

Parameters:

webhookId - The Webhook Identifier. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

notificationSubscriptionsV1WebhooksWebhookIdPost

public InlineResponse2014 notificationSubscriptionsV1WebhooksWebhookIdPost(String webhookId)
                                                                    throws ApiException

Test a Webhook Configuration Test the webhook configuration by sending a sample webhook. Calling this endpoint sends a sample webhook to the endpoint identified in the user's subscription. It will contain sample values for the product & eventType based on values present in your subscription along with a sample message in the payload. Based on the webhook response users can make any necessary modifications or rest assured knowing their setup is configured correctly.

DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

Parameters:

webhookId - The Webhook Identifier. (required)

Returns:

InlineResponse2014

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo

public ApiResponse<InlineResponse2014> notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo(String webhookId)
                                                                                             throws ApiException

Test a Webhook Configuration Test the webhook configuration by sending a sample webhook. Calling this endpoint sends a sample webhook to the endpoint identified in the user's subscription. It will contain sample values for the product & eventType based on values present in your subscription along with a sample message in the payload. Based on the webhook response users can make any necessary modifications or rest assured knowing their setup is configured correctly.

Parameters:

webhookId - The Webhook Identifier. (required)

Returns:

ApiResponse<InlineResponse2014>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

notificationSubscriptionsV1WebhooksWebhookIdPostAsync

public okhttp3.Call notificationSubscriptionsV1WebhooksWebhookIdPostAsync(String webhookId,
                                                                          ApiCallback<InlineResponse2014> callback)
                                                                   throws ApiException

Test a Webhook Configuration (asynchronously) Test the webhook configuration by sending a sample webhook. Calling this endpoint sends a sample webhook to the endpoint identified in the user's subscription. It will contain sample values for the product & eventType based on values present in your subscription along with a sample message in the payload. Based on the webhook response users can make any necessary modifications or rest assured knowing their setup is configured correctly.

Parameters:

webhookId - The Webhook Identifier. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

saveAsymEgressKeyCall

public okhttp3.Call saveAsymEgressKeyCall(String vCSenderOrganizationId,
                                          String vCPermissions,
                                          SaveAsymEgressKey saveAsymEgressKey,
                                          String vCCorrelationId,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException

Build call for saveAsymEgressKey

Parameters:

vCSenderOrganizationId - Sender organization id (required)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)

saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)

vCCorrelationId - A globally unique id associated with your request (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

saveAsymEgressKey

public InlineResponse2015 saveAsymEgressKey(String vCSenderOrganizationId,
                                            String vCPermissions,
                                            SaveAsymEgressKey saveAsymEgressKey,
                                            String vCCorrelationId)
                                     throws ApiException

Message Level Encryption Store and manage certificates that will be used to preform Message Level Encryption (MLE). Each new webhook will need its own unique asymmetric certificate. You can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide.

DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

Parameters:

vCSenderOrganizationId - Sender organization id (required)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)

saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)

vCCorrelationId - A globally unique id associated with your request (optional)

Returns:

InlineResponse2015

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

saveAsymEgressKeyWithHttpInfo

public ApiResponse<InlineResponse2015> saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId,
                                                                     String vCPermissions,
                                                                     SaveAsymEgressKey saveAsymEgressKey,
                                                                     String vCCorrelationId)
                                                              throws ApiException

Message Level Encryption Store and manage certificates that will be used to preform Message Level Encryption (MLE). Each new webhook will need its own unique asymmetric certificate. You can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide.

Parameters:

vCSenderOrganizationId - Sender organization id (required)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)

saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)

vCCorrelationId - A globally unique id associated with your request (optional)

Returns:

ApiResponse<InlineResponse2015>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

saveAsymEgressKeyAsync

public okhttp3.Call saveAsymEgressKeyAsync(String vCSenderOrganizationId,
                                           String vCPermissions,
                                           SaveAsymEgressKey saveAsymEgressKey,
                                           String vCCorrelationId,
                                           ApiCallback<InlineResponse2015> callback)
                                    throws ApiException

Message Level Encryption (asynchronously) Store and manage certificates that will be used to preform Message Level Encryption (MLE). Each new webhook will need its own unique asymmetric certificate. You can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide.

Parameters:

vCSenderOrganizationId - Sender organization id (required)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)

saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)

vCCorrelationId - A globally unique id associated with your request (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object