Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/BatchesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description

<a name="getBatchReport"></a>
# **getBatchReport**
> InlineResponse2007 getBatchReport(batchId)
> InlineResponse2004 getBatchReport(batchId)

Retrieve a Batch Report

Expand All @@ -28,7 +28,7 @@ Retrieve a Batch Report
BatchesApi apiInstance = new BatchesApi();
String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
try {
InlineResponse2007 result = apiInstance.getBatchReport(batchId);
InlineResponse2004 result = apiInstance.getBatchReport(batchId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchReport");
Expand All @@ -44,7 +44,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2007**](InlineResponse2007.md)
[**InlineResponse2004**](InlineResponse2004.md)

### Authorization

Expand All @@ -57,7 +57,7 @@ No authorization required

<a name="getBatchStatus"></a>
# **getBatchStatus**
> InlineResponse2006 getBatchStatus(batchId)
> InlineResponse2003 getBatchStatus(batchId)

Retrieve a Batch Status

Expand All @@ -73,7 +73,7 @@ Retrieve a Batch Status
BatchesApi apiInstance = new BatchesApi();
String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request.
try {
InlineResponse2006 result = apiInstance.getBatchStatus(batchId);
InlineResponse2003 result = apiInstance.getBatchStatus(batchId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchStatus");
Expand All @@ -89,7 +89,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2006**](InlineResponse2006.md)
[**InlineResponse2003**](InlineResponse2003.md)

### Authorization

Expand All @@ -102,7 +102,7 @@ No authorization required

<a name="getBatchesList"></a>
# **getBatchesList**
> InlineResponse2005 getBatchesList(offset, limit, fromDate, toDate)
> InlineResponse2002 getBatchesList(offset, limit, fromDate, toDate)

List Batches

Expand All @@ -121,7 +121,7 @@ Long limit = 20L; // Long | The maximum number that can be returned in the array
String fromDate = "fromDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ
String toDate = "toDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ
try {
InlineResponse2005 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate);
InlineResponse2002 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BatchesApi#getBatchesList");
Expand All @@ -140,7 +140,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2005**](InlineResponse2005.md)
[**InlineResponse2002**](InlineResponse2002.md)

### Authorization

Expand Down
96 changes: 2 additions & 94 deletions docs/CreateNewWebhooksApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,108 +4,16 @@ All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createWebhookSubscription**](CreateNewWebhooksApi.md#createWebhookSubscription) | **POST** /notification-subscriptions/v1/webhooks | Create a Webhook
[**findProductsToSubscribe**](CreateNewWebhooksApi.md#findProductsToSubscribe) | **GET** /notification-subscriptions/v1/products/{organizationId} | Find Products You Can Subscribe To
[**saveSymEgressKey**](CreateNewWebhooksApi.md#saveSymEgressKey) | **POST** /kms/egress/v2/keys-sym | Create Webhook Security Keys


<a name="createWebhookSubscription"></a>
# **createWebhookSubscription**
> InlineResponse2014 createWebhookSubscription(createWebhookRequest)

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.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.CreateNewWebhooksApi;


CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
CreateWebhookRequest createWebhookRequest = new CreateWebhookRequest(); // CreateWebhookRequest | The webhook payload
try {
InlineResponse2014 result = apiInstance.createWebhookSubscription(createWebhookRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CreateNewWebhooksApi#createWebhookSubscription");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createWebhookRequest** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| The webhook payload | [optional]

### Return type

[**InlineResponse2014**](InlineResponse2014.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json;charset=utf-8

<a name="findProductsToSubscribe"></a>
# **findProductsToSubscribe**
> List&lt;InlineResponse2002&gt; findProductsToSubscribe(organizationId)

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.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.CreateNewWebhooksApi;


CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
String organizationId = "organizationId_example"; // String | The Organization Identifier.
try {
List<InlineResponse2002> result = apiInstance.findProductsToSubscribe(organizationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CreateNewWebhooksApi#findProductsToSubscribe");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**organizationId** | **String**| The Organization Identifier. |

### Return type

[**List&lt;InlineResponse2002&gt;**](InlineResponse2002.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json;charset=utf-8

<a name="saveSymEgressKey"></a>
# **saveSymEgressKey**
> InlineResponse2013 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, vCCorrelationId, 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. 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.
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.

### Example
```java
Expand Down Expand Up @@ -148,5 +56,5 @@ No authorization required
### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8

19 changes: 0 additions & 19 deletions docs/CreateWebhookRequest.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/GenerateUnifiedCheckoutCaptureContextRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
**targetOrigins** | **List&lt;String&gt;** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080&lt;br&gt;&lt;br&gt; If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \&quot;https://example.com\&quot;, \&quot;https://basket.example.com\&quot;, \&quot;https://ecom.example.com\&quot; ] | [optional]
**allowedCardNetworks** | **List&lt;String&gt;** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional]
**allowedPaymentTypes** | **List&lt;String&gt;** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE &lt;br&gt;&lt;br&gt; Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt; **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant&#39;s existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional]
**allowedPaymentTypes** | **List&lt;String&gt;** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE &lt;br&gt;&lt;br&gt; Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt; **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant&#39;s existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.&lt;br&gt;&lt;br&gt; **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay. | [optional]
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
**locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional]
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
Expand Down
10 changes: 7 additions & 3 deletions docs/InlineResponse2002.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**productId** | **String** | Product ID. | [optional]
**productName** | **String** | Product Name. | [optional]
**eventTypes** | [**List&lt;Notificationsubscriptionsv1productsorganizationIdEventTypes&gt;**](Notificationsubscriptionsv1productsorganizationIdEventTypes.md) | | [optional]
**links** | [**List&lt;InlineResponse2002Links&gt;**](InlineResponse2002Links.md) | | [optional]
**object** | **String** | | [optional]
**offset** | **Integer** | | [optional]
**limit** | **Integer** | | [optional]
**count** | **Integer** | | [optional]
**total** | **Integer** | | [optional]
**embedded** | [**InlineResponse2002Embedded**](InlineResponse2002Embedded.md) | | [optional]



10 changes: 10 additions & 0 deletions docs/InlineResponse2002Embedded.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# InlineResponse2002Embedded

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**batches** | [**List&lt;InlineResponse2002EmbeddedBatches&gt;**](InlineResponse2002EmbeddedBatches.md) | | [optional]



Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

# InlineResponse2005EmbeddedBatches
# InlineResponse2002EmbeddedBatches

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**InlineResponse2005EmbeddedLinks**](InlineResponse2005EmbeddedLinks.md) | | [optional]
**links** | [**InlineResponse2002EmbeddedLinks**](InlineResponse2002EmbeddedLinks.md) | | [optional]
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**batchModifiedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
Expand All @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
**batchCaEndpoints** | **List&lt;String&gt;** | Valid Values: * VISA * MASTERCARD * AMEX | [optional]
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional]
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional]



10 changes: 10 additions & 0 deletions docs/InlineResponse2002EmbeddedLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# InlineResponse2002EmbeddedLinks

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reports** | [**List&lt;InlineResponse2002EmbeddedLinksReports&gt;**](InlineResponse2002EmbeddedLinksReports.md) | | [optional]



Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse2005EmbeddedLinksReports
# InlineResponse2002EmbeddedLinksReports

## Properties
Name | Type | Description | Notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse2005EmbeddedTotals
# InlineResponse2002EmbeddedTotals

## Properties
Name | Type | Description | Notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse2005Links
# InlineResponse2002Links

## Properties
Name | Type | Description | Notes
Expand Down
24 changes: 10 additions & 14 deletions docs/InlineResponse2003.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**webhookId** | **String** | Webhook Id. This is generated by the server. | [optional]
**organizationId** | **String** | Organization ID. | [optional]
**products** | [**List&lt;Notificationsubscriptionsv1webhooksProducts&gt;**](Notificationsubscriptionsv1webhooksProducts.md) | | [optional]
**webhookUrl** | **String** | The client&#39;s endpoint (URL) to receive webhooks. | [optional]
**healthCheckUrl** | **String** | The client&#39;s health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional]
**notificationScope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional]
**status** | **String** | Webhook status. | [optional]
**name** | **String** | Client friendly webhook name. | [optional]
**description** | **String** | Client friendly webhook description. | [optional]
**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional]
**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional]
**createdOn** | **String** | Date on which webhook was created/registered. | [optional]
**updatedOn** | **String** | Date on which webhook was most recently updated. | [optional]
**additionalAttributes** | [**List&lt;Map&lt;String, String&gt;&gt;**](Map.md) | Additional, free form configuration data. | [optional]
**links** | [**InlineResponse2003Links**](InlineResponse2003Links.md) | | [optional]
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional]
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
**batchCaEndpoints** | **String** | | [optional]
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional]
**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional]
**billing** | [**InlineResponse2003Billing**](InlineResponse2003Billing.md) | | [optional]
**description** | **String** | | [optional]



Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse2006Billing
# InlineResponse2003Billing

## Properties
Name | Type | Description | Notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# InlineResponse2006Links
# InlineResponse2003Links

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**self** | [**InlineResponse202LinksStatus**](InlineResponse202LinksStatus.md) | | [optional]
**report** | [**List&lt;InlineResponse2006LinksReport&gt;**](InlineResponse2006LinksReport.md) | | [optional]
**report** | [**List&lt;InlineResponse2003LinksReport&gt;**](InlineResponse2003LinksReport.md) | | [optional]



Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse2006LinksReport
# InlineResponse2003LinksReport

## Properties
Name | Type | Description | Notes
Expand Down
Loading