cybersource-rest-client 0.0.62 → 0.0.64

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 (324) hide show
  1. package/MLE.md +98 -0
  2. package/README.md +7 -0
  3. package/docs/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.md +1 -0
  4. package/docs/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md +14 -0
  5. package/docs/CreatePaymentRequest.md +1 -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 +3 -3
  11. package/docs/GenerateUnifiedCheckoutCaptureContextRequest.md +3 -4
  12. package/docs/InlineResponse2011.md +2 -2
  13. package/docs/InstrumentIdentifierApi.md +10 -2
  14. package/docs/OctCreatePaymentRequest.md +1 -0
  15. package/docs/PatchInstrumentIdentifierRequest.md +1 -0
  16. package/docs/PaymentInstrumentApi.md +8 -2
  17. package/docs/PostInstrumentIdentifierEnrollmentRequest.md +1 -0
  18. package/docs/PostInstrumentIdentifierRequest.md +1 -0
  19. package/docs/PostPaymentCredentialsRequest.md +1 -1
  20. package/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md +1 -0
  21. package/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +1 -0
  22. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md +2 -0
  23. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md +10 -0
  24. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md +10 -0
  25. package/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md +1 -0
  26. package/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md +2 -0
  27. package/docs/PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md +8 -0
  28. package/docs/PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md +11 -0
  29. package/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md +1 -0
  30. package/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md +1 -0
  31. package/docs/PtsV2PayoutsPost201Response.md +1 -0
  32. package/docs/PtsV2PayoutsPost201ResponseProcessingInformation.md +8 -0
  33. package/docs/Ptsv2billingagreementsInstallmentInformation.md +1 -1
  34. package/docs/Ptsv2paymentsAggregatorInformation.md +5 -0
  35. package/docs/Ptsv2paymentsConsumerAuthenticationInformation.md +3 -0
  36. package/docs/Ptsv2paymentsInstallmentInformation.md +1 -1
  37. package/docs/Ptsv2paymentsPaymentInformationCard.md +1 -0
  38. package/docs/Ptsv2paymentsPointOfSaleInformation.md +2 -1
  39. package/docs/Ptsv2paymentsProcessingInformation.md +5 -1
  40. package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +6 -2
  41. package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +1 -0
  42. package/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md +2 -0
  43. package/docs/Ptsv2paymentsProcessingInformationJapanPaymentOptions.md +1 -5
  44. package/docs/Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md +9 -0
  45. package/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md +3 -0
  46. package/docs/Ptsv2paymentsRecipientInformation.md +14 -7
  47. package/docs/Ptsv2paymentsSenderInformation.md +11 -7
  48. package/docs/Ptsv2paymentsSenderInformationAccount.md +10 -0
  49. package/docs/{TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.md → Ptsv2paymentsUnscheduledPaymentInformation.md} +1 -1
  50. package/docs/Ptsv2paymentsidcapturesInstallmentInformation.md +1 -1
  51. package/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md +1 -0
  52. package/docs/Ptsv2paymentsidrefundsPointOfSaleInformation.md +1 -0
  53. package/docs/Ptsv2paymentsidrefundsProcessingInformation.md +1 -0
  54. package/docs/Ptsv2paymentsidreversalsProcessingInformation.md +1 -0
  55. package/docs/{Ptsv1pushfundstransferAggregatorInformation.md → Ptsv2payoutsAggregatorInformation.md} +7 -2
  56. package/docs/{Ptsv1pushfundstransferAggregatorInformationSubMerchant.md → Ptsv2payoutsAggregatorInformationSubMerchant.md} +1 -1
  57. package/docs/Ptsv2payoutsProcessingInformation.md +2 -0
  58. package/docs/Ptsv2payoutsProcessingInformationPurchaseOptions.md +9 -0
  59. package/docs/Ptsv2payoutsRecipientInformation.md +5 -0
  60. package/docs/Ptsv2payoutsSenderInformation.md +1 -0
  61. package/docs/Ptsv2voidsProcessingInformation.md +1 -1
  62. package/docs/PushFundsRequest.md +1 -1
  63. package/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md +1 -1
  64. package/docs/TmsBinLookup.md +9 -0
  65. package/docs/{InlineResponse2011IssuerInformation.md → TmsBinLookupIssuerInformation.md} +1 -1
  66. package/docs/TmsBinLookupPaymentAccountInformation.md +10 -0
  67. package/docs/{InlineResponse2011PaymentAccountInformationCard.md → TmsBinLookupPaymentAccountInformationCard.md} +2 -2
  68. package/docs/{InlineResponse2011PaymentAccountInformationCardBrands.md → TmsBinLookupPaymentAccountInformationCardBrands.md} +1 -1
  69. package/docs/{InlineResponse2011PaymentAccountInformationFeatures.md → TmsBinLookupPaymentAccountInformationFeatures.md} +1 -1
  70. package/docs/{InlineResponse2011PaymentAccountInformationNetwork.md → TmsBinLookupPaymentAccountInformationNetwork.md} +1 -1
  71. package/docs/TmsCardArt.md +12 -0
  72. package/docs/TmsCardArtBrandLogoAsset.md +9 -0
  73. package/docs/TmsCardArtBrandLogoAssetLinks.md +8 -0
  74. package/docs/TmsCardArtBrandLogoAssetLinksSelf.md +8 -0
  75. package/docs/TmsCardArtCombinedAsset.md +9 -0
  76. package/docs/TmsCardArtCombinedAssetLinks.md +8 -0
  77. package/docs/TmsCardArtCombinedAssetLinksSelf.md +8 -0
  78. package/docs/TmsCardArtIconAsset.md +9 -0
  79. package/docs/TmsCardArtIconAssetLinks.md +8 -0
  80. package/docs/TmsCardArtIconAssetLinksSelf.md +8 -0
  81. package/docs/TmsCardArtIssuerLogoAsset.md +9 -0
  82. package/docs/TmsCardArtIssuerLogoAssetLinks.md +8 -0
  83. package/docs/TmsCardArtIssuerLogoAssetLinksSelf.md +8 -0
  84. package/docs/TmsEmbeddedInstrumentIdentifier.md +1 -0
  85. package/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md +1 -1
  86. package/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md +8 -0
  87. package/docs/TmsNetworkTokenServices.md +13 -0
  88. package/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md +11 -0
  89. package/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md +10 -0
  90. package/docs/TmsNetworkTokenServicesNotifications.md +8 -0
  91. package/docs/TmsNetworkTokenServicesPaymentCredentials.md +8 -0
  92. package/docs/TmsNetworkTokenServicesSynchronousProvisioning.md +8 -0
  93. package/docs/TmsNetworkTokenServicesVisaTokenService.md +11 -0
  94. package/docs/TmsNullify.md +10 -0
  95. package/docs/TmsPaymentInstrumentProcessingInfo.md +1 -1
  96. package/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md +1 -1
  97. package/docs/TmsSensitivePrivileges.md +8 -0
  98. package/docs/TmsTokenFormats.md +11 -0
  99. package/docs/Tmsv2TokenizedCard.md +17 -9
  100. package/docs/Tmsv2TokenizedCardCard.md +5 -3
  101. package/docs/Tmsv2TokenizedCardLinks.md +8 -0
  102. package/docs/Tmsv2TokenizedCardLinksSelf.md +8 -0
  103. package/docs/Tmsv2TokenizedCardMetadata.md +2 -1
  104. package/docs/Tmsv2TokenizedCardMetadataIssuer.md +10 -0
  105. package/docs/Tmsv2TokenizedCardPasscode.md +8 -0
  106. package/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md +1 -1
  107. package/docs/TokenPermissions.md +11 -0
  108. package/docs/TssV2TransactionsGet200Response.md +1 -1
  109. package/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md +1 -1
  110. package/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +1 -1
  111. package/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +1 -1
  112. package/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md +5 -0
  113. package/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +1 -1
  114. package/package.json +2 -2
  115. package/src/api/BatchesApi.js +80 -24
  116. package/src/api/BillingAgreementsApi.js +61 -19
  117. package/src/api/BinLookupApi.js +23 -9
  118. package/src/api/CaptureApi.js +23 -9
  119. package/src/api/ChargebackDetailsApi.js +23 -9
  120. package/src/api/ChargebackSummariesApi.js +23 -9
  121. package/src/api/ConversionDetailsApi.js +23 -9
  122. package/src/api/CreateNewWebhooksApi.js +61 -19
  123. package/src/api/CreditApi.js +23 -9
  124. package/src/api/CustomerApi.js +80 -24
  125. package/src/api/CustomerPaymentInstrumentApi.js +99 -29
  126. package/src/api/CustomerShippingAddressApi.js +99 -29
  127. package/src/api/DecisionManagerApi.js +99 -29
  128. package/src/api/DownloadDTDApi.js +23 -9
  129. package/src/api/DownloadXSDApi.js +23 -9
  130. package/src/api/EMVTagDetailsApi.js +42 -14
  131. package/src/api/FlexAPIApi.js +23 -9
  132. package/src/api/InstrumentIdentifierApi.js +126 -34
  133. package/src/api/InterchangeClearingLevelDetailsApi.js +23 -9
  134. package/src/api/InvoiceSettingsApi.js +42 -14
  135. package/src/api/InvoicesApi.js +118 -34
  136. package/src/api/ManageWebhooksApi.js +99 -29
  137. package/src/api/MerchantBoardingApi.js +42 -14
  138. package/src/api/MicroformIntegrationApi.js +23 -9
  139. package/src/api/NetFundingsApi.js +23 -9
  140. package/src/api/NotificationOfChangesApi.js +23 -9
  141. package/src/api/OrdersApi.js +42 -14
  142. package/src/api/PayerAuthenticationApi.js +61 -19
  143. package/src/api/PaymentBatchSummariesApi.js +23 -9
  144. package/src/api/PaymentInstrumentApi.js +86 -24
  145. package/src/api/PaymentsApi.js +118 -34
  146. package/src/api/PayoutsApi.js +23 -9
  147. package/src/api/PlansApi.js +156 -44
  148. package/src/api/PurchaseAndRefundDetailsApi.js +23 -9
  149. package/src/api/PushFundsApi.js +23 -9
  150. package/src/api/RefundApi.js +42 -14
  151. package/src/api/ReplayWebhooksApi.js +23 -9
  152. package/src/api/ReportDefinitionsApi.js +42 -14
  153. package/src/api/ReportDownloadsApi.js +23 -9
  154. package/src/api/ReportSubscriptionsApi.js +99 -29
  155. package/src/api/ReportsApi.js +61 -19
  156. package/src/api/RetrievalDetailsApi.js +23 -9
  157. package/src/api/RetrievalSummariesApi.js +23 -9
  158. package/src/api/ReversalApi.js +42 -14
  159. package/src/api/SearchTransactionsApi.js +42 -14
  160. package/src/api/SecureFileShareApi.js +42 -14
  161. package/src/api/SubscriptionsApi.js +156 -44
  162. package/src/api/TaxesApi.js +42 -14
  163. package/src/api/TokenApi.js +23 -9
  164. package/src/api/TransactionBatchesApi.js +61 -19
  165. package/src/api/TransactionDetailsApi.js +23 -9
  166. package/src/api/TransientTokenDataApi.js +42 -14
  167. package/src/api/UnifiedCheckoutCaptureContextApi.js +23 -9
  168. package/src/api/UserManagementApi.js +23 -9
  169. package/src/api/UserManagementSearchApi.js +23 -9
  170. package/src/api/VerificationApi.js +42 -14
  171. package/src/api/VoidApi.js +99 -29
  172. package/src/authentication/core/MerchantConfig.js +60 -5
  173. package/src/authentication/jwt/JWTSigToken.js +2 -2
  174. package/src/authentication/jwt/KeyCertificateGenerator.js +56 -4
  175. package/src/authentication/logging/SensitiveDataMasker.js +22 -2
  176. package/src/authentication/util/Constants.js +5 -0
  177. package/src/authentication/util/MLEUtility.js +109 -0
  178. package/src/authentication/util/Utility.js +9 -0
  179. package/src/index.js +231 -141
  180. package/src/model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations.js +12 -4
  181. package/src/model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.js +131 -0
  182. package/src/model/CreatePaymentRequest.js +12 -4
  183. package/src/model/ECheckConfigCommonInternalOnlyProcessors.js +10 -8
  184. package/src/model/ECheckConfigCommonProcessors.js +5 -4
  185. package/src/model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors.js +5 -4
  186. package/src/model/ECheckConfigFeaturesAccountValidationServiceProcessors.js +8 -7
  187. package/src/model/GenerateCaptureContextRequest.js +19 -18
  188. package/src/model/GenerateUnifiedCheckoutCaptureContextRequest.js +14 -22
  189. package/src/model/InlineResponse2011.js +8 -8
  190. package/src/model/OctCreatePaymentRequest.js +12 -4
  191. package/src/model/PatchInstrumentIdentifierRequest.js +12 -4
  192. package/src/model/PostInstrumentIdentifierEnrollmentRequest.js +12 -4
  193. package/src/model/PostInstrumentIdentifierRequest.js +12 -4
  194. package/src/model/PostPaymentCredentialsRequest.js +1 -1
  195. package/src/model/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.js +9 -0
  196. package/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js +9 -0
  197. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActions.js +20 -4
  198. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.js +100 -0
  199. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.js +100 -0
  200. package/src/model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.js +9 -0
  201. package/src/model/PtsV2PaymentsPost201ResponseProcessingInformation.js +20 -4
  202. package/src/model/PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.js +82 -0
  203. package/src/model/PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.js +109 -0
  204. package/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js +9 -0
  205. package/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js +9 -0
  206. package/src/model/PtsV2PayoutsPost201Response.js +12 -4
  207. package/src/model/PtsV2PayoutsPost201ResponseProcessingInformation.js +81 -0
  208. package/src/model/Ptsv2billingagreementsInstallmentInformation.js +1 -1
  209. package/src/model/Ptsv2paymentsAggregatorInformation.js +45 -0
  210. package/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js +27 -0
  211. package/src/model/Ptsv2paymentsInstallmentInformation.js +1 -1
  212. package/src/model/Ptsv2paymentsPaymentInformationCard.js +9 -0
  213. package/src/model/Ptsv2paymentsPointOfSaleInformation.js +10 -1
  214. package/src/model/Ptsv2paymentsProcessingInformation.js +37 -1
  215. package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js +38 -2
  216. package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js +9 -0
  217. package/src/model/Ptsv2paymentsProcessingInformationCaptureOptions.js +18 -0
  218. package/src/model/Ptsv2paymentsProcessingInformationJapanPaymentOptions.js +7 -43
  219. package/src/model/Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.js +91 -0
  220. package/src/model/Ptsv2paymentsProcessingInformationPurchaseOptions.js +27 -0
  221. package/src/model/Ptsv2paymentsRecipientInformation.js +77 -14
  222. package/src/model/Ptsv2paymentsSenderInformation.js +53 -18
  223. package/src/model/Ptsv2paymentsSenderInformationAccount.js +100 -0
  224. package/src/model/{TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.js → Ptsv2paymentsUnscheduledPaymentInformation.js} +8 -8
  225. package/src/model/Ptsv2paymentsidcapturesInstallmentInformation.js +1 -1
  226. package/src/model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.js +9 -0
  227. package/src/model/Ptsv2paymentsidrefundsPointOfSaleInformation.js +9 -0
  228. package/src/model/Ptsv2paymentsidrefundsProcessingInformation.js +9 -0
  229. package/src/model/Ptsv2paymentsidreversalsProcessingInformation.js +9 -0
  230. package/src/model/{Ptsv1pushfundstransferAggregatorInformation.js → Ptsv2payoutsAggregatorInformation.js} +58 -13
  231. package/src/model/{Ptsv1pushfundstransferAggregatorInformationSubMerchant.js → Ptsv2payoutsAggregatorInformationSubMerchant.js} +8 -8
  232. package/src/model/Ptsv2payoutsProcessingInformation.js +21 -4
  233. package/src/model/Ptsv2payoutsProcessingInformationPurchaseOptions.js +91 -0
  234. package/src/model/Ptsv2payoutsRecipientInformation.js +45 -0
  235. package/src/model/Ptsv2payoutsSenderInformation.js +9 -0
  236. package/src/model/Ptsv2voidsProcessingInformation.js +2 -2
  237. package/src/model/PushFundsRequest.js +6 -6
  238. package/src/model/Riskv1exportcomplianceinquiriesOrderInformationLineItems.js +3 -4
  239. package/src/model/TmsBinLookup.js +90 -0
  240. package/src/model/{InlineResponse2011IssuerInformation.js → TmsBinLookupIssuerInformation.js} +8 -8
  241. package/src/model/TmsBinLookupPaymentAccountInformation.js +97 -0
  242. package/src/model/{InlineResponse2011PaymentAccountInformationCard.js → TmsBinLookupPaymentAccountInformationCard.js} +13 -13
  243. package/src/model/{InlineResponse2011PaymentAccountInformationCardBrands.js → TmsBinLookupPaymentAccountInformationCardBrands.js} +8 -8
  244. package/src/model/{InlineResponse2011PaymentAccountInformationFeatures.js → TmsBinLookupPaymentAccountInformationFeatures.js} +8 -8
  245. package/src/model/{InlineResponse2011PaymentAccountInformationNetwork.js → TmsBinLookupPaymentAccountInformationNetwork.js} +8 -8
  246. package/src/model/TmsCardArt.js +115 -0
  247. package/src/model/{Tmsv2TokenizedCardMetadataCardArtIconAsset.js → TmsCardArtBrandLogoAsset.js} +15 -14
  248. package/src/model/{Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.js → TmsCardArtBrandLogoAssetLinks.js} +13 -13
  249. package/src/model/{Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.js → TmsCardArtBrandLogoAssetLinksSelf.js} +9 -9
  250. package/src/model/{Tmsv2TokenizedCardMetadataCardArtCombinedAsset.js → TmsCardArtCombinedAsset.js} +15 -14
  251. package/src/model/TmsCardArtCombinedAssetLinks.js +81 -0
  252. package/src/model/{Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.js → TmsCardArtCombinedAssetLinksSelf.js} +9 -9
  253. package/src/model/TmsCardArtIconAsset.js +91 -0
  254. package/src/model/TmsCardArtIconAssetLinks.js +81 -0
  255. package/src/model/{Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.js → TmsCardArtIconAssetLinksSelf.js} +9 -9
  256. package/src/model/{Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.js → TmsCardArtIssuerLogoAsset.js} +15 -14
  257. package/src/model/TmsCardArtIssuerLogoAssetLinks.js +81 -0
  258. package/src/model/{Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.js → TmsCardArtIssuerLogoAssetLinksSelf.js} +9 -9
  259. package/src/model/TmsEmbeddedInstrumentIdentifier.js +12 -4
  260. package/src/model/TmsEmbeddedInstrumentIdentifierBankAccount.js +1 -1
  261. package/src/model/TmsEmbeddedInstrumentIdentifierEmbedded.js +81 -0
  262. package/src/model/TmsNetworkTokenServices.js +121 -0
  263. package/src/model/TmsNetworkTokenServicesAmericanExpressTokenService.js +109 -0
  264. package/src/model/TmsNetworkTokenServicesMastercardDigitalEnablementService.js +100 -0
  265. package/src/model/TmsNetworkTokenServicesNotifications.js +82 -0
  266. package/src/model/TmsNetworkTokenServicesPaymentCredentials.js +82 -0
  267. package/src/model/TmsNetworkTokenServicesSynchronousProvisioning.js +82 -0
  268. package/src/model/TmsNetworkTokenServicesVisaTokenService.js +109 -0
  269. package/src/model/TmsNullify.js +100 -0
  270. package/src/model/TmsPaymentInstrumentProcessingInfo.js +1 -1
  271. package/src/model/TmsPaymentInstrumentProcessingInfoBankTransferOptions.js +1 -1
  272. package/src/model/TmsSensitivePrivileges.js +82 -0
  273. package/src/model/TmsTokenFormats.js +109 -0
  274. package/src/model/Tmsv2TokenizedCard.js +113 -43
  275. package/src/model/Tmsv2TokenizedCardCard.js +26 -8
  276. package/src/model/Tmsv2TokenizedCardLinks.js +81 -0
  277. package/src/model/Tmsv2TokenizedCardLinksSelf.js +82 -0
  278. package/src/model/Tmsv2TokenizedCardMetadata.js +15 -6
  279. package/src/model/Tmsv2TokenizedCardMetadataIssuer.js +101 -0
  280. package/src/model/Tmsv2TokenizedCardPasscode.js +83 -0
  281. package/src/model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.js +1 -1
  282. package/src/model/TokenPermissions.js +109 -0
  283. package/src/model/TssV2TransactionsGet200Response.js +6 -6
  284. package/src/model/TssV2TransactionsGet200ResponsePointOfSaleInformation.js +1 -1
  285. package/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +1 -1
  286. package/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js +1 -1
  287. package/src/model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.js +49 -4
  288. package/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js +1 -1
  289. package/docs/InlineResponse2011PaymentAccountInformation.md +0 -10
  290. package/docs/Microformv2sessionsCheckoutApiInitialization.md +0 -17
  291. package/docs/Tmsv2TokenizedCardMetadataCardArt.md +0 -14
  292. package/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.md +0 -9
  293. package/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.md +0 -8
  294. package/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.md +0 -8
  295. package/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.md +0 -9
  296. package/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.md +0 -8
  297. package/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.md +0 -8
  298. package/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.md +0 -9
  299. package/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.md +0 -8
  300. package/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.md +0 -8
  301. package/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAsset.md +0 -9
  302. package/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.md +0 -8
  303. package/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.md +0 -8
  304. package/docs/Tmsv2TokenizedCardMetadataCardArtIconAsset.md +0 -9
  305. package/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.md +0 -8
  306. package/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.md +0 -8
  307. package/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.md +0 -9
  308. package/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.md +0 -8
  309. package/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.md +0 -8
  310. package/docs/Upv1capturecontextsCheckoutApiInitialization.md +0 -17
  311. package/src/model/InlineResponse2011PaymentAccountInformation.js +0 -97
  312. package/src/model/Microformv2sessionsCheckoutApiInitialization.js +0 -155
  313. package/src/model/Tmsv2TokenizedCardMetadataCardArt.js +0 -130
  314. package/src/model/Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.js +0 -90
  315. package/src/model/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.js +0 -81
  316. package/src/model/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.js +0 -81
  317. package/src/model/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.js +0 -90
  318. package/src/model/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.js +0 -81
  319. package/src/model/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.js +0 -82
  320. package/src/model/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.js +0 -81
  321. package/src/model/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.js +0 -90
  322. package/src/model/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.js +0 -81
  323. package/src/model/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.js +0 -82
  324. package/src/model/Upv1capturecontextsCheckoutApiInitialization.js +0 -154
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
+
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
29
29
  **riskInformation** | [**Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) | | [optional]
