Skip to content

Commit 3cbc4e8

Browse files
gnongsiegnongsie
authored
Merge pull request #160 from CyberSource/release-march25
spec changes
2 parents 74e7f15 + 9ec133e commit 3cbc4e8

File tree

186 files changed

+115844
-111083
lines changed

Some content is hidden

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

186 files changed

+115844
-111083
lines changed

‎docs/BatchesApi.md

Lines changed: 6 additions & 6 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-
> InlineResponse2007 getBatchReport(batchId)
15+
> InlineResponse2004 getBatchReport(batchId)
1616
1717
Retrieve a Batch Report
1818

@@ -45,7 +45,7 @@ Name | Type | Description | Notes
4545

4646
### Return type
4747

48-
[**InlineResponse2007**](InlineResponse2007.md)
48+
[**InlineResponse2004**](InlineResponse2004.md)
4949

5050
### Authorization
5151

@@ -58,7 +58,7 @@ No authorization required
5858

5959
<a name="getBatchStatus"></a>
6060
# **getBatchStatus**
61-
> InlineResponse2006 getBatchStatus(batchId)
61+
> InlineResponse2003 getBatchStatus(batchId)
6262
6363
Retrieve a Batch Status
6464

@@ -91,7 +91,7 @@ Name | Type | Description | Notes
9191

9292
### Return type
9393

94-
[**InlineResponse2006**](InlineResponse2006.md)
94+
[**InlineResponse2003**](InlineResponse2003.md)
9595

9696
### Authorization
9797

@@ -104,7 +104,7 @@ No authorization required
104104

105105
<a name="getBatchesList"></a>
106106
# **getBatchesList**
107-
> InlineResponse2005 getBatchesList(opts)
107+
> InlineResponse2002 getBatchesList(opts)
108108
109109
List Batches
110110

@@ -144,7 +144,7 @@ Name | Type | Description | Notes
144144

145145
### Return type
146146

147-
[**InlineResponse2005**](InlineResponse2005.md)
147+
[**InlineResponse2002**](InlineResponse2002.md)
148148

149149
### Authorization
150150

‎docs/CreateNewWebhooksApi.md

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
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
97
[**saveSymEgressKey**](CreateNewWebhooksApi.md#saveSymEgressKey) | **POST** /kms/egress/v2/keys-sym | Create Webhook Security Keys
108

119

12-
<a name="createWebhookSubscription"></a>
13-
# **createWebhookSubscription**
14-
> InlineResponse2014 createWebhookSubscription(opts)
15-
16-
Create a Webhook
17-
18-
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.
19-
20-
### Example
21-
```javascript
22-
var CyberSource = require('CyberSource');
23-
24-
var apiInstance = new CyberSource.CreateNewWebhooksApi();
25-
26-
var opts = {
27-
'createWebhookRequest': new CyberSource.CreateWebhookRequest() // CreateWebhookRequest | The webhook payload
28-
};
29-
30-
var callback = function(error, data, response) {
31-
if (error) {
32-
console.error(error);
33-
} else {
34-
console.log('API called successfully. Returned data: ' + data);
35-
}
36-
};
37-
apiInstance.createWebhookSubscription(opts, callback);
38-
```
39-
40-
### Parameters
41-
42-
Name | Type | Description | Notes
43-
------------- | ------------- | ------------- | -------------
44-
**createWebhookRequest** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| The webhook payload | [optional]
45-
46-
### Return type
47-
48-
[**InlineResponse2014**](InlineResponse2014.md)
49-
50-
### Authorization
51-
52-
No authorization required
53-
54-
### HTTP request headers
55-
56-
- **Content-Type**: application/json;charset=utf-8
57-
- **Accept**: application/json;charset=utf-8
58-
59-
<a name="findProductsToSubscribe"></a>
60-
# **findProductsToSubscribe**
61-
> [InlineResponse2002] findProductsToSubscribe(organizationId)
62-
63-
Find Products You Can Subscribe To
64-
65-
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.
66-
67-
### Example
68-
```javascript
69-
var CyberSource = require('CyberSource');
70-
71-
var apiInstance = new CyberSource.CreateNewWebhooksApi();
72-
73-
var organizationId = "organizationId_example"; // String | The Organization Identifier.
74-
75-
76-
var callback = function(error, data, response) {
77-
if (error) {
78-
console.error(error);
79-
} else {
80-
console.log('API called successfully. Returned data: ' + data);
81-
}
82-
};
83-
apiInstance.findProductsToSubscribe(organizationId, callback);
84-
```
85-
86-
### Parameters
87-
88-
Name | Type | Description | Notes
89-
------------- | ------------- | ------------- | -------------
90-
**organizationId** | **String**| The Organization Identifier. |
91-
92-
### Return type
93-
94-
[**[InlineResponse2002]**](InlineResponse2002.md)
95-
96-
### Authorization
97-
98-
No authorization required
99-
100-
### HTTP request headers
101-
102-
- **Content-Type**: application/json;charset=utf-8
103-
- **Accept**: application/json;charset=utf-8
104-
10510
<a name="saveSymEgressKey"></a>
10611
# **saveSymEgressKey**
10712
> InlineResponse2013 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, opts)
10813
10914
Create Webhook Security Keys
11015

