Api

Class CreateNewWebhooksApi

java.lang.Object

Api.CreateNewWebhooksApi

public class CreateNewWebhooksApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CreateNewWebhooksApi()
CreateNewWebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<InlineResponse2006>	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<InlineResponse2006>> 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<InlineResponse2006>>	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()
InlineResponse2016	notificationSubscriptionsV2WebhooksPost(CreateWebhook createWebhook)	Create a New Webhook Subscription Create a new webhook subscription.
okhttp3.Call	notificationSubscriptionsV2WebhooksPostAsync(CreateWebhook createWebhook, ApiCallback<InlineResponse2016> callback)	Create a New Webhook Subscription (asynchronously) Create a new webhook subscription.
okhttp3.Call	notificationSubscriptionsV2WebhooksPostCall(CreateWebhook createWebhook, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for notificationSubscriptionsV2WebhooksPost
ApiResponse<InlineResponse2016>	notificationSubscriptionsV2WebhooksPostWithHttpInfo(CreateWebhook createWebhook)	Create a New Webhook Subscription Create a new webhook subscription.
InlineResponse2015	saveSymEgressKey(String vCCorrelationId, String vCSenderOrganizationId, String vCPermissions, 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 vCCorrelationId, String vCSenderOrganizationId, String vCPermissions, SaveSymEgressKey saveSymEgressKey, ApiCallback<InlineResponse2015> 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 vCCorrelationId, String vCSenderOrganizationId, String vCPermissions, SaveSymEgressKey saveSymEgressKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for saveSymEgressKey
ApiResponse<InlineResponse2015>	saveSymEgressKeyWithHttpInfo(String vCCorrelationId, String vCSenderOrganizationId, String vCPermissions, 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)

findProductsToSubscribeCall

public okhttp3.Call findProductsToSubscribeCall(String organizationId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException,
                                                com.cybersource.authsdk.core.ConfigException

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

findProductsToSubscribe

public List<InlineResponse2006> findProductsToSubscribe(String organizationId)
                                                 throws ApiException,
                                                        com.cybersource.authsdk.core.ConfigException

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:

List<InlineResponse2006>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

findProductsToSubscribeWithHttpInfo

public ApiResponse<List<InlineResponse2006>> findProductsToSubscribeWithHttpInfo(String organizationId)
                                                                          throws ApiException,
                                                                                 com.cybersource.authsdk.core.ConfigException

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

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

findProductsToSubscribeAsync

public okhttp3.Call findProductsToSubscribeAsync(String organizationId,
                                                 ApiCallback<List<InlineResponse2006>> callback)
                                          throws ApiException,
                                                 com.cybersource.authsdk.core.ConfigException

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

notificationSubscriptionsV2WebhooksPostCall

public okhttp3.Call notificationSubscriptionsV2WebhooksPostCall(CreateWebhook createWebhook,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException,
                                                                com.cybersource.authsdk.core.ConfigException

Build call for notificationSubscriptionsV2WebhooksPost

Parameters:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

notificationSubscriptionsV2WebhooksPost

public InlineResponse2016 notificationSubscriptionsV2WebhooksPost(CreateWebhook createWebhook)
                                                           throws ApiException,
                                                                  com.cybersource.authsdk.core.ConfigException

Create a New Webhook Subscription Create a new webhook subscription. Before creating a webhook, ensure that a signature key has been created. For the example \"Create Webhook using oAuth with Client Credentials\" - for clients who have more than one oAuth Provider and have different client secrets that they would like to config for a given webhook, they may do so by overriding the keyId inside security config of webhook subscription. See the Developer Center examples section titled \"Webhook Security - Create or Store Egress Symmetric Key - Store oAuth Credentials For Symmetric Key\" to store these oAuth credentials that CYBS will need for oAuth. For JWT authentication, attach your oAuth details to the webhook subscription. See the example \"Create Webhook using oAuth with JWT\"

Parameters:

createWebhook - The webhook payload (optional)

Returns:

InlineResponse2016

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

notificationSubscriptionsV2WebhooksPostWithHttpInfo

public ApiResponse<InlineResponse2016> notificationSubscriptionsV2WebhooksPostWithHttpInfo(CreateWebhook createWebhook)
                                                                                    throws ApiException,
                                                                                           com.cybersource.authsdk.core.ConfigException

Create a New Webhook Subscription Create a new webhook subscription. Before creating a webhook, ensure that a signature key has been created. For the example \"Create Webhook using oAuth with Client Credentials\" - for clients who have more than one oAuth Provider and have different client secrets that they would like to config for a given webhook, they may do so by overriding the keyId inside security config of webhook subscription. See the Developer Center examples section titled \"Webhook Security - Create or Store Egress Symmetric Key - Store oAuth Credentials For Symmetric Key\" to store these oAuth credentials that CYBS will need for oAuth. For JWT authentication, attach your oAuth details to the webhook subscription. See the example \"Create Webhook using oAuth with JWT\"

Parameters:

createWebhook - The webhook payload (optional)

Returns:

ApiResponse<InlineResponse2016>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

notificationSubscriptionsV2WebhooksPostAsync

public okhttp3.Call notificationSubscriptionsV2WebhooksPostAsync(CreateWebhook createWebhook,
                                                                 ApiCallback<InlineResponse2016> callback)
                                                          throws ApiException,
                                                                 com.cybersource.authsdk.core.ConfigException

Create a New Webhook Subscription (asynchronously) Create a new webhook subscription. Before creating a webhook, ensure that a signature key has been created. For the example \"Create Webhook using oAuth with Client Credentials\" - for clients who have more than one oAuth Provider and have different client secrets that they would like to config for a given webhook, they may do so by overriding the keyId inside security config of webhook subscription. See the Developer Center examples section titled \"Webhook Security - Create or Store Egress Symmetric Key - Store oAuth Credentials For Symmetric Key\" to store these oAuth credentials that CYBS will need for oAuth. For JWT authentication, attach your oAuth details to the webhook subscription. See the example \"Create Webhook using oAuth with JWT\"

Parameters:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

saveSymEgressKeyCall

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

Build call for saveSymEgressKey

Parameters:

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

vCSenderOrganizationId - Sender organization id (optional)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

saveSymEgressKey

public InlineResponse2015 saveSymEgressKey(String vCCorrelationId,
                                           String vCSenderOrganizationId,
                                           String vCPermissions,
                                           SaveSymEgressKey saveSymEgressKey)
                                    throws ApiException,
                                           com.cybersource.authsdk.core.ConfigException

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. Remember to save the key in the API response, so that you can use it to validate messages later.

Parameters:

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

vCSenderOrganizationId - Sender organization id (optional)

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

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

Returns:

InlineResponse2015

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

saveSymEgressKeyWithHttpInfo

public ApiResponse<InlineResponse2015> saveSymEgressKeyWithHttpInfo(String vCCorrelationId,
                                                                    String vCSenderOrganizationId,
                                                                    String vCPermissions,
                                                                    SaveSymEgressKey saveSymEgressKey)
                                                             throws ApiException,
                                                                    com.cybersource.authsdk.core.ConfigException

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. Remember to save the key in the API response, so that you can use it to validate messages later.

Parameters:

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

vCSenderOrganizationId - Sender organization id (optional)

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

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

Returns:

ApiResponse<InlineResponse2015>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

saveSymEgressKeyAsync

public okhttp3.Call saveSymEgressKeyAsync(String vCCorrelationId,
                                          String vCSenderOrganizationId,
                                          String vCPermissions,
                                          SaveSymEgressKey saveSymEgressKey,
                                          ApiCallback<InlineResponse2015> callback)
                                   throws ApiException,
                                          com.cybersource.authsdk.core.ConfigException

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. Remember to save the key in the API response, so that you can use it to validate messages later.

Parameters:

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

vCSenderOrganizationId - Sender organization id (optional)

vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient