Skip to content

Commit 823bcc5

Browse files
gnongsiegnongsie
authored
Merge pull request #185 from CyberSource/release/april25
April 25 Release
2 parents 98397af + 76fb4c1 commit 823bcc5

File tree

356 files changed

+172319
-7418
lines changed

Some content is hidden

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

356 files changed

+172319
-7418
lines changed

‎docs/BatchesApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313
<a name="getBatchReport"></a>
1414
# **getBatchReport**
15-
> InlineResponse2004 getBatchReport(batchId)
15+
> InlineResponse2007 getBatchReport(batchId)
1616
1717
Retrieve a Batch Report
1818

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

4545
### Return type
4646

47-
[**InlineResponse2004**](InlineResponse2004.md)
47+
[**InlineResponse2007**](InlineResponse2007.md)
4848

4949
### Authorization
5050

@@ -57,7 +57,7 @@ No authorization required
5757

5858
<a name="getBatchStatus"></a>
5959
# **getBatchStatus**
60-
> InlineResponse2003 getBatchStatus(batchId)
60+
> InlineResponse2006 getBatchStatus(batchId)
6161
6262
Retrieve a Batch Status
6363

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

9090
### Return type
9191

92-
[**InlineResponse2003**](InlineResponse2003.md)
92+
[**InlineResponse2006**](InlineResponse2006.md)
9393

9494
### Authorization
9595

@@ -102,7 +102,7 @@ No authorization required
102102

103103
<a name="getBatchesList"></a>
104104
# **getBatchesList**
105-
> InlineResponse2002 getBatchesList(offset, limit, fromDate, toDate)
105+
> InlineResponse2005 getBatchesList(offset, limit, fromDate, toDate)
106106
107107
List Batches
108108

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

141141
### Return type
142142

143-
[**InlineResponse2002**](InlineResponse2002.md)
143+
[**InlineResponse2005**](InlineResponse2005.md)
144144

145145
### Authorization
146146

@@ -157,7 +157,7 @@ No authorization required
157157
158158
Create a Batch
159159

160-
**Create a Batch**&lt;br&gt;This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. &lt;br&gt; The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.&lt;br&gt;The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
160+
**Create a Batch**&lt;br&gt;This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. &lt;br&gt; The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.&lt;br&gt;The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report. The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
161161

