Merge pull request #118 from CyberSource/nov24-release

nov24 release spec changes
CyberSource · Dec 10, 2024 · 0733461 · 0733461
2 parents 77a6a4a + 297f92c
commit 0733461
Show file tree

Hide file tree

Showing 83 changed files with 5,461 additions and 593 deletions.
diff --git a/cybersource_rest_client.gemspec b/cybersource_rest_client.gemspec
@@ -17,7 +17,7 @@ require "cybersource_rest_client/version"
 
 Gem::Specification.new do |s|
   s.name        = "cybersource_rest_client"
-  s.version     = "0.0.67"
+  s.version     = "0.0.68"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["CyberSource"]
   s.email       = ["[email protected]"]

diff --git a/...mmerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md b/...mmerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md
@@ -4,5 +4,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] 
 
 
diff --git a/...eSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md b/...eSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md
@@ -0,0 +1,14 @@
+# CyberSource::CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_token_type** | **String** | Default token type to be used. Possible Values:   - &#39;CUSTOMER&#39;  - &#39;PAYMENT_INSTRUMENT&#39;  - &#39;INSTRUMENT_IDENTIFIER&#39;  | [optional] 
+**location** | **String** | Location where the vault will be stored.  Use &#39;IDC&#39; (the Indian Data Centre) when merchant is storing token data in India  or &#39;GDC&#39; (the Global Data Centre) for all other cases.  Possible Values:    - &#39;IDC&#39;   - &#39;GDC&#39;  | [optional] 
+**token_formats** | [**TmsTokenFormats**](TmsTokenFormats.md) |  | [optional] 
+**token_permissions** | [**TokenPermissions**](TokenPermissions.md) |  | [optional] 
+**sensitive_privileges** | [**TmsSensitivePrivileges**](TmsSensitivePrivileges.md) |  | [optional] 
+**nullify** | [**TmsNullify**](TmsNullify.md) |  | [optional] 
+**network_token_services** | [**TmsNetworkTokenServices**](TmsNetworkTokenServices.md) |  | [optional] 
+
+
diff --git a/docs/ECheckConfigCommonInternalOnlyProcessors.md b/docs/ECheckConfigCommonInternalOnlyProcessors.md
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **terminal_id** | **String** | *NEW* The &#39;Terminal Id&#39; aka TID, is an identifier used for with your payments processor. Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions. Applicable for VPC processors.  | [optional] 
 **enable15an_transaction_reference_number** | **BOOLEAN** | *NEW* This ensures the transaction reference # contains an identifier that can be viewed in CYBS | [optional] [default to true]
 **portal_supported_paytypes** | **String** | *NEW* This is used by the EBC2 application | [optional] [default to &#39;CHECK&#39;]
-**settlement_method** | **Object** | *NEW* | [optional] 
-**verification_level** | **Object** | *NEW* | [optional] 
+**settlement_method** | **String** | *NEW*  Possible values: - BEST_GUESS | [optional] [default to &#39;BEST_GUESS&#39;]
+**verification_level** | **String** | *NEW*  Possible values: - VALIDATION | [optional] [default to &#39;VALIDATION&#39;]
 **set_completed_state** | **BOOLEAN** | *Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES. | [optional] [default to false]
 
 
diff --git a/docs/ECheckConfigCommonProcessors.md b/docs/ECheckConfigCommonProcessors.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **company_id** | **String** | *EXISTING* company ID assigned to merchant by Acquiring bank. This field is alphanumeric | [optional] 
 **batch_group** | **String** | *EXISTING* Capture requests are grouped into a batch bound for your payment processor. The batch time can be identified by reading the last 2-digits as military time. E.g., &lt;processor&gt;_16 &#x3D; your processing cutoff is 4PM PST. Please note if you are in a different location you may then need to convert time zone as well. | [optional] 
 **enable_accuity_for_avs** | **BOOLEAN** | *NEW* Accuity is the original validation service that checks the account/routing number for formatting issues. Used by WF and set to \&quot;Yes\&quot; unless told otherwise | [optional] [default to true]
-**accuity_check_type** | **Object** | *NEW* | [optional] 
+**accuity_check_type** | **String** | *NEW*  Possible values: - ALWAYS | [optional] [default to &#39;ALWAYS&#39;]
 **set_completed_state** | **BOOLEAN** | *Moved* When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES. | [optional] [default to false]
 
 
diff --git a/docs/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors.md b/docs/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors.md
@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**avs_version** | **Object** | *NEW* | [optional] 
+**avs_version** | **String** | *NEW*  Possible values: - 2 | [optional] [default to &#39;2&#39;]
 
 
diff --git a/docs/ECheckConfigFeaturesAccountValidationServiceProcessors.md b/docs/ECheckConfigFeaturesAccountValidationServiceProcessors.md
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 **avs_account_ownership_service** | **BOOLEAN** | *NEW* Determined in WF eTicket if account has opted into the Account Ownership Service. | [optional] 
 **avs_account_status_service** | **BOOLEAN** | *NEW* Determined in WF eTicket if account has opted into the Account Status Service. | [optional] 
 **avs_signed_agreement** | **BOOLEAN** | *NEW* Taken from Addendum Agreement Column in boarding form. | [optional] 
-**avs_calculated_response_behavior** | **Object** | *NEW* | [optional] 
+**avs_calculated_response_behavior** | **String** | *NEW*  Possible values: - continue | [optional] [default to &#39;continue&#39;]
 **avs_additional_id** | **String** | *NEW* Also known as the Additional ID. Taken from the boarding form. | [optional] 
 **enable_avs** | **BOOLEAN** | *NEW* | [optional] [default to true]
 **avs_entity_id** | **String** | *NEW* Also known as the AVS Gateway Entity ID. | [optional] 
-**avs_result_mode** | **Object** | *NEW* | [optional] 
+**avs_result_mode** | **String** | *NEW*  Possible values: - FULL_RESPONSE - LOGIC_BOX | [optional] 
 **enable_avs_token_creation** | **BOOLEAN** | *NEW* Applicable if the merchant wants to run AVS on token creation requests only. | [optional] [default to false]
 
 
diff --git a/docs/GenerateCaptureContextRequest.md b/docs/GenerateCaptureContextRequest.md
@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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 - MAESTRO - MASTERCARD - AMEX - DISCOVER - DINERSCLUB - JCB - CUP - CARTESBANCAIRES - CARNET  | [optional] 
 **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  | [optional] 
 **checkout_api_initialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) |  | [optional] 
 
 
diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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 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&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] 
 **client_version** | **String** | Specify the version of Unified Checkout that you want to use. | [optional] 
-**allowed_card_networks** | **Array&lt;String&gt;** | 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   - DISCOVER   - DINERSCLUB   - JCB  | [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 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&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 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] 
 **allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant.    Possible values when launching Unified Checkout:   - PANENTRY                 - GOOGLEPAY   - SRC   - CHECK &lt;br&gt;&lt;br&gt;  Possible values when launching Unified Checkout with Checkout API: - PANENTRY               - SRC &lt;br&gt;&lt;br&gt;  Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt;  **Important:**    - SRC and CLICKTOPAY are only available for Visa, Mastercard and AMEX.  | [optional] 
 **country** | **String** | Country the purchase is originating from (e.g. country of the merchant).  Use the two-character ISO Standard  | [optional] 
 **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] 

diff --git a/docs/Ptsv2paymentsPaymentInformationCard.md b/docs/Ptsv2paymentsPaymentInformationCard.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **start_month** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. &#x60;Format: MM&#x60;. Possible values: 01 through 12.  **Note** The start date is not required for Maestro (UK Domestic) transactions.  | [optional] 
 **start_year** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. &#x60;Format: YYYY&#x60;.  **Note** The start date is not required for Maestro (UK Domestic) transactions.  | [optional] 
 **product_name** | **String** | Name of the card product.  Possible value: - BNDES  This field is supported only for BNDES transactions on CyberSource through VisaNet.  The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data  | [optional] 
+**product_subtype** | **String** | This field would contain the indicator for transaction type  Possible values: - AC: Agriculture Maintenance Account - AE: Agriculture Debit Account/Electron  - AG: Agriculture  - AI: Agriculture Investment Loan - CG: Brazil Cargo - CS: Construction  - DS: Distribution  - HC: Healthcare - LP: Visa Large Purchase Advantage - MA: Visa Mobile Agent - MB: Interoperable Mobile Branchless Banking - MG: Visa Mobile General - VA: Visa Vale - Supermarket - VF: Visa Vale - Fuel - VR: Visa Vale - Restaurant  | [optional] 
 **type_selection_indicator** | **String** | Flag that identifies how the card type was selected.  Possible values: - 0: Card type was selected based on default acquirer settings. - 1: Customer selected the card type.  | [optional] 
 
 
diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **bin_source** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay  | [optional] 
 **capture** | **BOOLEAN** | Indicates whether to also include a capture  in the submitted authorization request or not.  Possible values: - &#x60;true&#x60;: Include a capture with an authorization request. - &#x60;false&#x60;: (default) Do not include a capture with an authorization request.  #### Used by **Authorization and Capture** Optional field.  | [optional] [default to false]
 **processor_id** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**.  Contact CyberSource Customer Support to get the value for this field.  | [optional] 
-**business_application_id** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account.  | [optional] 
+**business_application_id** | **String** | Required for AFT and OCT transactions.  Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values.  - AA : Account-to-account  - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement  - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet   | [optional] 
 **commerce_indicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates.  #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional.  The list of valid values in this field depends on your processor.  #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value   #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \&quot;moto\&quot;  | [optional] 
 **commerce_indicator_label** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates.  #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional.  The list of valid values in this field depends on your processor.  #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value   #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as &#x60;moto&#x60;  | [optional] 
 **payment_solution** | **String** | Type of digital payment solution for the transaction. Possible Values:   - &#x60;visacheckout&#x60;: Visa Checkout. This value is required for Visa Checkout transactions. For details, see &#x60;payment_solution&#x60; field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)  - &#x60;001&#x60;: Apple Pay.  - &#x60;004&#x60;: Cybersource In-App Solution.  - &#x60;005&#x60;: Masterpass. This value is required for Masterpass transactions on OmniPay Direct.   - &#x60;006&#x60;: Android Pay.  - &#x60;007&#x60;: Chase Pay.  - &#x60;008&#x60;: Samsung Pay.  - &#x60;012&#x60;: Google Pay.  - &#x60;013&#x60;: Cybersource P2PE Decryption  - &#x60;014&#x60;: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.  - &#x60;015&#x60;: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.  - &#x60;027&#x60;: Click to Pay.  | [optional]