30
30
  **acquirerInformation** | [**Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) | | [optional]
31
31
  **recurringPaymentInformation** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
32
+ **unscheduledPaymentInformation** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional]
32
33
  **hostedPaymentInformation** | [**Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) | | [optional]
33
34
  **watchlistScreeningInformation** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
34
35
 
@@ -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]
9
- **checkoutApiInitialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [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 **Important:** - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
9
+ **allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
10
10
 
11
11
 
@@ -3,14 +3,13 @@
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]
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]
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
+ **allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional]
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]
12
12
  **captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
13
13
  **orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional]
14
- **checkoutApiInitialization** | [**Upv1capturecontextsCheckoutApiInitialization**](Upv1capturecontextsCheckoutApiInitialization.md) | | [optional]
15
14
 
16
15
 
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
6
6
  **id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
7
7
  **submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
8
8
  **status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
9
- **paymentAccountInformation** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
10
- **issuerInformation** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
9
+ **paymentAccountInformation** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional]
10
+ **issuerInformation** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) | | [optional]
11
11
  **payoutInformation** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
12
12
 
13
13
 
@@ -79,7 +79,8 @@ var apiInstance = new CyberSource.InstrumentIdentifierApi();
79
79
  var instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
80
80
 
81
81
  var opts = {
82
- 'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
82
+ 'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
83
+ 'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
83
84
  };