111-
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.
16+
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.
11217

11318
### Example
11419
```javascript
@@ -155,5 +60,5 @@ No authorization required
15560
### HTTP request headers
15661

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

‎docs/CreateWebhookRequest.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/GenerateUnifiedCheckoutCaptureContextRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
77
**targetOrigins** | **[String]** | 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<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional]
88
**allowedCardNetworks** | **[String]** | 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]
9-
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **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's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional]
9+
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **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's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.<br><br> **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]
1010
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
1111
**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]
1212
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]

‎docs/InlineResponse2002.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**productId** | **String** | Product ID. | [optional]
7-
**productName** | **String** | Product Name. | [optional]
8-
**eventTypes** | [**[Notificationsubscriptionsv1productsorganizationIdEventTypes]**](Notificationsubscriptionsv1productsorganizationIdEventTypes.md) | | [optional]
6+
**links** | [**[InlineResponse2002Links]**](InlineResponse2002Links.md) | | [optional]
7+
**_object** | **String** | | [optional]
8+
**offset** | **Number** | | [optional]
9+
**limit** | **Number** | | [optional]
10+
**count** | **Number** | | [optional]
11+
**total** | **Number** | | [optional]
12+
**embedded** | [**InlineResponse2002Embedded**](InlineResponse2002Embedded.md) | | [optional]
913

1014

‎docs/InlineResponse2002Embedded.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.InlineResponse2002Embedded
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**batches** | [**[InlineResponse2002EmbeddedBatches]**](InlineResponse2002EmbeddedBatches.md) | | [optional]
7+
8+

‎docs/InlineResponse2005EmbeddedBatches.md renamed to ‎docs/InlineResponse2002EmbeddedBatches.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CyberSource.InlineResponse2005EmbeddedBatches
1+
# CyberSource.InlineResponse2002EmbeddedBatches
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**InlineResponse2005EmbeddedLinks**](InlineResponse2005EmbeddedLinks.md) | | [optional]
6+
**links** | [**InlineResponse2002EmbeddedLinks**](InlineResponse2002EmbeddedLinks.md) | | [optional]
77
**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional]
88
**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
99
**batchModifiedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional]
@@ -12,6 +12,6 @@ Name | Type | Description | Notes
1212
**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional]
1313
**batchCaEndpoints** | **[String]** | Valid Values: * VISA * MASTERCARD * AMEX | [optional]
1414
**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional]
15-
**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional]
15+
**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional]
1616

1717

‎docs/InlineResponse2002EmbeddedLinks.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.InlineResponse2002EmbeddedLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**reports** | [**[InlineResponse2002EmbeddedLinksReports]**](InlineResponse2002EmbeddedLinksReports.md) | | [optional]
7+
8+

‎docs/InlineResponse2005EmbeddedLinksReports.md renamed to ‎docs/InlineResponse2002EmbeddedLinksReports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CyberSource.InlineResponse2005EmbeddedLinksReports
1+
# CyberSource.InlineResponse2002EmbeddedLinksReports
22

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

‎docs/InlineResponse2005EmbeddedTotals.md renamed to ‎docs/InlineResponse2002EmbeddedTotals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CyberSource.InlineResponse2005EmbeddedTotals
1+
# CyberSource.InlineResponse2002EmbeddedTotals
22

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

0 commit comments

Comments
 (0)