Merge pull request #50 from CyberSource/nov2020

November 2020 Release
CyberSource · Nov 11, 2020 · 0597767 · 0597767
2 parents 9506a50 + bdab3dd
commit 0597767
Show file tree

Hide file tree

Showing 74 changed files with 1,582 additions and 125 deletions.
diff --git a/docs/CustomerPaymentInstrumentApi.md b/docs/CustomerPaymentInstrumentApi.md
@@ -227,6 +227,8 @@ No authorization required
 
 Create a Customer Payment Instrument
 
+Include an existing TMS Customer &amp; Instrument Identifier token id in the request. * A Customer token can be created by calling: **POST *_/tms/v2/customers*** * An Instrument Identifier token can be created by calling: **POST *_/tms/v1/instrumentidentifiers*** 
+
 ### Example
 ```javascript
 var CyberSource = require('CyberSource');

diff --git a/docs/CustomerShippingAddressApi.md b/docs/CustomerShippingAddressApi.md
@@ -227,6 +227,8 @@ No authorization required
 
 Create a Customer Shipping Address
 
+Include an existing TMS Customer token id in the request URI. * A Customer token can be created by calling: **POST *_/tms/v2/customers*** 
+
 ### Example
 ```javascript
 var CyberSource = require('CyberSource');

diff --git a/docs/InvoiceSettingsRequest.md b/docs/InvoiceSettingsRequest.md
@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**invoiceSettingsInformation** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md) |  | [optional] 
+**invoiceSettingsInformation** | [**Invoicingv2invoiceSettingsInvoiceSettingsInformation**](Invoicingv2invoiceSettingsInvoiceSettingsInformation.md) |  | [optional] 
 
 
diff --git a/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md b/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) |  | [optional] 
 **deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are &#x60;zh-CN&#x60;, &#x60;zh-TW&#x60;, &#x60;en-US&#x60;, &#x60;fr-FR&#x60;, &#x60;de-DE&#x60;, &#x60;ja-JP&#x60;, &#x60;pt-BR&#x60;, &#x60;ru-RU&#x60; and &#x60;es-419&#x60;. | [optional] 
 **defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  #### Used by **Authorization** Required field.  **Authorization Reversal** For an authorization reversal (&#x60;reversalInformation&#x60;) or a capture (&#x60;processingOptions.capture&#x60; is set to &#x60;true&#x60;), you must use the same currency that you used in your payment authorization request.  #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase.  For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit.  #### DCC for First Data Your local currency. For details, see the &#x60;currency&#x60; field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).  #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.  | [optional] 
+**payerAuthentication3DSVersion** | **String** | The 3D Secure payer authentication version or status for a merchant&#39;s invoice payments. Possible values are: - &#x60;1&#x60; - &#x60;2&#x60; - &#x60;None&#x60; - &#x60;Disabled&#x60;  | [optional] 
 
 
diff --git a/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md b/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md
@@ -0,0 +1,15 @@
+# CyberSource.Invoicingv2invoiceSettingsInvoiceSettingsInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchantLogo** | **String** | The image file, which must be encoded in Base64 format. Supported file formats are &#x60;png&#x60;, &#x60;jpg&#x60;, and &#x60;gif&#x60;. The image file size restriction is 1 MB. | [optional] 
+**merchantDisplayName** | **String** | The merchant&#39;s display name shown on the invoice. | [optional] 
+**customEmailMessage** | **String** | The content of the email message that we send to your customers. | [optional] 
+**enableReminders** | **Boolean** | Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due. | [optional] 
+**headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) |  | [optional] 
+**deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are &#x60;zh-CN&#x60;, &#x60;zh-TW&#x60;, &#x60;en-US&#x60;, &#x60;fr-FR&#x60;, &#x60;de-DE&#x60;, &#x60;ja-JP&#x60;, &#x60;pt-BR&#x60;, &#x60;ru-RU&#x60; and &#x60;es-419&#x60;. | [optional] 
+**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  #### Used by **Authorization** Required field.  **Authorization Reversal** For an authorization reversal (&#x60;reversalInformation&#x60;) or a capture (&#x60;processingOptions.capture&#x60; is set to &#x60;true&#x60;), you must use the same currency that you used in your payment authorization request.  #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase.  For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit.  #### DCC for First Data Your local currency. For details, see the &#x60;currency&#x60; field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).  #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.  | [optional] 
+**payerAuthenticationInInvoicing** | **String** | For a merchant&#39;s invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are:  - &#x60;enable&#x60; - &#x60;update&#x60; - &#x60;disable&#x60;   | [optional] 
+
+
diff --git a/docs/PatchCustomerPaymentInstrumentRequest.md b/docs/PatchCustomerPaymentInstrumentRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) |  | [optional] 
 **id** | **String** | The id of the Payment Instrument Token. | [optional] 
 **_object** | **String** | The type of token.  Valid values: - paymentInstrument  | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer payment instrument is the dafault. Valid values:  - &#x60;true&#x60;: Payment instrument is customer&#39;s default.  - &#x60;false&#x60;: Payment instrument is not customer&#39;s default.  | [optional] 
 **state** | **String** | Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed.  | [optional] 
 **bankAccount** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) |  | [optional] 
 **card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) |  | [optional] 

diff --git a/docs/PatchCustomerShippingAddressRequest.md b/docs/PatchCustomerShippingAddressRequest.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **links** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) |  | [optional] 
 **id** | **String** | The id of the Shipping Address Token. | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer shipping address is the dafault. Valid values:  - &#x60;true&#x60;: Shipping Address is customer&#39;s default.  - &#x60;false&#x60;: Shipping Address is not customer&#39;s default.  | [optional] 
 **shipTo** | [**Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) |  | [optional] 
 **metadata** | [**Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md) |  | [optional] 
 

