cybersource-rest-client 0.0.62 → 0.0.63

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/MLE.md +98 -0
  2. package/README.md +7 -0
  3. package/cybersource-rest-client-0.0.61.tgz +0 -0
  4. package/docs/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md +1 -0
  5. package/docs/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md +14 -0
  6. package/docs/ECheckConfigCommonInternalOnlyProcessors.md +2 -2
  7. package/docs/ECheckConfigCommonProcessors.md +1 -1
  8. package/docs/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors.md +1 -1
  9. package/docs/ECheckConfigFeaturesAccountValidationServiceProcessors.md +2 -2
  10. package/docs/GenerateCaptureContextRequest.md +2 -2
  11. package/docs/GenerateUnifiedCheckoutCaptureContextRequest.md +2 -2
  12. package/docs/Ptsv2paymentsPaymentInformationCard.md +1 -0
  13. package/docs/Ptsv2paymentsProcessingInformation.md +1 -1
  14. package/docs/Ptsv2paymentsProcessingInformationJapanPaymentOptions.md +1 -5
  15. package/docs/Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md +9 -0
  16. package/docs/Ptsv2paymentsRecipientInformation.md +7 -7
  17. package/docs/Ptsv2paymentsSenderInformation.md +7 -7
  18. package/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md +1 -1
  19. package/docs/TmsNetworkTokenServices.md +13 -0
  20. package/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md +11 -0
  21. package/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md +10 -0
  22. package/docs/TmsNetworkTokenServicesNotifications.md +8 -0
  23. package/docs/TmsNetworkTokenServicesPaymentCredentials.md +8 -0
  24. package/docs/TmsNetworkTokenServicesSynchronousProvisioning.md +8 -0
  25. package/docs/TmsNetworkTokenServicesVisaTokenService.md +11 -0
  26. package/docs/TmsNullify.md +10 -0
  27. package/docs/TmsSensitivePrivileges.md +8 -0
  28. package/docs/TmsTokenFormats.md +11 -0
  29. package/docs/TokenPermissions.md +11 -0
  30. package/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +1 -1
  31. package/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md +5 -0
  32. package/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +1 -1
  33. package/package.json +1 -1
  34. package/src/api/BatchesApi.js +80 -24
  35. package/src/api/BillingAgreementsApi.js +61 -19
  36. package/src/api/BinLookupApi.js +23 -9
  37. package/src/api/CaptureApi.js +23 -9
  38. package/src/api/ChargebackDetailsApi.js +23 -9
  39. package/src/api/ChargebackSummariesApi.js +23 -9
  40. package/src/api/ConversionDetailsApi.js +23 -9
  41. package/src/api/CreateNewWebhooksApi.js +61 -19
  42. package/src/api/CreditApi.js +23 -9
  43. package/src/api/CustomerApi.js +80 -24
  44. package/src/api/CustomerPaymentInstrumentApi.js +99 -29
  45. package/src/api/CustomerShippingAddressApi.js +99 -29
  46. package/src/api/DecisionManagerApi.js +99 -29
  47. package/src/api/DownloadDTDApi.js +23 -9
  48. package/src/api/DownloadXSDApi.js +23 -9
  49. package/src/api/EMVTagDetailsApi.js +42 -14
  50. package/src/api/FlexAPIApi.js +23 -9
  51. package/src/api/InstrumentIdentifierApi.js +118 -34
  52. package/src/api/InterchangeClearingLevelDetailsApi.js +23 -9
  53. package/src/api/InvoiceSettingsApi.js +42 -14
  54. package/src/api/InvoicesApi.js +118 -34
  55. package/src/api/ManageWebhooksApi.js +99 -29
  56. package/src/api/MerchantBoardingApi.js +42 -14
  57. package/src/api/MicroformIntegrationApi.js +23 -9
  58. package/src/api/NetFundingsApi.js +23 -9
  59. package/src/api/NotificationOfChangesApi.js +23 -9
  60. package/src/api/OrdersApi.js +42 -14
  61. package/src/api/PayerAuthenticationApi.js +61 -19
  62. package/src/api/PaymentBatchSummariesApi.js +23 -9
  63. package/src/api/PaymentInstrumentApi.js +80 -24
  64. package/src/api/PaymentsApi.js +118 -34
  65. package/src/api/PayoutsApi.js +23 -9
  66. package/src/api/PlansApi.js +156 -44
  67. package/src/api/PurchaseAndRefundDetailsApi.js +23 -9
  68. package/src/api/PushFundsApi.js +23 -9
  69. package/src/api/RefundApi.js +42 -14
  70. package/src/api/ReplayWebhooksApi.js +23 -9
  71. package/src/api/ReportDefinitionsApi.js +42 -14
  72. package/src/api/ReportDownloadsApi.js +23 -9
  73. package/src/api/ReportSubscriptionsApi.js +99 -29
  74. package/src/api/ReportsApi.js +61 -19
  75. package/src/api/RetrievalDetailsApi.js +23 -9
  76. package/src/api/RetrievalSummariesApi.js +23 -9
  77. package/src/api/ReversalApi.js +42 -14
  78. package/src/api/SearchTransactionsApi.js +42 -14
  79. package/src/api/SecureFileShareApi.js +42 -14
  80. package/src/api/SubscriptionsApi.js +156 -44
  81. package/src/api/TaxesApi.js +42 -14
  82. package/src/api/TokenApi.js +23 -9
  83. package/src/api/TransactionBatchesApi.js +61 -19
  84. package/src/api/TransactionDetailsApi.js +23 -9
  85. package/src/api/TransientTokenDataApi.js +42 -14
  86. package/src/api/UnifiedCheckoutCaptureContextApi.js +23 -9
  87. package/src/api/UserManagementApi.js +23 -9
  88. package/src/api/UserManagementSearchApi.js +23 -9
  89. package/src/api/VerificationApi.js +42 -14
  90. package/src/api/VoidApi.js +99 -29
  91. package/src/authentication/core/MerchantConfig.js +60 -5
  92. package/src/authentication/jwt/JWTSigToken.js +2 -2
  93. package/src/authentication/jwt/KeyCertificateGenerator.js +56 -4
  94. package/src/authentication/logging/SensitiveDataMasker.js +17 -1
  95. package/src/authentication/util/Constants.js +5 -0
  96. package/src/authentication/util/MLEUtility.js +109 -0
  97. package/src/authentication/util/Utility.js +9 -0
  98. package/src/index.js +69 -4
  99. package/src/model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.js +12 -4
  100. package/src/model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.js +131 -0
  101. package/src/model/ECheckConfigCommonInternalOnlyProcessors.js +10 -8
  102. package/src/model/ECheckConfigCommonProcessors.js +5 -4
  103. package/src/model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors.js +5 -4
  104. package/src/model/ECheckConfigFeaturesAccountValidationServiceProcessors.js +8 -7
  105. package/src/model/GenerateCaptureContextRequest.js +9 -9
  106. package/src/model/GenerateUnifiedCheckoutCaptureContextRequest.js +9 -9
  107. package/src/model/Ptsv2paymentsPaymentInformationCard.js +9 -0
  108. package/src/model/Ptsv2paymentsProcessingInformation.js +1 -1
  109. package/src/model/Ptsv2paymentsProcessingInformationJapanPaymentOptions.js +7 -43
  110. package/src/model/Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.js +91 -0
  111. package/src/model/Ptsv2paymentsRecipientInformation.js +14 -14
  112. package/src/model/Ptsv2paymentsSenderInformation.js +14 -14
  113. package/src/model/Riskv1exportcomplianceinquiriesOrderInformationLineItems.js +3 -4
  114. package/src/model/TmsNetworkTokenServices.js +121 -0
  115. package/src/model/TmsNetworkTokenServicesAmericanExpressTokenService.js +109 -0
  116. package/src/model/TmsNetworkTokenServicesMastercardDigitalEnablementService.js +100 -0
  117. package/src/model/TmsNetworkTokenServicesNotifications.js +82 -0
  118. package/src/model/TmsNetworkTokenServicesPaymentCredentials.js +82 -0
  119. package/src/model/TmsNetworkTokenServicesSynchronousProvisioning.js +82 -0
  120. package/src/model/TmsNetworkTokenServicesVisaTokenService.js +109 -0
  121. package/src/model/TmsNullify.js +100 -0
  122. package/src/model/TmsSensitivePrivileges.js +82 -0
  123. package/src/model/TmsTokenFormats.js +109 -0
  124. package/src/model/TokenPermissions.js +109 -0
  125. package/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +1 -1
  126. package/src/model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.js +49 -4
  127. package/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js +1 -1
