Skip to content

Commit 8424bbb

Browse files
api-spec-changes
1 parent ee060d8 commit 8424bbb

File tree

651 files changed

+6383
-6291
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

651 files changed

+6383
-6291
lines changed

docs/Boardingv1registrationsProductInformationSelectedProducts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**payments** | [**PaymentProducts**](PaymentProducts.md) | | [optional]
7+
**payments** | [**PaymentsProducts**](PaymentsProducts.md) | | [optional]
88
**risk** | [**RiskProducts**](RiskProducts.md) | | [optional]
99
**commerceSolutions** | [**CommerceSolutionsProducts**](CommerceSolutionsProducts.md) | | [optional]
1010
**valueAddedServices** | [**ValueAddedServicesProducts**](ValueAddedServicesProducts.md) | | [optional]

docs/CommerceSolutionsProductsAccountUpdater.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**subscriptionInformation** | [**PaymentProductsPayerAuthenticationSubscriptionInformation**](PaymentProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
7+
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
88
**configurationInformation** | [**CommerceSolutionsProductsAccountUpdaterConfigurationInformation**](CommerceSolutionsProductsAccountUpdaterConfigurationInformation.md) | | [optional]
99

1010

docs/CommerceSolutionsProductsBinLookup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**subscriptionInformation** | [**PaymentProductsPayerAuthenticationSubscriptionInformation**](PaymentProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
7+
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
88
**configurationInformation** | [**CommerceSolutionsProductsBinLookupConfigurationInformation**](CommerceSolutionsProductsBinLookupConfigurationInformation.md) | | [optional]
99

1010

docs/CommerceSolutionsProductsTokenManagement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**subscriptionInformation** | [**PaymentProductsPayerAuthenticationSubscriptionInformation**](PaymentProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
7+
**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) | | [optional]
88
**configurationInformation** | [**CommerceSolutionsProductsTokenManagementConfigurationInformation**](CommerceSolutionsProductsTokenManagementConfigurationInformation.md) | | [optional]
99

1010

docs/CreateNewWebhooksApi.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ All URIs are relative to *https://apitest.cybersource.com*
44

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

1111

12-
<a name="createWebhook"></a>
13-
# **createWebhook**
14-
> InlineResponse2013 createWebhook(createWebhook)
12+
<a name="createWebhookSubscription"></a>
13+
# **createWebhookSubscription**
14+
> InlineResponse2013 createWebhookSubscription(createWebhookRequest)
1515
1616
Create a Webhook
1717

@@ -25,12 +25,12 @@ Create a new webhook subscription. Before creating a webhook, ensure that a secu
2525

2626

2727
CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
28-
CreateWebhook createWebhook = new CreateWebhook(); // CreateWebhook | The webhook payload
28+
CreateWebhookRequest createWebhookRequest = new CreateWebhookRequest(); // CreateWebhookRequest | The webhook payload
2929
try {
30-
InlineResponse2013 result = apiInstance.createWebhook(createWebhook);
30+
InlineResponse2013 result = apiInstance.createWebhookSubscription(createWebhookRequest);
3131
System.out.println(result);
3232
} catch (ApiException e) {
33-
System.err.println("Exception when calling CreateNewWebhooksApi#createWebhook");
33+
System.err.println("Exception when calling CreateNewWebhooksApi#createWebhookSubscription");
3434
e.printStackTrace();
3535
}
3636
```
@@ -39,7 +39,7 @@ try {
3939

4040
Name | Type | Description | Notes
4141
------------- | ------------- | ------------- | -------------
42-
**createWebhook** | [**CreateWebhook**](CreateWebhook.md)| The webhook payload | [optional]
42+
**createWebhookRequest** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| The webhook payload | [optional]
4343

4444
### Return type
4545

@@ -52,11 +52,11 @@ No authorization required
5252
### HTTP request headers
5353

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

57-
<a name="findProductToSubscribe"></a>
58-
# **findProductToSubscribe**
59-
> List&lt;InlineResponse2003&gt; findProductToSubscribe(organizationId)
57+
<a name="findProductsToSubscribe"></a>
58+
# **findProductsToSubscribe**
59+
> List&lt;InlineResponse2003&gt; findProductsToSubscribe(organizationId)
6060
6161
Find Products You Can Subscribe To
6262

@@ -72,10 +72,10 @@ Retrieve a list of products and event types that your account is eligible for. T
7272
CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
7373
String organizationId = "organizationId_example"; // String | The Organization Identifier.
7474
try {
75-
List<InlineResponse2003> result = apiInstance.findProductToSubscribe(organizationId);
75+
List<InlineResponse2003> result = apiInstance.findProductsToSubscribe(organizationId);
7676
System.out.println(result);
7777
} catch (ApiException e) {
78-
System.err.println("Exception when calling CreateNewWebhooksApi#findProductToSubscribe");
78+
System.err.println("Exception when calling CreateNewWebhooksApi#findProductsToSubscribe");
7979
e.printStackTrace();
8080
}
8181
```
@@ -97,7 +97,7 @@ No authorization required
9797
### HTTP request headers
9898

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

102102
<a name="saveSymEgressKey"></a>
103103
# **saveSymEgressKey**
@@ -148,5 +148,5 @@ No authorization required
148148
### HTTP request headers
149149

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

docs/CreateSearchRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**save** | **Boolean** | Indicates whether or not you want to save this search request for future use. The options are: * &#x60;true&#x60; * &#x60;false&#x60; (default value) If set to &#x60;true&#x60;, this field returns &#x60;searchID&#x60; in the response. You can use this value to retrieve the details of the saved search. | [optional]
88
**name** | **String** | Name of this search. When &#x60;save&#x60; is set to &#x60;true&#x60;, this search is saved with this name. | [optional]
9-
**timezone** | **String** | Merchants time zone in ISO standard, using the TZ database format. For example: &#x60;America/Chicago&#x60; | [optional]
9+
**timezone** | **String** | Merchant&#39;s time zone in ISO standard, using the TZ database format. For example: &#x60;America/Chicago&#x60; | [optional]
1010
**query** | **String** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional]
1111
**offset** | **Integer** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit&#x3D;5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: &#x60;offset&#x3D;0&#x60; &#x60;offset&#x3D;5&#x60; &#x60;offset&#x3D;10&#x60; **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional]
1212
**limit** | **Integer** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional]