84
85
 
85
86
  var callback = function(error, data, response) {
@@ -98,6 +99,7 @@ Name | Type | Description | Notes
98
99
  ------------- | ------------- | ------------- | -------------
99
100
  **instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
100
101
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
102
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
101
103
 
102
104
  ### Return type
103
105
 
@@ -130,6 +132,7 @@ var instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The I
130
132
 
131
133
  var opts = {
132
134
  'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
135
+ 'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
133
136
  'offset': 0, // Number | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
134
137
  'limit': 20 // Number | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.
135
138
  };
@@ -150,6 +153,7 @@ Name | Type | Description | Notes
150
153
  ------------- | ------------- | ------------- | -------------
151
154
  **instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
152
155
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
156
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
153
157
  **offset** | **Number**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
154
158
  **limit** | **Number**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20]
155
159
 
@@ -186,6 +190,7 @@ var patchInstrumentIdentifierRequest = new CyberSource.PatchInstrumentIdentifier
186
190
 
187
191
  var opts = {
188
192
  'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
193
+ 'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
189
194
  'ifMatch': "ifMatch_example" // String | Contains an ETag value from a GET request to make the request conditional.
190
195
  };
191
196
 
@@ -206,6 +211,7 @@ Name | Type | Description | Notes
206
211
  **instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
