Skip to content

Commit 2fb5747

Browse files
committed
spec changes
1 parent ac17a6a commit 2fb5747

File tree

207 files changed

+12667
-5475
lines changed

Some content is hidden

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

207 files changed

+12667
-5475
lines changed

docs/CreatePaymentRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Name | Type | Description | Notes
3030
**riskInformation** | [**Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) | | [optional]
3131
**acquirerInformation** | [**Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) | | [optional]
3232
**recurringPaymentInformation** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
33+
**unscheduledPaymentInformation** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional]
3334
**hostedPaymentInformation** | [**Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) | | [optional]
3435
**watchlistScreeningInformation** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
3536

docs/GenerateCaptureContextRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
88
**targetOrigins** | **List<String>** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform 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]
9-
**allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional]
10-
**checkoutApiInitialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [optional]
9+
**allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA **Important:** - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
10+
**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
1111

1212

1313

docs/GenerateUnifiedCheckoutCaptureContextRequest.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ Name | Type | Description | Notes
77
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
88
**targetOrigins** | **List<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]
99
**allowedCardNetworks** | **List<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]
10-
**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - PANENTRY - GOOGLEPAY - SRC - CHECK <br><br> Possible values when launching Unified Checkout with Checkout API: - PANENTRY - SRC <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - SRC and CLICKTOPAY are only available for Visa, Mastercard and AMEX. | [optional]
10+
**allowedPaymentTypes** | **List<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]
1111
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
1212
**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]
1313
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
1414
**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional]
15-
**checkoutApiInitialization** | [**Upv1capturecontextsCheckoutApiInitialization**](Upv1capturecontextsCheckoutApiInitialization.md) | | [optional]
1615

1716

1817

docs/InlineResponse2011.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
77
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
88
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
99
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
10-
**paymentAccountInformation** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
11-
**issuerInformation** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
10+
**paymentAccountInformation** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional]
11+
**issuerInformation** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) | | [optional]
1212
**payoutInformation** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
1313

1414

docs/InlineResponse2011PaymentAccountInformation.md

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

docs/InstrumentIdentifierApi.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ No authorization required
6060

6161
<a name="getInstrumentIdentifier"></a>
6262
# **getInstrumentIdentifier**
63-
> PostInstrumentIdentifierRequest getInstrumentIdentifier(instrumentIdentifierId, profileId)
63+
> PostInstrumentIdentifierRequest getInstrumentIdentifier(instrumentIdentifierId, profileId, retrieveBinDetails)
6464
6565
Retrieve an Instrument Identifier
6666

@@ -76,8 +76,9 @@ Retrieve an Instrument Identifier
7676
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
7777
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
7878
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
79+
Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
7980
try {
80-
PostInstrumentIdentifierRequest result = apiInstance.getInstrumentIdentifier(instrumentIdentifierId, profileId);
81+
PostInstrumentIdentifierRequest result = apiInstance.getInstrumentIdentifier(instrumentIdentifierId, profileId, retrieveBinDetails);
8182
System.out.println(result);
8283
} catch (ApiException e) {
8384
System.err.println("Exception when calling InstrumentIdentifierApi#getInstrumentIdentifier");
@@ -91,6 +92,7 @@ Name | Type | Description | Notes
9192
------------- | ------------- | ------------- | -------------
9293
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
9394
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
95+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
9496

9597
### Return type
9698

@@ -107,7 +109,7 @@ No authorization required
107109

108110
<a name="getInstrumentIdentifierPaymentInstrumentsList"></a>
109111
# **getInstrumentIdentifierPaymentInstrumentsList**
110-
> PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, offset, limit)
112+
> PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit)
111113
112114
List Payment Instruments for an Instrument Identifier
113115

@@ -123,10 +125,11 @@ List Payment Instruments for an Instrument Identifier
123125
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
124126
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
125127
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
128+
Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
126129
Long offset = 0L; // Long | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
127130
Long limit = 20L; // Long | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.
128131
try {
129-
PaymentInstrumentList1 result = apiInstance.getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, offset, limit);
132+
PaymentInstrumentList1 result = apiInstance.getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit);
130133
System.out.println(result);
131134
} catch (ApiException e) {
132135
System.err.println("Exception when calling InstrumentIdentifierApi#getInstrumentIdentifierPaymentInstrumentsList");
@@ -140,6 +143,7 @@ Name | Type | Description | Notes
140143
------------- | ------------- | ------------- | -------------
141144
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
142145
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
146+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
143147
**offset** | **Long**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
144148
**limit** | **Long**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20]
145149

@@ -158,7 +162,7 @@ No authorization required
158162

159163
<a name="patchInstrumentIdentifier"></a>
160164
# **patchInstrumentIdentifier**
161-
> PatchInstrumentIdentifierRequest patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch)
165+
> PatchInstrumentIdentifierRequest patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch)
162166
163167
Update an Instrument Identifier
164168

@@ -175,9 +179,10 @@ InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
175179
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
176180
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest = new PatchInstrumentIdentifierRequest(); // PatchInstrumentIdentifierRequest | Specify the previous transaction Id to update.
177181
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
182+
Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
178183
String ifMatch = "ifMatch_example"; // String | Contains an ETag value from a GET request to make the request conditional.
179184
try {
180-
PatchInstrumentIdentifierRequest result = apiInstance.patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch);
185+
PatchInstrumentIdentifierRequest result = apiInstance.patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch);
181186
System.out.println(result);
182187
} catch (ApiException e) {
183188
System.err.println("Exception when calling InstrumentIdentifierApi#patchInstrumentIdentifier");
@@ -192,6 +197,7 @@ Name | Type | Description | Notes
192197
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
193198
**patchInstrumentIdentifierRequest** | [**PatchInstrumentIdentifierRequest**](PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. |
194199
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
200+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
195201
**ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
196202

197203
### Return type
@@ -209,7 +215,7 @@ No authorization required
209215

210216
<a name="postInstrumentIdentifier"></a>
211217
# **postInstrumentIdentifier**
212-
> PostInstrumentIdentifierRequest postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId)
218+
> PostInstrumentIdentifierRequest postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId, retrieveBinDetails)
213219
214220
Create an Instrument Identifier
215221

@@ -225,8 +231,9 @@ Create an Instrument Identifier
225231
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
226232
PostInstrumentIdentifierRequest postInstrumentIdentifierRequest = new PostInstrumentIdentifierRequest(); // PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
227233
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
234+
Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
228235
try {
229-
PostInstrumentIdentifierRequest result = apiInstance.postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId);
236+
PostInstrumentIdentifierRequest result = apiInstance.postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId, retrieveBinDetails);
230237
System.out.println(result);
231238
} catch (ApiException e) {
232239
System.err.println("Exception when calling InstrumentIdentifierApi#postInstrumentIdentifier");
@@ -240,6 +247,7 @@ Name | Type | Description | Notes
240247
------------- | ------------- | ------------- | -------------
241248
**postInstrumentIdentifierRequest** | [**PostInstrumentIdentifierRequest**](PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card |
242249
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
250+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
243251

244252
### Return type
245253

docs/Microformv2sessionsCheckoutApiInitialization.md

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

docs/OctCreatePaymentRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional]
1212
**processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional]
1313
**paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional]
14+
**aggregatorInformation** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional]
1415

1516

1617

docs/PatchInstrumentIdentifierRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
1818
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
1919
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
20+
**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
2021

2122

2223

0 commit comments

Comments
 (0)