162162
### Example
163163
```java

‎docs/CreateInvoiceRequest.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7+
**clientReferenceInformation** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional]
78
**customerInformation** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional]
8-
**invoiceInformation** | [**Invoicingv2invoicesInvoiceInformation**](Invoicingv2invoicesInvoiceInformation.md) | | [optional]
9-
**orderInformation** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | | [optional]
9+
**processingInformation** | [**Invoicingv2invoicesProcessingInformation**](Invoicingv2invoicesProcessingInformation.md) | | [optional]
10+
**invoiceInformation** | [**Invoicingv2invoicesInvoiceInformation**](Invoicingv2invoicesInvoiceInformation.md) | |
11+
**orderInformation** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | |
1012

1113

1214

‎docs/CreateNewWebhooksApi.md‎

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

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

911

12+
<a name="findProductsToSubscribe"></a>
13+
# **findProductsToSubscribe**
14+
> List&lt;InlineResponse2003&gt; findProductsToSubscribe(organizationId)
15+
16+
Find Products You Can Subscribe To
17+
18+
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.
19+
20+
### Example
21+
```java
22+
// Import classes:
23+
//import Invokers.ApiException;
24+
//import Api.CreateNewWebhooksApi;
25+
26+
27+
CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
28+
String organizationId = "organizationId_example"; // String | The Organization Identifier.
29+
try {
30+
List<InlineResponse2003> result = apiInstance.findProductsToSubscribe(organizationId);
31+
System.out.println(result);
32+
} catch (ApiException e) {
33+
System.err.println("Exception when calling CreateNewWebhooksApi#findProductsToSubscribe");
34+
e.printStackTrace();
35+
}
36+
```
37+
38+
### Parameters
39+
40+
Name | Type | Description | Notes
41+
------------- | ------------- | ------------- | -------------
42+
**organizationId** | **String**| The Organization Identifier. |
43+
44+
### Return type
45+
46+
[**List&lt;InlineResponse2003&gt;**](InlineResponse2003.md)
47+
48+
### Authorization
49+
50+
No authorization required
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: application/json;charset=utf-8
55+
- **Accept**: application/hal+json;charset=utf-8
56+
57+
<a name="notificationSubscriptionsV2WebhooksPost"></a>
58+
# **notificationSubscriptionsV2WebhooksPost**
59+
> InlineResponse2014 notificationSubscriptionsV2WebhooksPost(createWebhook)
60+
61+
Create a New Webhook Subscription
62+
63+
Create a new webhook subscription. Before creating a webhook, ensure that a signature key has been created. For the example \&quot;Create Webhook using oAuth with Client Credentials\&quot; - 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 \&quot;Webhook Security - Create or Store Egress Symmetric Key - Store oAuth Credentials For Symmetric Key\&quot; 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 \&quot;Create Webhook using oAuth with JWT\&quot;
64+
65+
### Example
66+
```java
67+
// Import classes:
68+
//import Invokers.ApiException;
69+
//import Api.CreateNewWebhooksApi;
70+
71+
72+
CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi();
73+
CreateWebhook createWebhook = new CreateWebhook(); // CreateWebhook | The webhook payload
74+
try {
75+
InlineResponse2014 result = apiInstance.notificationSubscriptionsV2WebhooksPost(createWebhook);
76+
System.out.println(result);
77+
} catch (ApiException e) {
78+
System.err.println("Exception when calling CreateNewWebhooksApi#notificationSubscriptionsV2WebhooksPost");
79+
e.printStackTrace();
80+
}
81+
```
82+
83+
### Parameters
84+
85+
Name | Type | Description | Notes
86+
------------- | ------------- | ------------- | -------------
87+
**createWebhook** | [**CreateWebhook**](CreateWebhook.md)| The webhook payload | [optional]
88+
89+
### Return type
90+
91+
[**InlineResponse2014**](InlineResponse2014.md)
92+
93+
### Authorization
94+
95+
No authorization required
96+
97+
### HTTP request headers
98+
99+
- **Content-Type**: application/json;charset=utf-8
100+
- **Accept**: application/hal+json;charset=utf-8
101+
10102
<a name="saveSymEgressKey"></a>
11103
# **saveSymEgressKey**
12104
> InlineResponse2013 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, vCCorrelationId, saveSymEgressKey)

‎docs/CreatePaymentLinkRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
# CreatePaymentLinkRequest
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**clientReferenceInformation** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional]
8+
**processingInformation** | [**Iplv2paymentlinksProcessingInformation**](Iplv2paymentlinksProcessingInformation.md) | |
9+
**purchaseInformation** | [**Iplv2paymentlinksPurchaseInformation**](Iplv2paymentlinksPurchaseInformation.md) | |
10+
**orderInformation** | [**Iplv2paymentlinksOrderInformation**](Iplv2paymentlinksOrderInformation.md) | |
11+
12+
13+

‎docs/CreateSubscriptionRequest1.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# CreateSubscriptionRequest1
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**clientReferenceInformation** | [**Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional]
8+
**processingInformation** | [**Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional]
9+
**planInformation** | [**Rbsv1subscriptionsPlanInformation**](Rbsv1subscriptionsPlanInformation.md) | | [optional]
10+
**subscriptionInformation** | [**Rbsv1subscriptionsSubscriptionInformation**](Rbsv1subscriptionsSubscriptionInformation.md) | | [optional]
11+
**orderInformation** | [**GetAllPlansResponseOrderInformation**](GetAllPlansResponseOrderInformation.md) | | [optional]
12+
13+
14+

‎docs/CreateWebhook.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
# CreateWebhook
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **String** | Client friendly webhook name. | [optional]
8+
**description** | **String** | Client friendly webhook description. | [optional]
9+
**organizationId** | **String** | Organization Identifier (OrgId) or Merchant Identifier (MID). | [optional]
10+
**products** | [**List&lt;Notificationsubscriptionsv2webhooksProducts1&gt;**](Notificationsubscriptionsv2webhooksProducts1.md) | To see the valid productId and eventTypes, call the \&quot;Create and Manage Webhooks - Retrieve a list of event types\&quot; endpoint. | [optional]
11+
**webhookUrl** | **String** | The client&#39;s endpoint (URL) to receive webhooks. | [optional]
12+
**healthCheckUrl** | **String** | The client&#39;s health check endpoint (URL). This should be as close as possible to the actual webhookUrl. If the user does not provide the health check URL, it is the user&#39;s responsibility to re-activate the webhook if it is deactivated by calling the test endpoint. | [optional]
13+
**retryPolicy** | [**Notificationsubscriptionsv2webhooksRetryPolicy**](Notificationsubscriptionsv2webhooksRetryPolicy.md) | | [optional]
14+
**securityPolicy** | [**Notificationsubscriptionsv2webhooksSecurityPolicy1**](Notificationsubscriptionsv2webhooksSecurityPolicy1.md) | | [optional]
15+
16+
17+

‎docs/CustomerApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ No authorization required
160160
161161
Create a Customer
162162

163-
| | | | | --- | --- | --- | |**Customers**&lt;br&gt;A Customer represents your tokenized customer information.&lt;br&gt;You should associate the Customer Id with the customer account on your systems.&lt;br&gt;A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.&lt;br&gt;&lt;br&gt;**Creating a Customer**&lt;br&gt;It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.&lt;br&gt;The Customer will be created with a Payment Instrument and Shipping Address.&lt;br&gt;You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).&lt;br&gt;In Europe: You should perform Payer Authentication alongside the Authorization.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Payment Network Tokens**&lt;br&gt;Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.&lt;br&gt;A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.&lt;br&gt;A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).&lt;br&gt;For more information about Payment Network Tokens see the Developer Guide.&lt;br&gt;&lt;br&gt;**Payments with Customers**&lt;br&gt;To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).&lt;br&gt;To perform a payment with a particular Payment Instrument or Shipping Address &lt;br&gt;specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
163+
| | | | | --- | --- | --- | |**Customers**&lt;br&gt;A Customer represents your tokenized customer information.&lt;br&gt;You should associate the Customer Id with the customer account on your systems.&lt;br&gt;A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.&lt;br&gt;&lt;br&gt;**Creating a Customer**&lt;br&gt;It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.&lt;br&gt;The Customer will be created with a Payment Instrument and Shipping Address.&lt;br&gt;You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).&lt;br&gt;In Europe: You should perform Payer Authentication alongside the Authorization.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Payment Network Tokens**&lt;br&gt;Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.&lt;br&gt;A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.&lt;br&gt;A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).&lt;br&gt;For more information about Payment Network Tokens see the Developer Guide.&lt;br&gt;&lt;br&gt;**Payments with Customers**&lt;br&gt;To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).&lt;br&gt;To perform a payment with a particular Payment Instrument or Shipping Address &lt;br&gt;specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). The availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
164164

165165
### Example
166166
```java