207
212
  **patchInstrumentIdentifierRequest** | [**PatchInstrumentIdentifierRequest**](PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. |
208
213
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
214
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
209
215
  **ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
210
216
 
211
217
  ### Return type
@@ -238,7 +244,8 @@ var apiInstance = new CyberSource.InstrumentIdentifierApi();
238
244
  var postInstrumentIdentifierRequest = new CyberSource.PostInstrumentIdentifierRequest(); // PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
239
245
 
240
246
  var opts = {
241
- 'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
247
+ 'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
248
+ 'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
242
249
  };
243
250
 
244
251
  var callback = function(error, data, response) {
@@ -257,6 +264,7 @@ Name | Type | Description | Notes
257
264
  ------------- | ------------- | ------------- | -------------
258
265
  **postInstrumentIdentifierRequest** | [**PostInstrumentIdentifierRequest**](PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card |
259
266
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
267
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
260
268
 
261
269
  ### Return type
262
270
 
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
10
10
  **senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional]
11
11
  **processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional]
12
12
  **paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional]
13
+ **aggregatorInformation** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional]
13
14
 
14
15
 
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
16
16
  **processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
17
17
  **billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
18
18
  **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19
+ **embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
19
20
 
20
21
 
@@ -77,7 +77,8 @@ var apiInstance = new CyberSource.PaymentInstrumentApi();
77
77
  var paymentInstrumentId = "paymentInstrumentId_example"; // String | The Id of a payment instrument.
78
78
 
79
79
  var opts = {
80
- 'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
80
+ 'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
81
+ 'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
81
82
  };
82
83
 
83
84
  var callback = function(error, data, response) {
@@ -96,6 +97,7 @@ Name | Type | Description | Notes
96
97
  ------------- | ------------- | ------------- | -------------
97
98
  **paymentInstrumentId** | **String**| The Id of a payment instrument. |
98
99
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
100
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
99
101
 
100
102
  ### Return type
101
103
 
@@ -130,6 +132,7 @@ var patchPaymentInstrumentRequest = new CyberSource.PatchPaymentInstrumentReques
130
132
 
131
133
  var opts = {
132
134
  'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
135
+ 'retrieveBinDetails': true, // Boolean | Retrieve the Bin Details of PAN or network token
133
136
  'ifMatch': "ifMatch_example" // String | Contains an ETag value from a GET request to make the request conditional.
134
137
  };
135
138
 
@@ -150,6 +153,7 @@ Name | Type | Description | Notes
150
153
  **paymentInstrumentId** | **String**| The Id of a payment instrument. |
151
154
  **patchPaymentInstrumentRequest** | [**PatchPaymentInstrumentRequest**](PatchPaymentInstrumentRequest.md)| |
152
155
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
156
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
153
157
  **ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
154
158
 
155
159
  ### Return type
@@ -182,7 +186,8 @@ var apiInstance = new CyberSource.PaymentInstrumentApi();
182
186
  var postPaymentInstrumentRequest = new CyberSource.PostPaymentInstrumentRequest(); // PostPaymentInstrumentRequest |
183
187
 
184
188
  var opts = {
185
- 'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration.
189
+ 'profileId': "profileId_example", // String | The Id of a profile containing user specific TMS configuration.
190
+ 'retrieveBinDetails': true // Boolean | Retrieve the Bin Details of PAN or network token
186
191
  };
187
192
 
188
193
  var callback = function(error, data, response) {
@@ -201,6 +206,7 @@ Name | Type | Description | Notes
201
206
  ------------- | ------------- | ------------- | -------------
202
207
  **postPaymentInstrumentRequest** | [**PostPaymentInstrumentRequest**](PostPaymentInstrumentRequest.md)| |
203
208
  **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
209
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
204
210
 
205
211
  ### Return type
206
212
 
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
16
16
  **processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
17
17
  **billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
18
18
  **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19
+ **embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
19
20
 
20
21
 
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
16
16
  **processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
17
17
  **billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
18
18
  **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
19
+ **embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
19
20
 
20
21
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **paymentCredentialType** | **String** | The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If \"NETWORK_TOKEN\" is supplied then only network token will be returned and cryptogram or dynamic CVV will be excluded. Possible Values: - NETWORK_TOKEN | [optional]
6
+ **paymentCredentialType** | **String** | The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested. If \"SECURITY_CODE\" is supplied then dynamic CVV will be requested and returned with the network token card number. Dynamic CVV is only supported for Amex and SCOF. If \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex. Possible Values: - NETWORK_TOKEN - SECURITY_CODE - CRYPTOGRAM | [optional]
7
7
 
8
8
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer's receipt. | [optional]
11
11
  **responseDetails** | **String** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional]
12
12
  **merchantAdvice** | [**PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice**](PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md) | | [optional]
13
+ **merchantRiskPrediction** | **String** | Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. | [optional]
13
14
  **sellerProtection** | [**PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection**](PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection.md) | | [optional]
14
15
 
15
16
 
@@ -40,6 +40,7 @@ Name | Type | Description | Notes
40
40
  **whiteListStatusSource** | **String** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional]
41
41
  **xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional]
42
42
  **directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional]
43
+ **dataQualityIndicator** | **String** | The field is used to indicate that a transaction does not meet the Visa Secure authentication data quality requirements. | [optional]
43
44
  **authenticationResult** | **String** | Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication. | [optional]
44
45
  **authenticationStatusMsg** | **String** | Message that explains the authenticationResult reply field. | [optional]
45
46
  **indicator** | **String** | Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard Identity Check authentication verified successfully. - `spa_failure`: Mastercard Identity Check failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable. | [optional]
@@ -8,5 +8,7 @@ Name | Type | Description | Notes
8
8
  **CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
9
9
  **VALIDATE_CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
10
10
  **WATCHLIST_SCREENING** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING**](PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md) | | [optional]
11
+ **TOKEN_CREATE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE**](PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md) | | [optional]
12
+ **TOKEN_UPDATE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE**](PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md) | | [optional]
11
13
 
12
14
 
@@ -0,0 +1,10 @@
1
+ # CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **status** | **String** | The status of the token create. Possible value is: - SUCCESS - SERVER_ERROR - INVALID_REQUEST | [optional]
7
+ **reason** | **String** | The reason of the status. Possible values: - INVALID_DATA - SYSTEM_ERROR - MISSING_FIELD | [optional]
8
+ **message** | **String** | The detail message related to the status and reason listed above. | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **status** | **String** | The status of the token update. Possible value is: - SUCCESS - SERVER_ERROR - INVALID_REQUEST | [optional]
7
+ **reason** | **String** | The reason of the status. Possible values: - INVALID_DATA - SYSTEM_ERROR - MISSING_FIELD | [optional]
8
+ **message** | **String** | The detail message related to the status and reason listed above. | [optional]
9
+
10
+
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
21
21
  **signatureDebit** | **String** | Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
