Api

Class CreateNewWebhooksApi

java.lang.Object

Api.CreateNewWebhooksApi

public class CreateNewWebhooksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CreateNewWebhooksApi()
CreateNewWebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
InlineResponse2014	createWebhookSubscription(CreateWebhookRequest createWebhookRequest) Create a Webhook Create a new webhook subscription.
okhttp3.Call	createWebhookSubscriptionAsync(CreateWebhookRequest createWebhookRequest, ApiCallback<InlineResponse2014> callback) Create a Webhook (asynchronously) Create a new webhook subscription.
okhttp3.Call	createWebhookSubscriptionCall(CreateWebhookRequest createWebhookRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createWebhookSubscription
ApiResponse<InlineResponse2014>	createWebhookSubscriptionWithHttpInfo(CreateWebhookRequest createWebhookRequest) Create a Webhook Create a new webhook subscription.
List<InlineResponse2002>	findProductsToSubscribe(String organizationId) Find Products You Can Subscribe To Retrieve a list of products and event types that your account is eligible for.
okhttp3.Call	findProductsToSubscribeAsync(String organizationId, ApiCallback<List<InlineResponse2002>> callback) Find Products You Can Subscribe To (asynchronously) Retrieve a list of products and event types that your account is eligible for.
okhttp3.Call	findProductsToSubscribeCall(String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for findProductsToSubscribe
ApiResponse<List<InlineResponse2002>>	findProductsToSubscribeWithHttpInfo(String organizationId) Find Products You Can Subscribe To Retrieve a list of products and event types that your account is eligible for.
ApiClient	getApiClient()
InlineResponse2013	saveSymEgressKey(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey) Create Webhook Security Keys Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.
okhttp3.Call	saveSymEgressKeyAsync(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey, ApiCallback<InlineResponse2013> callback) Create Webhook Security Keys (asynchronously) Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.
okhttp3.Call	saveSymEgressKeyCall(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for saveSymEgressKey
ApiResponse<InlineResponse2013>	saveSymEgressKeyWithHttpInfo(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey) Create Webhook Security Keys Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateNewWebhooksApi

public CreateNewWebhooksApi()

CreateNewWebhooksApi

public CreateNewWebhooksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createWebhookSubscriptionCall

public okhttp3.Call createWebhookSubscriptionCall(CreateWebhookRequest createWebhookRequest,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for createWebhookSubscription

Parameters:

createWebhookRequest - The webhook payload (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createWebhookSubscription

public InlineResponse2014 createWebhookSubscription(CreateWebhookRequest createWebhookRequest)
                                             throws ApiException

Create a Webhook Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.

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:

createWebhookRequest - The webhook payload (optional)

Returns:

InlineResponse2014

Throws:

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

createWebhookSubscriptionWithHttpInfo

public ApiResponse<InlineResponse2014> createWebhookSubscriptionWithHttpInfo(CreateWebhookRequest createWebhookRequest)
                                                                      throws ApiException

Create a Webhook Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.

Parameters:

createWebhookRequest - The webhook payload (optional)

Returns:

ApiResponse<InlineResponse2014>

Throws:

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

createWebhookSubscriptionAsync

public okhttp3.Call createWebhookSubscriptionAsync(CreateWebhookRequest createWebhookRequest,
                                                   ApiCallback<InlineResponse2014> callback)
                                            throws ApiException

Create a Webhook (asynchronously) Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.

Parameters:

createWebhookRequest - The webhook payload (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

findProductsToSubscribeCall

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

Build call for findProductsToSubscribe

Parameters:

organizationId - The Organization Identifier. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

findProductsToSubscribe

public List<InlineResponse2002> findProductsToSubscribe(String organizationId)
                                                 throws ApiException

Find Products You Can Subscribe To Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.

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:

organizationId - The Organization Identifier. (required)

Returns:

List<InlineResponse2002>

Throws:

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

findProductsToSubscribeWithHttpInfo

public ApiResponse<List<InlineResponse2002>> findProductsToSubscribeWithHttpInfo(String organizationId)
                                                                          throws ApiException

Find Products You Can Subscribe To Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.

Parameters:

organizationId - The Organization Identifier. (required)

Returns:

ApiResponse<List<InlineResponse2002>>

Throws:

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

findProductsToSubscribeAsync

public okhttp3.Call findProductsToSubscribeAsync(String organizationId,
                                                 ApiCallback<List<InlineResponse2002>> callback)
                                          throws ApiException

Find Products You Can Subscribe To (asynchronously) Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.

Parameters:

organizationId - The Organization 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

saveSymEgressKeyCall

public okhttp3.Call saveSymEgressKeyCall(String vCSenderOrganizationId,
                                         String vCPermissions,
                                         String vCCorrelationId,
                                         SaveSymEgressKey saveSymEgressKey,
                                         ProgressResponseBody.ProgressListener progressListener,
                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                  throws ApiException

Build call for saveSymEgressKey

Parameters:

vCSenderOrganizationId - Sender organization id (required)

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

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

saveSymEgressKey - Provide egress Symmetric key information to save (create or store or refresh) (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

saveSymEgressKey

public InlineResponse2013 saveSymEgressKey(String vCSenderOrganizationId,
                                           String vCPermissions,
                                           String vCCorrelationId,
                                           SaveSymEgressKey saveSymEgressKey)
                                    throws ApiException

Create Webhook Security Keys Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.

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)

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

saveSymEgressKey - Provide egress Symmetric key information to save (create or store or refresh) (optional)

Returns:

InlineResponse2013

Throws:

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

saveSymEgressKeyWithHttpInfo

public ApiResponse<InlineResponse2013> saveSymEgressKeyWithHttpInfo(String vCSenderOrganizationId,
                                                                    String vCPermissions,
                                                                    String vCCorrelationId,
                                                                    SaveSymEgressKey saveSymEgressKey)
                                                             throws ApiException

Create Webhook Security Keys Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.

Parameters:

vCSenderOrganizationId - Sender organization id (required)

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

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

saveSymEgressKey - Provide egress Symmetric key information to save (create or store or refresh) (optional)

Returns:

ApiResponse<InlineResponse2013>

Throws:

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

saveSymEgressKeyAsync

public okhttp3.Call saveSymEgressKeyAsync(String vCSenderOrganizationId,
                                          String vCPermissions,
                                          String vCCorrelationId,
                                          SaveSymEgressKey saveSymEgressKey,
                                          ApiCallback<InlineResponse2013> callback)
                                   throws ApiException

Create Webhook Security Keys (asynchronously) Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.

Parameters:

vCSenderOrganizationId - Sender organization id (required)

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

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

saveSymEgressKey - Provide egress Symmetric key information to save (create or store or refresh) (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