package/MLE.md ADDED
@@ -0,0 +1,98 @@
1
+ [![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
2
+
3
+ # Message Level Encryption (MLE) Feature
4
+
5
+ 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.
6
+
7
+ ## Configuration
8
+
9
+ ### Global MLE Configuration
10
+
11
+ In the `merchantConfig` object, set the `useMLEGlobally` variable to enable or disable MLE for all supported APIs for the Rest SDK.
12
+
13
+ - **Variable**: `useMLEGlobally`
14
+ - **Type**: `boolean`
15
+ - **Default**: `false`
16
+ - **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`.
17
+
18
+ ### API-level MLE Control
19
+
20
+ Optionally, you can control the MLE feature at the API level using the `mapToControlMLEonAPI` variable in the `merchantConfig` object.
21
+
22
+ - **Variable**: `mapToControlMLEonAPI`
23
+ - **Type**: `Map<string, boolean>`
24
+ - **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.
25
+
26
+ ### MLE Key Alias
27
+
28
+ Another optional parameter for MLE is `mleKeyAlias`, which specifies the key alias used to retrieve the MLE certificate from the JWT P12 file.
29
+
30
+ - **Variable**: `mleKeyAlias`
31
+ - **Type**: `string`
32
+ - **Default**: `CyberSource_SJC_US`
33
+ - **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.
34
+
35
+ ## Notes
36
+ - If `useMLEGlobally` is set to true, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by mapToControlMLEonAPI.
37
+ - If `mapToControlMLEonAPI` is not provided or does not contain a specific API function name, the global useMLEGlobally setting will be applied.
38
+ - 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.
39
+
40
+ ## Example Configuration
41
+
42
+ ```json
43
+ {
44
+ "merchantConfig": {
45
+ "useMLEGlobally": true //globally MLE will be enabled for all MLE supported APIs
46
+ }
47
+ }
48
+ ```
49
+ Or
50
+
51
+ ```json
52
+ {
53
+ "merchantConfig": {
54
+ "useMLEGlobally": true, //globally MLE will be enabled for all MLE supported APIs
55
+ "mapToControlMLEonAPI": {
56
+ "apiFunctionName1": false, //if want to disable the particular api from list of MLE supported APIs
57
+ "apiFunctionName2": true //if want to enable MLE on API which is not in the list of supported MLE APIs for used version of Rest SDK
58
+ },
59
+ "mleKeyAlias": "Custom_Key_Alias" //optional if any custom value provided by Cybs
60
+ }
61
+ }
62
+ ```
63
+ Or
64
+
65
+ ```json
66
+ {
67
+ "merchantConfig": {
68
+ "useMLEGlobally": false, //globally MLE will be disabled for all APIs
69
+ "mapToControlMLEonAPI": {
70
+ "apiFunctionName1": true, //if want to enable MLE for API1
71
+ "apiFunctionName2": true //if want to enable MLE for API2
72
+ },
73
+ "mleKeyAlias": "Custom_Key_Alias" //optional if any custom value provided by Cybs
74
+ }
75
+ }
76
+ ```
77
+
78
+ In the above examples:
79
+ - MLE is enabled/disabled globally (`useMLEGlobally` is true/false).
80
+ - `apiFunctionName1` will have MLE disabled/enabled based on value provided.
81
+ - `apiFunctionName2` will have MLE enabled.
82
+ - `mleKeyAlias` is set to `Custom_Key_Alias`, overriding the default value.
83
+
84
+ Please refer given link for sample codes with MLE:
85
+ https://github.com/CyberSource/cybersource-rest-samples-node/tree/master/Samples/MLEFeature
86
+
87
+ ## Additional Information
88
+
89
+ ### API Support
90
+ - MLE is initially designed to support a few APIs.
91
+ - It can be extended to support more APIs in the future based on requirements and updates.
92
+ ### Authentication Type
93
+ - MLE is only supported with `JWT (JSON Web Token)` authentication type within the SDK.
94
+ ### Using the SDK
95
+ To use the MLE feature in the SDK, configure the `merchantConfig` object as shown above and pass it to the SDK initialization.
96
+
97
+ ## Contact
98
+ For any issues or further assistance, please open an issue on the GitHub repository or contact our support team.
package/README.md CHANGED
@@ -71,6 +71,13 @@ More information about this new logging framework can be found in this file : [L
71
71
 
72
72
  ## Features
73
73
 
74
+ ### Message Level Encryption (MLE) Feature
75
+ [![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
76
+
77
+ 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.
78
+
79
+ More information about this new MLE feature can be found in this file : [MLE.md](MLE.md)
80
+
74
81
  ### MetaKey Support
75
82
 
76
83
  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.
@@ -4,5 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **parentProfileId** | **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'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]
7
+ **vault** | [**CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault**](CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md) | | [optional]
7
8
 
8
9
 
@@ -0,0 +1,14 @@
1
+ # CyberSource.CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **defaultTokenType** | **String** | Default token type to be used. Possible Values: - 'CUSTOMER' - 'PAYMENT_INSTRUMENT' - 'INSTRUMENT_IDENTIFIER' | [optional]
7
+ **location** | **String** | Location where the vault will be stored. Use 'IDC' (the Indian Data Centre) when merchant is storing token data in India or 'GDC' (the Global Data Centre) for all other cases. Possible Values: - 'IDC' - 'GDC' | [optional]
8
+ **tokenFormats** | [**TmsTokenFormats**](TmsTokenFormats.md) | | [optional]
9
+ **tokenPermissions** | [**TokenPermissions**](TokenPermissions.md) | | [optional]
10
+ **sensitivePrivileges** | [**TmsSensitivePrivileges**](TmsSensitivePrivileges.md) | | [optional]
11
+ **nullify** | [**TmsNullify**](TmsNullify.md) | | [optional]
12
+ **networkTokenServices** | [**TmsNetworkTokenServices**](TmsNetworkTokenServices.md) | | [optional]
13
+
14
+
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
7
7
  **terminalId** | **String** | *NEW* The 'Terminal Id' 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]
8
8
  **enable15anTransactionReferenceNumber** | **Boolean** | *NEW* This ensures the transaction reference # contains an identifier that can be viewed in CYBS | [optional] [default to true]
9
9
  **portalSupportedPaytypes** | **String** | *NEW* This is used by the EBC2 application | [optional] [default to 'CHECK']
10
- **settlementMethod** | **Object** | *NEW* | [optional]
11
- **verificationLevel** | **Object** | *NEW* | [optional]
10
+ **settlementMethod** | **String** | *NEW* Possible values: - BEST_GUESS | [optional] [default to 'BEST_GUESS']
11
+ **verificationLevel** | **String** | *NEW* Possible values: - VALIDATION | [optional] [default to 'VALIDATION']
12
12
  **setCompletedState** | **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]
13
13
 
14
14
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **companyId** | **String** | *EXISTING* company ID assigned to merchant by Acquiring bank. This field is alphanumeric | [optional]
8
8
  **batchGroup** | **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., <processor>_16 = 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]
9
9
  **enableAccuityForAvs** | **Boolean** | *NEW* Accuity is the original validation service that checks the account/routing number for formatting issues. Used by WF and set to \"Yes\" unless told otherwise | [optional] [default to true]
10
- **accuityCheckType** | **Object** | *NEW* | [optional]
10
+ **accuityCheckType** | **String** | *NEW* Possible values: - ALWAYS | [optional] [default to 'ALWAYS']
11
11
  **setCompletedState** | **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]
12
12
 
13
13
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **avsVersion** | **Object** | *NEW* | [optional]
6
+ **avsVersion** | **String** | *NEW* Possible values: - 2 | [optional] [default to '2']
7
7
 
8
8
 
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
6
6
  **avsAccountOwnershipService** | **Boolean** | *NEW* Determined in WF eTicket if account has opted into the Account Ownership Service. | [optional]
7
7
  **avsAccountStatusService** | **Boolean** | *NEW* Determined in WF eTicket if account has opted into the Account Status Service. | [optional]
8
8
  **avsSignedAgreement** | **Boolean** | *NEW* Taken from Addendum Agreement Column in boarding form. | [optional]
9
- **avsCalculatedResponseBehavior** | **Object** | *NEW* | [optional]
9
+ **avsCalculatedResponseBehavior** | **String** | *NEW* Possible values: - continue | [optional] [default to 'continue']
10
10
  **avsAdditionalId** | **String** | *NEW* Also known as the Additional ID. Taken from the boarding form. | [optional]
11
11
  **enableAvs** | **Boolean** | *NEW* | [optional] [default to true]
12
12
  **avsEntityId** | **String** | *NEW* Also known as the AVS Gateway Entity ID. | [optional]
13
- **avsResultMode** | **Object** | *NEW* | [optional]
13
+ **avsResultMode** | **String** | *NEW* Possible values: - FULL_RESPONSE - LOGIC_BOX | [optional]
14
14
  **enableAvsTokenCreation** | **Boolean** | *NEW* Applicable if the merchant wants to run AVS on token creation requests only. | [optional] [default to false]
15
15
 
16
16
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **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]
7
- **allowedCardNetworks** | **[String]** | 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]
8
6
  **clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
7
+ **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
9
  **checkoutApiInitialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [optional]
10
10
 
11
11
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **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]
7
6
  **clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
8
- **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 - DISCOVER - DINERSCLUB - JCB | [optional]
7
+ **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]
8
+ **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
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]
10
10
  **country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
11
11
  **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]
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **startMonth** | **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. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional]
18
18
  **startYear** | **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. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional]
19
19
  **productName** | **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]
20
+ **productSubtype** | **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]
20
21
  **typeSelectionIndicator** | **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]
21
22
 
22
23
 
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional]
10
10
  **capture** | **Boolean** | Indicates whether to also include a capture in the submitted authorization request or not. Possible values: - `true`: Include a capture with an authorization request. - `false`: (default) Do not include a capture with an authorization request. #### Used by **Authorization and Capture** Optional field. | [optional] [default to false]
11
11
  **processorId** | **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]
12
- **businessApplicationId** | **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]
12
+ **businessApplicationId** | **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]
13
13
  **commerceIndicator** | **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 `retail`. 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 \"moto\" | [optional]
14
14
  **commerceIndicatorLabel** | **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 `retail`. 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 `moto` | [optional]
15
15
  **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` 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) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional]