22
22
  **prepaid** | **String** | Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
23
23
  **regulated** | **String** | Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
24
+ **accountHolderType** | **String** | This is the account owner information, valid values are: - `01` : primary account holder - `02` : secondary account holder This is returned in the response of an account verification transaction by the Issuer. | [optional]
24
25
 
25
26
 
@@ -7,5 +7,7 @@ Name | Type | Description | Notes
7
7
  **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]
8
8
  **enhancedDataEnabled** | **Boolean** | The possible values for the reply field are: - `true` : the airline data was included in the request to the processor. - `false` : the airline data was not included in the request to the processor. Returned by authorization, capture, or credit services. | [optional]
9
9
  **captureOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationCaptureOptions**](PtsV2PaymentsPost201ResponseProcessingInformationCaptureOptions.md) | | [optional]
10
+ **authorizationOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions**](PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md) | | [optional]
11
+ **purchaseOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions**](PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md) | | [optional]
10
12
 
11
13
 
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **serviceType** | **String** | Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time funding or a live-load. This type of transaction can also be connected to a purchase. In back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: - account one is used to make the purchase - account two is used to automatically fund or reimburse account one Possible values: - 0B = back to back funding transaction - 00 = normal transaction - 01 = originator hold - 02 = Visa deferred OCT hold, default interval - 03 = Visa deferred OCT hold, user-defined interval - 09 = Cancel pending deferred OCT request - 0I = Visa Direct custom program 1 - 0Q = uery the status of the deferred OCT - A0 = Alias Directory 2 | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **eligibilityIndicator** | **String** | This field contains installment data defined by MasterCard. Possible values: - Y = eligible - N = not eligile | [optional]
7
+ **type** | **String** | Data mapped received in response from MasterCard. Possible values: - 01 = Meal Voucher - Employee Nutrition Program - 02 = Food Voucher - Employee Nutrition Program - 03 = Culture Voucher - Worker's Culture Program - 04 = Meal Voucher - Consolidation of Labor Laws - 05 = Food Voucher - Consolidation of Labor Laws | [optional]
8
+ **benefitAmount** | **String** | Workplace benefit amount. | [optional]
9
+ **benefitType** | **String** | Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education | [optional]
10
+
11
+
@@ -47,5 +47,6 @@ Name | Type | Description | Notes
47
47
  **expirationTimeUtc** | **String** | The date and time when the authorized payment expires, in Internet date and time format. | [optional]