docs/CreateWebhook.md renamed to docs/CreateWebhookRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# CreateWebhook
2+
# CreateWebhookRequest
33

44
## Properties
55
Name | Type | Description | Notes

docs/GetAllSubscriptionsResponseOrderInformationBillTo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**firstName** | **String** | Customers first name. | [optional]
8-
**lastName** | **String** | Customers last name. | [optional]
7+
**firstName** | **String** | Customer&#39;s first name. | [optional]
8+
**lastName** | **String** | Customer&#39;s last name. | [optional]
99

1010

1111

docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **String** | Payer name for the invoice. | [optional]
8-
**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. &#x60;customer_account_id&#x60; value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the &#x60;customer_account_id&#x60; field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
8+
**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer&#39;s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. &#x60;customer_account_id&#x60; value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the &#x60;customer_account_id&#x60; field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
99

1010

1111

docs/Invoicingv2invoicesCustomerInformation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **String** | Payer name for the invoice. | [optional]
88
**email** | **String** | Customer&#39;s email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the &#x60;customer_email&#x60; request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won&#39;t work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
9-
**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. &#x60;customer_account_id&#x60; value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the &#x60;customer_account_id&#x60; field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
9+
**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer&#39;s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. &#x60;customer_account_id&#x60; value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the &#x60;customer_account_id&#x60; field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
1010
**company** | [**Invoicingv2invoicesCustomerInformationCompany**](Invoicingv2invoicesCustomerInformationCompany.md) | | [optional]
1111

1212

0 commit comments

Comments
 (0)