@@ -4,11 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **paymentMethod** | **String** | This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) | [optional]
7
- **bonuses** | **String** | This value is a 2-digit code indicating the Number of Bonuses. Valid value from 1 to 6. | [optional]
8
- **bonusMonth** | **String** | This value is a 2-digit code indicating the first bonus month. Valid value from 1 to 12. | [optional]
9
- **secondBonusMonth** | **String** | This value is a 2-digit code indicating the second bonus month. Valid value from 1 to 12. | [optional]
10
- **bonusAmount** | **String** | This value contains the bonus amount of the first month. Maximum value without decimal 99999999. | [optional]
11
- **secondBonusAmount** | **String** | This value contains the bonus amount of the second month. Maximum value without decimal 99999999. | [optional]
7
+ **bonuses** | [**[Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses]**](Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md) | An array of objects, each of which contains a bonus month and bonus amount. Length of bonuses array is equal to the number of bonuses. Max length = 6. In case of bonus month and amount not specified, null objects to be returned in the array. Example: bonuses : [ {\"month\": \"1\",\"amount\": \"200\"}, {\"month\": \"3\",\"amount\": \"2500\"}, null] | [optional]
12
8
  **preapprovalType** | **String** | This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization | [optional]
13
9
  **installments** | **String** | Number of Installments. | [optional]
14
10
  **terminalId** | **String** | Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the `pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. | [optional]
@@ -0,0 +1,9 @@
1
+ # CyberSource.Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **month** | **String** | This value is a 2-digit code indicating the first bonus month. Valid value from 1 to 12. | [optional]
7
+ **amount** | **String** | This value contains the bonus amount of the first month. Maximum value without decimal 99999999. | [optional]
8
+
9
+
@@ -3,14 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accountId** | **String** | Identifier for the recipient's account. **Applicable for Barclays AFT transactions only.** It is mandatory for both Visa and Mastercard AFT. For Visa, the field has a maximum length of 34 character. For Mastercard, the field has a maximum length of 50 character. | [optional]
7
- **accountType** | **String** | Identifies the recipient's account type. **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Valid values are: - `00` for Other - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN) - `02` for International Bank Account Number (IBAN) - `03` for Card Account - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code | [optional]
8
- **firstName** | **String** | First name of the recipient. **Applicable for Barclays AFT transactions only.** The field is mandatory for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 35 characters. Values exceeding the above limits will be truncated. | [optional]
9
- **lastName** | **String** | Last name of the recipient. **Applicable for Barclays AFT transactions only.** This field is optional for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 35 characters. Values exceeding these limits will be truncated. | [optional]
10
- **middleName** | **String** | Middle name of the recipient. **Applicable for Barclays AFT transactions only.** This field is optional for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 1 character. Values exceeding these limits will be truncated. | [optional]
11
- **address1** | **String** | The street address of the recipient **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to Barclays. The field has a maximum length of 50 characters. Values exceeding these limits will be truncated. | [optional]
6
+ **accountId** | **String** | Identifier for the recipient's account. This field is applicable for AFT transactions. | [optional]
7
+ **accountType** | **String** | Identifies the recipient's account type. This field is applicable for AFT transactions. Valid values are: - `00` for Other - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN) - `02` for International Bank Account Number (IBAN) - `03` for Card Account - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code | [optional]
8
+ **firstName** | **String** | First name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
9
+ **middleName** | **String** | Middle name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
10
+ **lastName** | **String** | Last name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
11
+ **address1** | **String** | The street address of the recipient This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
12
12
  **postalCode** | **String** | Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. 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. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional]
13
- **country** | **String** | The country associated with the address of the recipient. **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
13
+ **country** | **String** | The country associated with the address of the recipient. This field is applicable for AFT and OCT transactions. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
14
14
  **dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional]
15
15
  **beneficiaryId** | **String** | Only for e-wallets: ID, username, hash or anything uniquely identifying the ultimate beneficiary. | [optional]
16
16
  **beneficiaryName** | **String** | Only for e-wallets: The ultimate beneficiary's full name. | [optional]
@@ -3,12 +3,12 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **firstName** | **String** | First name of the sender. **Applicable for Barclays AFT transactions only.** The field is mandatory for Visa and not applicable for Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. Values exceeding the above limits will be truncated. | [optional]
7
- **lastName** | **String** | Last name of the sender. **Applicable for Barclays AFT transactions only.** This field is optional for Visa and not applicable for Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. Values exceeding these limits will be truncated. | [optional]
8
- **middleName** | **String** | Middle name of the sender. **Applicable for Barclays AFT transactions only.** The field is mandatory for Visa and not applicable for Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. Values exceeding these limits will be truncated. | [optional]
9
- **address1** | **String** | The street address of the sender. **Applicable for Barclays AFT transactions only.** The field is mandatory for Visa and not applicable for Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to Barclays. The field has a maximum length of 35 characters. Values exceeding these limits will be truncated. | [optional]
10
- **locality** | **String** | The city or locality of the sender.in **Applicable for Barclays AFT transactions only.** The field is optional for Visa and not applicable for Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to Barclays. The field has a maximum length of 25 characters. Values exceeding these limits will be truncated. | [optional]
11
- **administrativeArea** | **String** | The state or province of the sender. **Applicable for Barclays AFT transactions only.** The field is mandatory for Visa AFT when the sender country is US or CA else it is optional for Visa AFT. This field is not applicable for Mastercard AFT. Must be a two character value | [optional]
12
- **countryCode** | **String** | The country associated with the address of the sender. **Applicable for Barclays AFT transactions only.** The field is mandatory for Visa and not applicable for Mastercard AFT. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
6
+ **firstName** | **String** | First name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported.Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to the processor. | [optional]
7
+ **middleName** | **String** | Middle name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
8
+ **lastName** | **String** | Last name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
9
+ **address1** | **String** | The street address of the sender. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
10
+ **locality** | **String** | The city or locality of the sender. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
11
+ **administrativeArea** | **String** | The state or province of the sender. This field is applicable for AFT transactions when the sender country is US or CA. Else it is optional. Must be a two character value | [optional]
12
+ **countryCode** | **String** | The country associated with the address of the sender. This field is applicable for AFT transactions. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
13
13
 
14
14
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **unitPrice** | **String** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) |
6
+ **unitPrice** | **String** | Per-item price of the product. If line items are present in the request, the unit price is a mandatory field. | [optional]
7
7
  **allowedExportCountries** | **[String]** | | [optional]
8
8
  **restrictedExportCountries** | **[String]** | | [optional]
9
9
  **quantity** | **Number** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional]
@@ -0,0 +1,13 @@
1
+ # CyberSource.TmsNetworkTokenServices
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **notifications** | [**TmsNetworkTokenServicesNotifications**](TmsNetworkTokenServicesNotifications.md) | | [optional]
7
+ **paymentCredentials** | [**TmsNetworkTokenServicesPaymentCredentials**](TmsNetworkTokenServicesPaymentCredentials.md) | | [optional]
8
+ **synchronousProvisioning** | [**TmsNetworkTokenServicesSynchronousProvisioning**](TmsNetworkTokenServicesSynchronousProvisioning.md) | | [optional]
9
+ **visaTokenService** | [**TmsNetworkTokenServicesVisaTokenService**](TmsNetworkTokenServicesVisaTokenService.md) | | [optional]
10
+ **mastercardDigitalEnablementService** | [**TmsNetworkTokenServicesMastercardDigitalEnablementService**](TmsNetworkTokenServicesMastercardDigitalEnablementService.md) | | [optional]
11
+ **americanExpressTokenService** | [**TmsNetworkTokenServicesAmericanExpressTokenService**](TmsNetworkTokenServicesAmericanExpressTokenService.md) | | [optional]
12
+
13
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.TmsNetworkTokenServicesAmericanExpressTokenService
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enableService** | **Boolean** | Indicates if the service for network tokens for the American Express card association are enabled | [optional]
7
+ **enableTransactionalTokens** | **Boolean** | Indicates if network tokens for the American Express card association are enabled for transactions | [optional]
8
+ **tokenRequestorId** | **String** | Token Requestor ID provided by American Express during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"12345678912\" | [optional]
9
+ **seNumber** | **String** | SE Number assigned by American Express for the merchant's account Pattern: \"^[0-9]{11}\\\\z$\" Min Length: 10 Max Length: 10 Example: \"9876543212\" | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.TmsNetworkTokenServicesMastercardDigitalEnablementService
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enableService** | **Boolean** | Indicates if the service for network tokens for the Mastercard card association are enabled | [optional]
7
+ **enableTransactionalTokens** | **Boolean** | Indicates if network tokens for the Mastercard card association are enabled for transactions | [optional]
8
+ **tokenRequestorId** | **String** | Token Requestor ID provided by Mastercard during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"50162233570\" | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.TmsNetworkTokenServicesNotifications
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enabled** | **Boolean** | Indicates if lifecycle management (LCM) notifications are enabled | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.TmsNetworkTokenServicesPaymentCredentials
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enabled** | **Boolean** | Indicates if Payment Credentials are enabled. If enabled, this provides access to the unredacted token and its associated cryptogram. | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.TmsNetworkTokenServicesSynchronousProvisioning
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enabled** | **Boolean** | Indicates if network tokens are provisioned synchronously (i.e. as part of the transaction flow) or asychronously (i.e. in parallel to the payment flow) NOTE: The synchronous provisioning feature is designed exclusively for aggregator merchants. Direct merchants should not enable synchronous provisioning as TMS manages the asynchronous creation of network tokens for direct clients. Activation of this feature by direct merchants will lead to latency in the authorization response. | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.TmsNetworkTokenServicesVisaTokenService
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **enableService** | **Boolean** | Indicates if the service for network tokens for the Visa card association are enabled | [optional]
7
+ **enableTransactionalTokens** | **Boolean** | Indicates if network tokens for the Visa card association are enabled for transactions | [optional]
8
+ **tokenRequestorId** | **String** | Token Requestor ID provided by Visa during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"40000000082\" | [optional]
9
+ **relationshipId** | **String** | Relationship ID provided by visa Min Length: 1 Max Length: 100 Example: \"24681921-40000000082\" | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.TmsNullify
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **instrumentIdentifierCardNumber** | **Boolean** | Indicates if the card number should be nullified (i.e. not stored) | [optional]
7
+ **instrumentIdentifierCardExpiration** | **Boolean** | Indicates if the expiration date associated to the instrument identifier should be nullified (i.e. not stored) | [optional]
8
+ **paymentInstrumentCardDetails** | **Boolean** | Indicates if the card details should be nullified (i.e. not stored) | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.TmsSensitivePrivileges
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cardNumberMaskingFormat** | **String** | Indicates which digits of the card number will be unmasked. Possible Values: - 'FIRST_6_LAST_4' - 'LAST_4' - 'MASKED' | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.TmsTokenFormats
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **customer** | **String** | Format for customer tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional]
7
+ **paymentInstrument** | **String** | Format for payment instrument tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional]
8
+ **instrumentIdentifierCard** | **String** | Format for card based instrument identifier tokens. Possible Values: - '16_DIGIT' - '16_DIGIT_LAST_4' - '19_DIGIT' - '19_DIGIT_LAST_4' - '22_DIGIT' - '32_HEX' | [optional]
9
+ **instrumentIdentifierBankAccount** | **String** | Format for bank account based instrument identifier tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.TokenPermissions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **create** | **Boolean** | Indicates if tokens may be created | [optional]
7
+ **read** | **Boolean** | Indicates if tokens may be read | [optional]
8
+ **update** | **Boolean** | Indicates if tokens may be updated | [optional]
9
+ **_delete** | **Boolean** | Indicates if tokens may be deleted | [optional]
10
+
11
+
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **paymentSolution** | **String** | Type of digital payment solution for the transaction. | [optional]
9
9
  **commerceIndicator** | **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 `retail`. 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 \"moto\" | [optional]
10
10
  **commerceIndicatorLabel** | **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 `retail`. 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 `moto` | [optional]
11
- **businessApplicationId** | **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]
11
+ **businessApplicationId** | **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]
12
12
  **authorizationOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional]
13
13
  **bankTransferOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional]
14
14
  **captureOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions**](TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md) | | [optional]
@@ -7,5 +7,10 @@ Name | Type | Description | Notes
7
7
  **terminalId** | **String** | Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the `pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. | [optional]
8
8
  **businessName** | **String** | Business name in Japanese characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional]
9
9
  **businessNameKatakana** | **String** | Business name in Katakana characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional]