48
48
  **orderId** | **String** | The id of the order | [optional]
49
49
  **orderStatus** | **String** | The order status. Possible values: - `CREATED` - `VOIDED` - `COMPLETED` - `PAYER_ACTION_REQUIRED` | [optional]
50
+ **merchantRiskPrediction** | **String** | Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. | [optional]
50
51
 
51
52
 
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **transactionId** | **String** | Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional]
7
7
  **responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional]
8
+ **networkTransactionId** | **String** | Same value as `processorInformation.transactionId` | [optional]
8
9
  **responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the `processorInformation.responseCode` or `issuerInformation.responseCode` field of the service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting #### Maximum length for processors - Comercio Latino: 36 - All other processors: 3 | [optional]
9
10
  **forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway. Please contact the CyberSource Japan Support Group for more information. | [optional]
10
11
  **masterCardServiceCode** | **String** | Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. | [optional]
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
16
16
  **recipientInformation** | [**PtsV2PayoutsPost201ResponseRecipientInformation**](PtsV2PayoutsPost201ResponseRecipientInformation.md) | | [optional]
17
17
  **issuerInformation** | [**PtsV2PayoutsPost201ResponseIssuerInformation**](PtsV2PayoutsPost201ResponseIssuerInformation.md) | | [optional]
18
18
  **tokenInformation** | [**PtsV2PaymentsPost201ResponseTokenInformation**](PtsV2PaymentsPost201ResponseTokenInformation.md) | | [optional]
19
+ **processingInformation** | [**PtsV2PayoutsPost201ResponseProcessingInformation**](PtsV2PayoutsPost201ResponseProcessingInformation.md) | | [optional]
19
20
 
20
21
 
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PayoutsPost201ResponseProcessingInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **purchaseOptions** | [**Ptsv2payoutsProcessingInformationPurchaseOptions**](Ptsv2payoutsProcessingInformationPurchaseOptions.md) | | [optional]
7
+
8
+
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **lastInstallmentDate** | **String** | End date of the SI transactions. Cannot be later than card expiry date. Ideally this can be set to expiry date. Required in case the authentication is initiated for SI registration. | [optional]
10
10
  **maxAmount** | **String** | Maximum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
11
11
  **minAmount** | **String** | Minimum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
12
- **paymentType** | **String** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional]
12
+ **paymentType** | **String** | Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow. | [optional]
13
13
  **preferredDay** | **String** | Preferred date for initiating the SI transaction every month. This field need not be sent in case the SI has to be initiated as and when required, e.g., topping up the wallet, etc. | [optional]
14
14
  **sequence** | **Number** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional]
15
15
 
@@ -6,5 +6,10 @@ Name | Type | Description | Notes
6
6
  **aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. | [optional]
7
7
  **name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. | [optional]
8
8
  **subMerchant** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional]
9
+ **streetAddress** | **String** | Acquirer street name. | [optional]
10
+ **city** | **String** | Acquirer city. | [optional]
11
+ **state** | **String** | Acquirer state. | [optional]
12
+ **postalCode** | **String** | Acquirer postal code. | [optional]
13
+ **country** | **String** | Acquirer country. | [optional]
9
14
 
10
15