‎docs/DecisionManagerApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313

1414
<a name="actionDecisionManagerCase"></a>
1515
# **actionDecisionManagerCase**
16-
> InlineResponse200 actionDecisionManagerCase(id, caseManagementActionsRequest)
16+
> InlineResponse2001 actionDecisionManagerCase(id, caseManagementActionsRequest)
1717
1818
Take action on a DM post-transactional case
1919

@@ -30,7 +30,7 @@ DecisionManagerApi apiInstance = new DecisionManagerApi();
3030
String id = "id_example"; // String | An unique identification number generated by Cybersource to identify the submitted request.
3131
CaseManagementActionsRequest caseManagementActionsRequest = new CaseManagementActionsRequest(); // CaseManagementActionsRequest |
3232
try {
33-
InlineResponse200 result = apiInstance.actionDecisionManagerCase(id, caseManagementActionsRequest);
33+
InlineResponse2001 result = apiInstance.actionDecisionManagerCase(id, caseManagementActionsRequest);
3434
System.out.println(result);
3535
} catch (ApiException e) {
3636
System.err.println("Exception when calling DecisionManagerApi#actionDecisionManagerCase");
@@ -47,7 +47,7 @@ Name | Type | Description | Notes
4747

4848
### Return type
4949

50-
[**InlineResponse200**](InlineResponse200.md)
50+
[**InlineResponse2001**](InlineResponse2001.md)
5151

5252
### Authorization
5353

0 commit comments

Comments
 (0)