10
+ **businessNameEnglish** | **String** | Business name in English characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional]
11
+ **bonuses** | [**[Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses]**](Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md) | An array of objects, each of which contains a bonus month and bonus amount. Length of bonuses array is equal to the number of bonuses. Max length = 6. In case of bonus month and amount not specified, null objects to be returned in the array. Example: bonuses : [ {\"month\": \"1\",\"amount\": \"200\"}, {\"month\": \"3\",\"amount\": \"2500\"}, null] | [optional]
12
+ **firstBillingMonth** | **String** | Billing month in MM format. | [optional]
13
+ **numberOfInstallments** | **String** | Number of Installments. | [optional]
14
+ **preApprovalType** | **String** | This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization | [optional]
10
15
 
11
16
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` 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) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional]
7
- **businessApplicationId** | **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]
7
+ **businessApplicationId** | **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]
8
8
  **commerceIndicator** | **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 `retail`. 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 \"moto\" | [optional]
9
9
  **commerceIndicatorLabel** | **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 `retail`. 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 `moto` | [optional]
10
10
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cybersource-rest-client",
3
- "version": "0.0.62",
3
+ "version": "0.0.63",
4
4
  "description": "Node.js SDK for the CyberSource REST API",
5
5
  "author": "developer@cybersource.com",
6
6
  "license": "CyberSource",