Skip to content

Commit ed04d1e

Browse files
authored
Merge pull request #158 from CyberSource/release-jan25
spec changes
2 parents ac5cabb + 3a5ccca commit ed04d1e

File tree

288 files changed

+12828
-5972
lines changed

Some content is hidden

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

288 files changed

+12828
-5972
lines changed

docs/CreatePaymentRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
2929
**riskInformation** | [**Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) | | [optional]
3030
**acquirerInformation** | [**Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) | | [optional]
3131
**recurringPaymentInformation** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
32+
**unscheduledPaymentInformation** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional]
3233
**hostedPaymentInformation** | [**Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) | | [optional]
3334
**watchlistScreeningInformation** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
3435

docs/GenerateCaptureContextRequest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**clientVersion** | **String** | Specify the version of Microform 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 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]
8-
**allowedCardNetworks** | **[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]
9-
**checkoutApiInitialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [optional]
8+
**allowedCardNetworks** | **[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]
9+
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
1010

1111

docs/GenerateUnifiedCheckoutCaptureContextRequest.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ 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: - 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]
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]
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]
1313
**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional]
14-
**checkoutApiInitialization** | [**Upv1capturecontextsCheckoutApiInitialization**](Upv1capturecontextsCheckoutApiInitialization.md) | | [optional]
1514

1615

docs/InlineResponse2011.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
66
**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]
77
**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]
88
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
9-
**paymentAccountInformation** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
10-
**issuerInformation** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
9+
**paymentAccountInformation** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional]
10+
**issuerInformation** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) | | [optional]
1111
**payoutInformation** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
1212

1313

docs/InlineResponse2011PaymentAccountInformation.md

-10
This file was deleted.

docs/InstrumentIdentifierApi.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ var apiInstance = new CyberSource.InstrumentIdentifierApi();
7979
var instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
8080

8181
var opts = {
82-
'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
82+
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
83+
'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
8384
};
8485

8586
var callback = function(error, data, response) {
@@ -98,6 +99,7 @@ Name | Type | Description | Notes
9899
------------- | ------------- | ------------- | -------------
99100
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
100101
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
102+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
101103

102104
### Return type
103105

@@ -130,6 +132,7 @@ var instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The I
130132

131133
var opts = {
132134
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
135+
'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
133136
'offset': 0, // Number | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
134137
'limit': 20 // Number | 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.
135138
};
@@ -150,6 +153,7 @@ Name | Type | Description | Notes
150153
------------- | ------------- | ------------- | -------------
151154
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
152155
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
156+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
153157
**offset** | **Number**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
154158
**limit** | **Number**| 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]
155159

@@ -186,6 +190,7 @@ var patchInstrumentIdentifierRequest = new CyberSource.PatchInstrumentIdentifier
186190

187191
var opts = {
188192
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
193+
'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
189194
'ifMatch': "ifMatch_example" // String | Contains an ETag value from a GET request to make the request conditional.
190195
};
191196

@@ -206,6 +211,7 @@ Name | Type | Description | Notes
206211
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
207212
**patchInstrumentIdentifierRequest** | [**PatchInstrumentIdentifierRequest**](PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. |
208213
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
214+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
209215
**ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
210216

211217
### Return type
@@ -238,7 +244,8 @@ var apiInstance = new CyberSource.InstrumentIdentifierApi();
238244
var postInstrumentIdentifierRequest = new CyberSource.PostInstrumentIdentifierRequest(); // PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
239245

240246
var opts = {
241-
'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
247+
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
248+
'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
242249
};
243250

244251
var callback = function(error, data, response) {
@@ -257,6 +264,7 @@ Name | Type | Description | Notes
257264
------------- | ------------- | ------------- | -------------
258265
**postInstrumentIdentifierRequest** | [**PostInstrumentIdentifierRequest**](PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card |
259266
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
267+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
260268

261269
### Return type
262270

docs/Microformv2sessionsCheckoutApiInitialization.md

-17
This file was deleted.

docs/OctCreatePaymentRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
1010
**senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional]
1111
**processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional]
1212
**paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional]
13+
**aggregatorInformation** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional]
1314

1415

docs/PatchInstrumentIdentifierRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
1616
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
1717
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
1818
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19+
**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
1920

2021

docs/PaymentInstrumentApi.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ var apiInstance = new CyberSource.PaymentInstrumentApi();
7777
var paymentInstrumentId = "paymentInstrumentId_example"; // String | The Id of a payment instrument.
7878

7979
var opts = {
80-
'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
80+
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
81+
'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
8182
};
8283

8384
var callback = function(error, data, response) {
@@ -96,6 +97,7 @@ Name | Type | Description | Notes
9697
------------- | ------------- | ------------- | -------------
9798
**paymentInstrumentId** | **String**| The Id of a payment instrument. |
9899
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
100+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
99101

100102
### Return type
101103

@@ -130,6 +132,7 @@ var patchPaymentInstrumentRequest = new CyberSource.PatchPaymentInstrumentReques
130132

131133
var opts = {
132134
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
135+
'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
133136
'ifMatch': "ifMatch_example" // String | Contains an ETag value from a GET request to make the request conditional.
134137
};
135138

@@ -150,6 +153,7 @@ Name | Type | Description | Notes
150153
**paymentInstrumentId** | **String**| The Id of a payment instrument. |
151154
**patchPaymentInstrumentRequest** | [**PatchPaymentInstrumentRequest**](PatchPaymentInstrumentRequest.md)| |
152155
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
156+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
153157
**ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
154158

155159
### Return type
@@ -182,7 +186,8 @@ var apiInstance = new CyberSource.PaymentInstrumentApi();
182186
var postPaymentInstrumentRequest = new CyberSource.PostPaymentInstrumentRequest(); // PostPaymentInstrumentRequest |
183187

184188
var opts = {
185-
'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
189+
'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
190+
'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
186191
};
187192

188193
var callback = function(error, data, response) {
@@ -201,6 +206,7 @@ Name | Type | Description | Notes
201206
------------- | ------------- | ------------- | -------------
202207
**postPaymentInstrumentRequest** | [**PostPaymentInstrumentRequest**](PostPaymentInstrumentRequest.md)| |
203208
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
209+
**retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
204210

205211
### Return type
206212

docs/PostInstrumentIdentifierEnrollmentRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
1616
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
1717
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
1818
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19+
**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
1920

2021

docs/PostInstrumentIdentifierRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
1616
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
1717
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
1818
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19+
**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
1920

2021

0 commit comments

Comments
 (0)