diff --git a/docs/PatchPaymentInstrumentRequest.md b/docs/PatchPaymentInstrumentRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) |  | [optional] 
 **id** | **String** | The id of the Payment Instrument Token. | [optional] 
 **_object** | **String** | The type of token.  Valid values: - paymentInstrument  | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer payment instrument is the dafault. Valid values:  - &#x60;true&#x60;: Payment instrument is customer&#39;s default.  - &#x60;false&#x60;: Payment instrument is not customer&#39;s default.  | [optional] 
 **state** | **String** | Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed.  | [optional] 
 **bankAccount** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) |  | [optional] 
 **card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) |  | [optional] 

diff --git a/docs/PaymentInstrumentApi.md b/docs/PaymentInstrumentApi.md
@@ -165,6 +165,8 @@ No authorization required
 
 Create a Payment Instrument
 
+Include an existing TMS Instrument Identifier id in the request body. * An Instrument Identifier token can be created by calling: **POST *_/tms/v1/instrumentidentifiers*** 
+
 ### Example
 ```javascript
 var CyberSource = require('CyberSource');

diff --git a/docs/PostCustomerPaymentInstrumentRequest.md b/docs/PostCustomerPaymentInstrumentRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) |  | [optional] 
 **id** | **String** | The id of the Payment Instrument Token. | [optional] 
 **_object** | **String** | The type of token.  Valid values: - paymentInstrument  | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer payment instrument is the dafault. Valid values:  - &#x60;true&#x60;: Payment instrument is customer&#39;s default.  - &#x60;false&#x60;: Payment instrument is not customer&#39;s default.  | [optional] 
 **state** | **String** | Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed.  | [optional] 
 **bankAccount** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) |  | [optional] 
 **card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) |  | [optional] 

diff --git a/docs/PostCustomerShippingAddressRequest.md b/docs/PostCustomerShippingAddressRequest.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **links** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) |  | [optional] 
 **id** | **String** | The id of the Shipping Address Token. | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer shipping address is the dafault. Valid values:  - &#x60;true&#x60;: Shipping Address is customer&#39;s default.  - &#x60;false&#x60;: Shipping Address is not customer&#39;s default.  | [optional] 
 **shipTo** | [**Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) |  | [optional] 
 **metadata** | [**Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md) |  | [optional] 
 

diff --git a/docs/PostPaymentInstrumentRequest.md b/docs/PostPaymentInstrumentRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) |  | [optional] 
 **id** | **String** | The id of the Payment Instrument Token. | [optional] 
 **_object** | **String** | The type of token.  Valid values: - paymentInstrument  | [optional] 
+**_default** | **Boolean** | Flag that indicates whether customer payment instrument is the dafault. Valid values:  - &#x60;true&#x60;: Payment instrument is customer&#39;s default.  - &#x60;false&#x60;: Payment instrument is not customer&#39;s default.  | [optional] 
 **state** | **String** | Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed.  | [optional] 
 **bankAccount** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) |  | [optional] 
 **card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) |  | [optional] 

diff --git a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **challengeCancelCode** | **String** | An indicator as to why the transaction was canceled. Possible Values:  - &#x60;01&#x60;: Cardholder selected Cancel. - &#x60;02&#x60;: Reserved for future EMVCo use (values invalid until defined by EMVCo). - &#x60;03&#x60;: Transaction Timed Out—Decoupled Authentication - &#x60;04&#x60;: Transaction timed out at ACS—other timeouts - &#x60;05&#x60;: Transaction Timed out at ACS - First CReq not received by ACS - &#x60;06&#x60;: Transaction Error - &#x60;07&#x60;: Unknown - &#x60;08&#x60;: Transaction Timed Out at SDK  | [optional] 
 **challengeRequired** | **String** | Indicates whether a challenge is required in order to complete authentication. **Note** Regional mandates might determine that a challenge is required.  Possible values: - &#x60;Y&#x60;: Challenge required - &#x60;N&#x60;: Challenge not required **Note**  Used by the Hybrid integration.  | [optional] 
 **decoupledAuthenticationIndicator** | **String** | Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use.  Possible Values:  Y - Decoupled Authentication is supported and preferred if challenge is necessary  N - Do not use Decoupled Authentication  **Default Value**: N  | [optional] 
-**directoryServerErrorCode** | **String** | The directory server error code indicating a problem with this transaction.  | [optional] 
+**directoryServerErrorCode** | **String** | The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters.  | [optional] 
 **directoryServerErrorDescription** | **String** | Directory server text and additional detail about the error for this transaction.  | [optional] 
 **ecommerceIndicator** | **String** | Commerce indicator for cards not enrolled. This field contains one of these values: - &#x60;internet&#x60;: Card not enrolled, or card type not supported by payer authentication. No liability shift. - &#x60;js_attempted&#x60;: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - &#x60;js_failure&#x60;: J/Secure directory service is not available. No liability shift. - &#x60;spa&#x60;: Mastercard card not enrolled in the SecureCode program. No liability shift. - &#x60;vbv_attempted&#x60;: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - &#x60;vbv_failure&#x60;: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa’s directory service is not available. No liability shift.  | [optional] 
 **eci** | **String** | Note This field applies only to non-U.S-issued cards.  For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \&quot;Interpreting the Reply,\&quot; page 22.  If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - &#x60;06&#x60;: The card can be enrolled. Liability shift. - &#x60;07&#x60;: The card cannot be enrolled. No liability shift.  For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - &#x60;05&#x60;: Successful authentication - &#x60;06&#x60;: Authentication attempted - &#x60;07&#x60;: Failed authentication (No response from the merchant because of a problem.)  | [optional]