CyberSource · monu-kumar-visa · Feb 5, 2025 · Feb 5, 2025 · Feb 6, 2025 · Feb 6, 2025
diff --git a/MLE.md b/MLE.md
@@ -0,0 +1,109 @@
+[![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
+
+# Message Level Encryption (MLE) Feature
+
+This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
+
+## Configuration
+
+### Global MLE Configuration
+
+In the `merchantConfig` object, set the `useMLEGlobally` variable to enable or disable MLE for all supported APIs for the Rest SDK.
+
+- **Variable**: `useMLEGlobally`
+- **Type**: `Boolean`
+- **Default**: `false`
+- **Description**: Enables MLE globally for all APIs when set to `true`. If set to `true`, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by `mapToControlMLEonAPI`.
+
+### API-level MLE Control
+
+Optionally, you can control the MLE feature at the API level using the `mapToControlMLEonAPI` variable in the `merchantConfig` object.
+
+- **Variable**: `mapToControlMLEonAPI`
+- **Type**: `Hash of string to boolean`
+- **Description**: Overrides the global MLE setting for specific APIs. The key is the function name of the API in the SDK, and the value is a boolean indicating whether MLE should be enabled (`true`) or disabled (`false`) for that specific API call.
+
+### MLE Key Alias
+
+Another optional parameter for MLE is `mleKeyAlias`, which specifies the key alias used to retrieve the MLE certificate from the JWT P12 file.
+
+- **Variable**: `mleKeyAlias`
+- **Type**: `String`
+- **Default**: `CyberSource_SJC_US`
+- **Description**: By default, CyberSource uses the `CyberSource_SJC_US` public certificate to encrypt the payload. However, users can override this default value by setting their own key alias.
+
+## Notes
+
+- If `useMLEGlobally` is set to true, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by `mapToControlMLEonAPI`.
+- If `mapToControlMLEonAPI` is not provided or does not contain a specific API function name, the global `useMLEGlobally` setting will be applied.
+- The `mleKeyAlias` parameter is optional and defaults to `CyberSource_SJC_US` if not specified by the user. Users can override this default value by setting their own key alias.
+- Example configurations contain only properties related to MLE.
+
+## Example Configuration
+
+### Option 1: Enable MLE globally for all MLE supported APIs
+
+```ruby
+configuration_dictionary = {
+"useMLEGlobally": true  # Globally MLE will be enabled for all MLE supported APIs
+}
+```
+
+### Option 2: Enable/Disable MLE for specific APIs
+
+```ruby
+configuration_dictionary = {}
+configuration_dictionary['useMLEGlobally'] = true # globally MLE will be enabled for all the MLE supported APIs by Cybs in SDK
+mapToControlMLE = {
+  'create_payment' => false, # only create_payment function will have MLE=false i.e. (/pts/v2/payments POST API) out of all MLE supported APIs
+  'capture_payment' => true # capture_payment function will have MLE=true i.e.  (/pts/v2/payments/{id}/captures POST API), if it not in list of MLE supportedAPIs else it will already have MLE=true by global MLE parameter.
+}
+configuration_dictionary['mapToControlMLEonAPI'] = mapToControlMLE
+# Set other properties
+api_client = CyberSource::ApiClient.new
+# Create API instance using the configuration dictionary
+api_instance = CyberSource::PaymentsApi.new(api_client, configuration_dictionary)
+
+```
+
+### Option 3: Disable MLE globally and enable for specific APIs
+
+```ruby
+configuration_dictionary = {
+  "useMLEGlobally": false,  # Globally MLE will be disabled for all APIs
+  "mleKeyAlias": "Custom_Key_Alias" # optional if any custom value provided by Cybs
+}
+mapToControlMLE = {
+  'apiFunctionName1' => false, # MLE will be disabled for this API
+  'apiFunctionName2' => true # MLE will be enabled for this API
+}
+configuration_dictionary['mapToControlMLEonAPI'] = mapToControlMLE
+```
+
+In the above examples:
+- MLE is enabled/disabled globally (`useMLEGlobally` is true/false).
+- `apiFunctionName1` will have MLE disabled/enabled based on value provided.
+- `apiFunctionName2` will have MLE enabled.
+- `mleKeyAlias` is set to `Custom_Key_Alias`, overriding the default value.
+
+Please refer to the given link for sample codes with MLE: [MLE Samples](https://github.com/CyberSource/cybersource-rest-samples-ruby/tree/master/Samples/MLEFeature)
+
+
+## Additional Information
+
+### API Support
+
+- MLE is initially designed to support a few APIs.
+- It can be extended to support more APIs in the future based on requirements and updates.
+
+### Authentication Type
+
+- MLE is only supported with `JWT (JSON Web Token)` authentication type within the SDK.
+
+### Using the SDK
+
+To use the MLE feature in the SDK, configure the `merchantConfig` object as shown above and pass it to the SDK initialization.
+
+## Contact
+
+For any issues or further assistance, please open an issue on the GitHub repository or contact our support team.
diff --git a/README.md b/README.md
@@ -76,6 +76,13 @@ API credentials are different for each environment, so be sure to switch to the
 
 ## Features
 
+### Message Level Encryption (MLE) Feature
+[![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
+
+This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
+
+More information about this new MLE feature can be found in this file : [MLE.md](MLE.md)
+
 ### MetaKey Support
 
 A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.

diff --git a/...mmerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md b/...mmerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parent_profile_id** | **String** | Specify the Vault ID to which transacting MID needs to be assigned.Provide Vault ID as seen on EBC Vault management page. If not provided , transacting MID will be assigned to the existing default Vault at merchant&#39;s level. If there are no Vaults at merchant level , a new Vault will be created and transacting MID will be assigned to it. | [optional] 
 **vault** | [**CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault**](CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md) |  | [optional] 
+**network_token_enrollment** | [**NetworkTokenEnrollment**](NetworkTokenEnrollment.md) |  | [optional] 
 
 
diff --git a/docs/GenerateCaptureContextRequest.md b/docs/GenerateCaptureContextRequest.md
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_version** | **String** | Specify the version of Microform that you want to use.  | [optional] 
 **target_origins** | **Array&lt;String&gt;** | 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&lt;br&gt;&lt;br&gt;  If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:    targetOrigins: [     \&quot;https://example.com\&quot;,     \&quot;https://basket.example.com\&quot;,     \&quot;https://ecom.example.com\&quot;   ]  | [optional] 
-**allowed_card_networks** | **Array&lt;String&gt;** | 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] 
+**allowed_card_networks** | **Array&lt;String&gt;** | 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 (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.   - When integrating Microform (ACH/Echeck) the allowedCardNetworks field is not required in the capture context request.   - When integrating both Microform (Card) and Microform (ACH/Echeck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.  | [optional] 
 **allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant.    Possible values when launching Microform: - CARD - CHECK &lt;br&gt;&lt;br&gt;  | [optional] 
+**transient_token_response_options** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) |  | [optional] 
 
 
diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **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] 
 **capture_mandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) |  | [optional] 
 **order_information** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) |  | [optional] 
+**transient_token_response_options** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) |  | [optional] 
 
 
diff --git a/docs/Microformv2sessionsTransientTokenResponseOptions.md b/docs/Microformv2sessionsTransientTokenResponseOptions.md
@@ -0,0 +1,8 @@
+# CyberSource::Microformv2sessionsTransientTokenResponseOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**include_card_prefix** | **BOOLEAN** | Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.  Possible values: - True - False&lt;br&gt;&lt;br&gt;  To select the type of card number prefix: - No field included: A 6-digit prefix is returned (default) - True: An 8-digit prefix is returned - False: No prefix is returned&lt;br&gt;&lt;br&gt;  The following conditions apply: - 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more. - Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true. - Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true. - If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.&lt;br&gt;&lt;br&gt;  **Important:**  If your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False.  This will minimize your personal data exposure.  | [optional] 
+
+
diff --git a/docs/NetworkTokenEnrollment.md b/docs/NetworkTokenEnrollment.md
@@ -0,0 +1,9 @@
+# CyberSource::NetworkTokenEnrollment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**business_information** | [**TmsBusinessInformation**](TmsBusinessInformation.md) |  | [optional] 
+**network_token_services** | [**NetworkTokenServicesEnablement**](NetworkTokenServicesEnablement.md) |  | [optional] 
+
+
diff --git a/docs/NetworkTokenServicesEnablement.md b/docs/NetworkTokenServicesEnablement.md
@@ -0,0 +1,9 @@
+# CyberSource::NetworkTokenServicesEnablement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visa_token_service** | [**NetworkTokenServicesEnablementVisaTokenService**](NetworkTokenServicesEnablementVisaTokenService.md) |  | [optional] 
+**mastercard_digital_enablement_service** | [**NetworkTokenServicesEnablementMastercardDigitalEnablementService**](NetworkTokenServicesEnablementMastercardDigitalEnablementService.md) |  | [optional] 
+
+
diff --git a/docs/NetworkTokenServicesEnablementMastercardDigitalEnablementService.md b/docs/NetworkTokenServicesEnablementMastercardDigitalEnablementService.md
@@ -0,0 +1,8 @@
+# CyberSource::NetworkTokenServicesEnablementMastercardDigitalEnablementService
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enrollment** | **BOOLEAN** | Indicates if an enrollment to create a TRID for the MasterCard card association should be attempted | [optional] 
+
+
diff --git a/docs/NetworkTokenServicesEnablementVisaTokenService.md b/docs/NetworkTokenServicesEnablementVisaTokenService.md
@@ -0,0 +1,8 @@
+# CyberSource::NetworkTokenServicesEnablementVisaTokenService
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enrollment** | **BOOLEAN** | Indicates if an enrollment to create a TRID for the Visa card association should be attempted | [optional] 
+
+
diff --git a/docs/TmsBusinessInformation.md b/docs/TmsBusinessInformation.md
@@ -0,0 +1,14 @@
+# CyberSource::TmsBusinessInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the network token merchant. | [optional] 
+**doing_business_as** | **String** | Name the network token merchant does business as | [optional] 
+**address** | [**TmsBusinessInformationAddress**](TmsBusinessInformationAddress.md) |  | [optional] 
+**website_url** | **String** | Website of network token merchant. | [optional] 
+**business_identification_type** | **String** | The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided.  | [optional] 
+**business_identification_value** | **String** | The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided.  | [optional] 
+**acquirer** | [**TmsBusinessInformationAcquirer**](TmsBusinessInformationAcquirer.md) |  | [optional] 
+
+
diff --git a/docs/TmsBusinessInformationAcquirer.md b/docs/TmsBusinessInformationAcquirer.md
@@ -0,0 +1,9 @@
+# CyberSource::TmsBusinessInformationAcquirer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acquirer_id** | **String** | Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided.  | [optional] 
+**acquirer_merchant_id** | **String** | Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided.  | [optional] 
+
+
diff --git a/docs/TmsBusinessInformationAddress.md b/docs/TmsBusinessInformationAddress.md
@@ -0,0 +1,9 @@
+# CyberSource::TmsBusinessInformationAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country** | **String** | Country of network token merchant. | [optional] 
+**locality** | **String** | City of network token merchant. | [optional] 
+
+
diff --git a/docs/Upv1capturecontextsCaptureMandate.md b/docs/Upv1capturecontextsCaptureMandate.md
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
 **request_shipping** | **BOOLEAN** | Configure Unified Checkout to capture customer shipping details.  Possible values: - True - False  | [optional] 
 **ship_to_countries** | **Array&lt;String&gt;** | List of countries available to ship to.   Use the two-character ISO Standard Country Codes.  | [optional] 
 **show_accepted_network_icons** | **BOOLEAN** | Configure Unified Checkout to display the list of accepted card networks beneath the payment button  Possible values: - True - False  | [optional] 
+**request_save_card** | **BOOLEAN** | Configure Unified Checkout to display the \&quot;Save card for future use\&quot; checkbox.&lt;br&gt;  Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.&lt;br&gt;  Applicable when manually entering the details and not enrolling in Click to Pay.  Possible values:  - True   - False&lt;br&gt;&lt;br&gt;  **Use Cases:**  **Offer consumers option to save their card in Unified Checkout:**  - Include the captureMandate.requestSaveCard field in the capture context request and set it to true. - When set to true, this will show a checkbox with the message &#39;Save card for future use&#39; in Unified Checkout. - When selected this provides a response in both the Transient Token and Get Credentials API response.&lt;br&gt;&lt;br&gt;  **Do not offer consumers the option to save their card in Unified Checkout:**  - Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request. - When set to false, the save card option is not shown to consumers when manually entering card details.  | [optional] 
+**combo_card** | **BOOLEAN** | Configure Unified Checkout to display combo card at checkout.&lt;br&gt;  A combo debit/credit card is a single card that functions both as a Debit/Credit card.  Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card. **Important:** This is applicable to Visa cards only.  Possible values: - True  - False&lt;br&gt;&lt;br&gt;  **Use Cases:**  **Offer Combo Card at Checkout:**  - Include the captureMandate.comboCard field in the capture context request and set it to true. - When set to true, Combo Card selection is shown at checkout &lt;br&gt;&lt;br&gt;  **Do not offer Combo Card at Checkout:**  - Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request. - The Combo Card selection is not shown at checkout.  | [optional]