cybersource-rest-client 0.0.77 → 0.0.79

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 (429) hide show
  1. package/MLE.md +66 -1
  2. package/README.md +124 -0
  3. package/docs/AccountValidationsRequest.md +1 -0
  4. package/docs/Acpv1mppcredentialsChallenge.md +15 -0
  5. package/docs/Acpv1mppcredentialsChallengeEncryptionJwk.md +13 -0
  6. package/docs/Acpv1tokensAssuranceData.md +6 -6
  7. package/docs/AuthReversalRequest.md +1 -0
  8. package/docs/BatchesApi.md +1 -1
  9. package/docs/Bavsv1accountvalidationsPaymentInformation.md +4 -1
  10. package/docs/Bavsv1accountvalidationsPaymentInformationBank.md +1 -1
  11. package/docs/Bavsv1accountvalidationsPaymentInformationBankAccount.md +1 -1
  12. package/docs/Bavsv1accountvalidationsPaymentInformationCustomer.md +8 -0
  13. package/docs/Bavsv1accountvalidationsPaymentInformationInstrumentIdentifier.md +8 -0
  14. package/docs/Bavsv1accountvalidationsPaymentInformationPaymentInstrument.md +8 -0
  15. package/docs/Bavsv1accountvalidationsTokenInformation.md +9 -0
  16. package/docs/CardProcessingConfigCommonProcessors.md +4 -0
  17. package/docs/CommerceSolutionsProducts.md +1 -0
  18. package/docs/CreateCreditRequest.md +1 -0
  19. package/docs/CreateNewWebhooksApi.md +7 -9
  20. package/docs/CredentialsApi.md +55 -0
  21. package/docs/CustomerPaymentInstrumentApi.md +2 -2
  22. package/docs/EnrollmentApi.md +1 -1
  23. package/docs/GetAllSubscriptionsResponseOrderInformationAmountDetailsSurcharge.md +1 -0
  24. package/docs/GetSubscriptionsPaymentsResponse.md +13 -0
  25. package/docs/GetSubscriptionsPaymentsResponse1.md +11 -0
  26. package/docs/{PblPaymentLinksPost201ResponseLinks.md → GetSubscriptionsPaymentsResponse1Links.md} +1 -1
  27. package/docs/GetSubscriptionsPaymentsResponseCyclesCompletedCount.md +8 -0
  28. package/docs/GetSubscriptionsPaymentsResponseLinks.md +10 -0
  29. package/docs/GetSubscriptionsPaymentsResponseSubscriptionPayment.md +22 -0
  30. package/docs/InlineResponse2011TokenizedCard.md +2 -0
  31. package/docs/InlineResponse2014SetupsCommerceSolutions.md +1 -0
  32. package/docs/InlineResponse2014SetupsPayments.md +2 -0
  33. package/docs/InlineResponse2014SetupsRisk.md +1 -0
  34. package/docs/InlineResponse2014SetupsValueAddedServices.md +2 -0
  35. package/docs/InlineResponse40010.md +5 -6
  36. package/docs/{InlineResponse4008Details.md → InlineResponse40010Details.md} +1 -1
  37. package/docs/InlineResponse40011.md +12 -0
  38. package/docs/InlineResponse40011Details.md +9 -0
  39. package/docs/InlineResponse40012.md +13 -0
  40. package/docs/InlineResponse4006.md +5 -6
  41. package/docs/InlineResponse4007.md +5 -5
  42. package/docs/InlineResponse4008.md +6 -5
  43. package/docs/{InlineResponse4006Fields.md → InlineResponse4008Fields.md} +1 -1
  44. package/docs/InlineResponse4009.md +4 -4
  45. package/docs/InlineResponse4009Details.md +2 -2
  46. package/docs/InlineResponse4043.md +1 -1
  47. package/docs/InlineResponse4221.md +1 -1
  48. package/docs/InstructionsApi.md +5 -5
  49. package/docs/InstrumentIdentifierApi.md +2 -2
  50. package/docs/Iplv2paymentlinksOrderInformationLineItems.md +4 -0
  51. package/docs/ManageWebhooksApi.md +14 -16
  52. package/docs/MitReversalRequest.md +1 -0
  53. package/docs/MppCredentialsRequest.md +9 -0
  54. package/docs/MppCredentialsResponse200.md +15 -0
  55. package/docs/NetworkTokensApi.md +377 -0
  56. package/docs/PatchCustomerPaymentInstrumentRequest.md +1 -1
  57. package/docs/PatchCustomerRequest.md +1 -1
  58. package/docs/PatchPaymentInstrumentRequest.md +1 -1
  59. package/docs/PaymentInstrumentList1Embedded.md +1 -1
  60. package/docs/PaymentInstrumentListEmbedded.md +1 -1
  61. package/docs/{PaymentInstrumentList1EmbeddedEmbedded.md → PaymentInstrumentListEmbeddedEmbedded.md} +1 -1
  62. package/docs/{PaymentInstrumentList1EmbeddedPaymentInstruments.md → PaymentInstrumentListEmbeddedPaymentInstruments.md} +2 -2
  63. package/docs/PaymentsProducts.md +2 -0
  64. package/docs/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors.md +3 -2
  65. package/docs/PaymentsProductsMicroform.md +9 -0
  66. package/docs/PaymentsProductsMicroformConfigurationInformation.md +9 -0
  67. package/docs/PaymentsProductsMicroformConfigurationInformationConfigurations.md +8 -0
  68. package/docs/PaymentsProductsMicroformConfigurationInformationConfigurationsFeatures.md +8 -0
  69. package/docs/PaymentsProductsMicroformConfigurationInformationConfigurationsFeaturesGatewayAgnostic.md +8 -0
  70. package/docs/PaymentsProductsMicroformSubscriptionInformation.md +11 -0
  71. package/docs/PblPaymentLinksGet200Response.md +1 -1
  72. package/docs/PblPaymentLinksPost201Response.md +1 -1
  73. package/docs/PostCustomerPaymentInstrumentRequest.md +1 -1
  74. package/docs/PostCustomerRequest.md +1 -1
  75. package/docs/PostPaymentInstrumentRequest.md +1 -1
  76. package/docs/PostTokenizedCardRequest.md +1 -0
  77. package/docs/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation.md +5 -0
  78. package/docs/PtsV2CreditsPost201Response.md +4 -0
  79. package/docs/PtsV2CreditsPost201ResponseMerchantInformation.md +8 -0
  80. package/docs/PtsV2CreditsPost201ResponsePaymentAccountInformation.md +8 -0
  81. package/docs/PtsV2CreditsPost201ResponsePaymentInformation.md +1 -0
  82. package/docs/PtsV2CreditsPost201ResponsePaymentInformationAccountFeatures.md +8 -0
  83. package/docs/PtsV2CreditsPost201ResponseTokenInformation.md +8 -0
  84. package/docs/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation.md +2 -0
  85. package/docs/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation.md +1 -0
  86. package/docs/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.md +1 -1
  87. package/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails.md +1 -1
  88. package/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +7 -0
  89. package/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication.md +1 -0
  90. package/docs/PtsV2PaymentsPost201ResponsePaymentAccountInformation.md +1 -0
  91. package/docs/{PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md → PtsV2PaymentsPost201ResponsePaymentAccountInformationTokenizedCard.md} +1 -1
  92. package/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md +1 -1
  93. package/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md +1 -0
  94. package/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md +2 -1
  95. package/docs/PtsV2PaymentsPost201ResponseTokenInformation.md +1 -0
  96. package/docs/PtsV2PaymentsPost201ResponseTokenInformationThirdPartyToken.md +9 -0
  97. package/docs/PtsV2PaymentsRefundPost201Response.md +1 -1
  98. package/docs/PtsV2PaymentsRefundPost201ResponseErrorInformation.md +1 -1
  99. package/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md +1 -0
  100. package/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md +2 -1
  101. package/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md +1 -1
  102. package/docs/PtsV2PaymentsVoidsPost201ResponseProcessorInformation.md +1 -1
  103. package/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md +4 -0
  104. package/docs/{PullFunds201ResponseProcessorInformationAvs.md → PtsV2PayoutsPost201ResponseProcessorInformationAvs.md} +1 -1
  105. package/docs/PtsV2PayoutsPost201ResponseProcessorInformationCustomer.md +8 -0
  106. package/docs/PtsV2PayoutsPost201ResponseProcessorInformationElectronicVerificationResults.md +13 -0
  107. package/docs/Ptsv1pullfundstransferBuyerInformation.md +8 -0
  108. package/docs/Ptsv1pullfundstransferOrderInformationAmountDetails.md +1 -1
  109. package/docs/Ptsv1pullfundstransferProcessingInformation.md +1 -0
  110. package/docs/Ptsv1pushfundstransferProcessingInformation.md +2 -1
  111. package/docs/Ptsv2billingagreementsAgreementInformation.md +5 -0
  112. package/docs/Ptsv2billingagreementsOrderInformation.md +2 -1
  113. package/docs/Ptsv2billingagreementsOrderInformationAmountDetails.md +10 -0
  114. package/docs/{Ptsv2intentsOrderInformationInvoiceDetails.md → Ptsv2billingagreementsOrderInformationInvoiceDetails.md} +1 -1
  115. package/docs/Ptsv2billingagreementsPaymentInformationBank.md +1 -0
  116. package/docs/Ptsv2billingagreementsPaymentInformationBankAccountAlias.md +9 -0
  117. package/docs/Ptsv2billingagreementsProcessingInformation.md +1 -0
  118. package/docs/Ptsv2billingagreementsidAgreementInformation.md +3 -0
  119. package/docs/Ptsv2billingagreementsidProcessingInformation.md +1 -0
  120. package/docs/Ptsv2creditsProcessingInformation.md +2 -0
  121. package/docs/Ptsv2creditsTokenInformation.md +11 -0
  122. package/docs/Ptsv2intentsOrderInformation.md +1 -1
  123. package/docs/Ptsv2intentsidOrderInformation.md +1 -1
  124. package/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md +1 -0
  125. package/docs/Ptsv2paymentsConsumerAuthenticationInformation.md +1 -0
  126. package/docs/Ptsv2paymentsOrderInformation.md +2 -0
  127. package/docs/Ptsv2paymentsOrderInformationDigitalCurrency.md +10 -0
  128. package/docs/Ptsv2paymentsOrderInformationShippingDetails.md +2 -1
  129. package/docs/Ptsv2paymentsPaymentInformation.md +2 -0
  130. package/docs/Ptsv2paymentsPaymentInformationBank.md +1 -0
  131. package/docs/Ptsv2paymentsPaymentInformationBankAccountAlias.md +9 -0
  132. package/docs/Ptsv2paymentsPaymentInformationThirdPartyToken.md +8 -0
  133. package/docs/Ptsv2paymentsPointOfSaleInformation.md +1 -0
  134. package/docs/Ptsv2paymentsProcessingInformation.md +6 -1
  135. package/docs/Ptsv2paymentsProcessingInformationProgramIndicators.md +9 -0
  136. package/docs/Ptsv2paymentsProcessorInformation.md +3 -0
  137. package/docs/Ptsv2paymentsRecipientInformation.md +1 -0
  138. package/docs/Ptsv2paymentsSenderInformation.md +1 -0
  139. package/docs/Ptsv2paymentsTokenInformation.md +2 -0
  140. package/docs/Ptsv2paymentsTokenInformationTokenAuthenticationInformation.md +8 -0
  141. package/docs/Ptsv2paymentsTokenInformationTokenAuthenticationInformationAuthenticatedIdentities.md +12 -0
  142. package/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md +1 -0
  143. package/docs/Ptsv2paymentsidcapturesOrderInformationShippingDetails.md +5 -0
  144. package/docs/Ptsv2paymentsidcapturesPointOfSaleInformation.md +1 -0
  145. package/docs/Ptsv2paymentsidcapturesProcessingInformation.md +1 -0
  146. package/docs/Ptsv2paymentsidcapturesProcessorInformation.md +2 -0
  147. package/docs/Ptsv2paymentsidrefundsOrderInformation.md +2 -1
  148. package/docs/Ptsv2paymentsidrefundsOrderInformationShippingDetails.md +8 -0
  149. package/docs/Ptsv2paymentsidrefundsPaymentInformation.md +2 -0
  150. package/docs/Ptsv2paymentsidreversalsDeviceInformation.md +8 -0
  151. package/docs/Ptsv2paymentsidreversalsPaymentInformation.md +1 -0
  152. package/docs/Ptsv2payoutsProcessingInformation.md +1 -0
  153. package/docs/PullFunds201ResponseProcessorInformation.md +4 -1
  154. package/docs/PullFundsRequest.md +1 -0
  155. package/docs/PushFunds201ResponseProcessorInformation.md +4 -0
  156. package/docs/RiskProducts.md +1 -0
  157. package/docs/Riskv1decisionsOrderInformationShipTo.md +2 -0
  158. package/docs/Riskv1decisionsOrderInformationShippingDetails.md +1 -1
  159. package/docs/SubscriptionsApi.md +108 -1
  160. package/docs/TmsCardArt.md +2 -0
  161. package/docs/TmsEmbeddedInstrumentIdentifierBillTo.md +1 -0
  162. package/docs/TmsTokenizedCardDeleteRequest.md +8 -0
  163. package/docs/Tmsv1paymentinstrumentsEmbedded.md +8 -0
  164. package/docs/Tmsv2TokenizedCard.md +2 -0
  165. package/docs/Tmsv2TokenizedCardCard.md +1 -1
  166. package/docs/Tmsv2TokenizedCardMetadata.md +1 -0
  167. package/docs/Tmsv2TokenizedCardMetadataIssuer.md +6 -3
  168. package/docs/Tmsv2TokenizedCardMetadataIssuerBankApplications.md +9 -0
  169. package/docs/Tmsv2TokenizedCardMetadataIssuerCapabilities.md +14 -0
  170. package/docs/Tmsv2TokenizedCardVerificationResults.md +9 -0
  171. package/docs/Tmsv2customersEmbedded.md +9 -0
  172. package/docs/{Tmsv3tokenstokenIdpaymentcredentialsOrderInformationBillTo.md → Tmsv2tokenizedcardsBillTo.md} +1 -1
  173. package/docs/Tmsv2tokenizedcardstokenizedCardIddeleteReason.md +9 -0
  174. package/docs/Tmsv3tokenstokenIdpaymentcredentialsOrderInformation.md +1 -1
  175. package/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md +1 -1
  176. package/docs/TssV2TransactionsGet200ResponseSenderInformation.md +1 -1
  177. package/docs/Ucv1sessionsData.md +4 -1
  178. package/docs/Ucv1sessionsDataAggregatorInformation.md +16 -0
  179. package/docs/Ucv1sessionsDataAggregatorInformationSubMerchant.md +18 -0
  180. package/docs/Ucv1sessionsDataConsumerAuthenticationInformation.md +1 -0
  181. package/docs/Ucv1sessionsDataInstallmentInformation.md +8 -0
  182. package/docs/Ucv1sessionsDataMerchantInformation.md +1 -0
  183. package/docs/Ucv1sessionsDataMerchantInformationMerchantDescriptor.md +1 -0
  184. package/docs/Ucv1sessionsDataOrderInformation.md +3 -2
  185. package/docs/Ucv1sessionsDataOrderInformationAmountDetails.md +5 -1
  186. package/docs/Ucv1sessionsDataOrderInformationInvoiceDetails.md +11 -0
  187. package/docs/Ucv1sessionsDataOrderInformationInvoiceDetailsTransactionAdviceAddendum.md +8 -0
  188. package/docs/Ucv1sessionsDataOrderInformationLineItems.md +40 -0
  189. package/docs/Ucv1sessionsDataOrderInformationShippingDetails.md +9 -0
  190. package/docs/Ucv1sessionsDataProcessingInformation.md +3 -0
  191. package/docs/Ucv1sessionsDataProcessingInformationBankTransferOptions.md +8 -0
  192. package/docs/Ucv1sessionsDataProcessingInformationRecurringOptions.md +8 -0
  193. package/docs/Ucv1sessionsDataRecipientInformation.md +12 -9
  194. package/docs/Ucv1sessionsDataSenderInformation.md +19 -0
  195. package/docs/Ucv1sessionsDataSenderInformationAccount.md +9 -0
  196. package/docs/UpdatePayments.md +8 -0
  197. package/docs/ValueAddedServicesProducts.md +2 -0
  198. package/package.json +3 -3
  199. package/src/ApiClient.js +6 -0
  200. package/src/api/BankAccountValidationApi.js +4 -4
  201. package/src/api/BatchesApi.js +1 -1
  202. package/src/api/CreateNewWebhooksApi.js +6 -16
  203. package/src/api/CredentialsApi.js +120 -0
  204. package/src/api/CustomerPaymentInstrumentApi.js +7 -7
  205. package/src/api/DeviceDeAssociationApi.js +4 -4
  206. package/src/api/DeviceSearchApi.js +4 -4
  207. package/src/api/EnrollmentApi.js +1 -1
  208. package/src/api/InstructionsApi.js +5 -5
  209. package/src/api/InstrumentIdentifierApi.js +7 -7
  210. package/src/api/ManageWebhooksApi.js +12 -22
  211. package/src/api/MerchantBoardingApi.js +4 -4
  212. package/src/api/NetworkTokensApi.js +578 -0
  213. package/src/api/OffersApi.js +4 -4
  214. package/src/api/PlansApi.js +1 -1
  215. package/src/api/ReportSubscriptionsApi.js +4 -4
  216. package/src/api/SecureFileShareApi.js +4 -4
  217. package/src/api/SubscriptionsApi.js +155 -6
  218. package/src/api/SubscriptionsFollowOnsApi.js +1 -1
  219. package/src/authentication/core/MerchantConfig.js +79 -27
  220. package/src/authentication/jwt/JWTSigToken.js +58 -25
  221. package/src/authentication/util/Cache.js +1 -1
  222. package/src/authentication/util/Constants.js +4 -1
  223. package/src/authentication/util/JWEUtility.js +7 -10
  224. package/src/authentication/util/MLEUtility.js +25 -16
  225. package/src/index.js +355 -60
  226. package/src/model/AccountValidationsRequest.js +12 -4
  227. package/src/model/Acpv1instructionsDeclineThreshold.js +1 -1
  228. package/src/model/Acpv1instructionsMandates.js +1 -1
  229. package/src/model/Acpv1instructionsRecurringPaymentInformation.js +1 -1
  230. package/src/model/Acpv1instructionsinstructionIdconfirmationsProcessorInformation.js +1 -1
  231. package/src/model/Acpv1instructionsinstructionIdconfirmationsProcessorInformationPaymentInstrument.js +1 -1
  232. package/src/model/Acpv1instructionsinstructionIdcredentialsOrderInformationAmountDetail.js +1 -1
  233. package/src/model/Acpv1mppcredentialsChallenge.js +153 -0
  234. package/src/model/Acpv1mppcredentialsChallengeEncryptionJwk.js +134 -0
  235. package/src/model/Acpv1tokensAssuranceData.js +10 -10
  236. package/src/model/Acpv1tokensAuthenticatedIdentities.js +1 -1
  237. package/src/model/Acpv1tokensAuthenticationContext.js +1 -1
  238. package/src/model/Acpv1tokensBillTo.js +1 -1
  239. package/src/model/Acpv1tokensBuyerInformation.js +1 -1
  240. package/src/model/Acpv1tokensConsumerIdentity.js +1 -1
  241. package/src/model/Acpv1tokensDeviceInformation.js +1 -1
  242. package/src/model/Acpv1tokensEnrollmentReferenceData.js +1 -1
  243. package/src/model/Acpv1tokensPaymentInformation.js +1 -1
  244. package/src/model/AuthReversalRequest.js +12 -4
  245. package/src/model/Bavsv1accountvalidationsPaymentInformation.js +31 -7
  246. package/src/model/Bavsv1accountvalidationsPaymentInformationBank.js +2 -2
  247. package/src/model/Bavsv1accountvalidationsPaymentInformationBankAccount.js +2 -2
  248. package/src/model/Bavsv1accountvalidationsPaymentInformationCustomer.js +82 -0
  249. package/src/model/Bavsv1accountvalidationsPaymentInformationInstrumentIdentifier.js +82 -0
  250. package/src/model/Bavsv1accountvalidationsPaymentInformationPaymentInstrument.js +82 -0
  251. package/src/model/Bavsv1accountvalidationsTokenInformation.js +92 -0
  252. package/src/model/CardProcessingConfigCommonProcessors.js +36 -0
  253. package/src/model/CommerceSolutionsProducts.js +12 -4
  254. package/src/model/CreateCreditRequest.js +12 -4
  255. package/src/model/GetAllSubscriptionsResponseOrderInformationAmountDetailsSurcharge.js +9 -0
  256. package/src/model/GetSubscriptionsPaymentsResponse.js +125 -0
  257. package/src/model/GetSubscriptionsPaymentsResponse1.js +108 -0
  258. package/src/model/{PblPaymentLinksPost201ResponseLinks.js → GetSubscriptionsPaymentsResponse1Links.js} +8 -8
  259. package/src/model/GetSubscriptionsPaymentsResponseCyclesCompletedCount.js +83 -0
  260. package/src/model/GetSubscriptionsPaymentsResponseLinks.js +97 -0
  261. package/src/model/GetSubscriptionsPaymentsResponseSubscriptionPayment.js +208 -0
  262. package/src/model/InlineResponse2011TokenizedCard.js +21 -4
  263. package/src/model/InlineResponse2014SetupsCommerceSolutions.js +8 -0
  264. package/src/model/InlineResponse2014SetupsPayments.js +16 -0
  265. package/src/model/InlineResponse2014SetupsRisk.js +8 -0
  266. package/src/model/InlineResponse2014SetupsValueAddedServices.js +16 -0
  267. package/src/model/InlineResponse40010.js +28 -39
  268. package/src/model/{InlineResponse4008Details.js → InlineResponse40010Details.js} +8 -8
  269. package/src/model/InlineResponse40011.js +117 -0
  270. package/src/model/{InlineResponse4007Details.js → InlineResponse40011Details.js} +10 -10
  271. package/src/model/InlineResponse40012.js +129 -0
  272. package/src/model/InlineResponse4006.js +30 -43
  273. package/src/model/InlineResponse4007.js +12 -12
  274. package/src/model/InlineResponse4008.js +39 -27
  275. package/src/model/{InlineResponse4006Fields.js → InlineResponse4008Fields.js} +8 -8
  276. package/src/model/InlineResponse4009.js +13 -13
  277. package/src/model/InlineResponse4009Details.js +2 -2
  278. package/src/model/InlineResponse4043.js +6 -6
  279. package/src/model/InlineResponse4221.js +6 -6
  280. package/src/model/Iplv2paymentlinksOrderInformationLineItems.js +36 -0
  281. package/src/model/MitReversalRequest.js +12 -4
  282. package/src/model/MppCredentialsRequest.js +93 -0
  283. package/src/model/MppCredentialsResponse200.js +154 -0
  284. package/src/model/PatchCustomerPaymentInstrumentRequest.js +6 -6
  285. package/src/model/PatchCustomerRequest.js +6 -6
  286. package/src/model/PatchPaymentInstrumentRequest.js +6 -6
  287. package/src/model/PaymentInstrumentList1Embedded.js +6 -6
  288. package/src/model/PaymentInstrumentListEmbedded.js +6 -6
  289. package/src/model/{PaymentInstrumentList1EmbeddedEmbedded.js → PaymentInstrumentListEmbeddedEmbedded.js} +8 -8
  290. package/src/model/{PaymentInstrumentList1EmbeddedPaymentInstruments.js → PaymentInstrumentListEmbeddedPaymentInstruments.js} +13 -13
  291. package/src/model/PaymentsProducts.js +20 -4
  292. package/src/model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors.js +11 -1
  293. package/src/model/PaymentsProductsMicroform.js +89 -0
  294. package/src/model/PaymentsProductsMicroformConfigurationInformation.js +89 -0
  295. package/src/model/PaymentsProductsMicroformConfigurationInformationConfigurations.js +81 -0
  296. package/src/model/PaymentsProductsMicroformConfigurationInformationConfigurationsFeatures.js +81 -0
  297. package/src/model/PaymentsProductsMicroformConfigurationInformationConfigurationsFeaturesGatewayAgnostic.js +81 -0
  298. package/src/model/PaymentsProductsMicroformSubscriptionInformation.js +109 -0
  299. package/src/model/PblPaymentLinksGet200Response.js +6 -6
  300. package/src/model/PblPaymentLinksPost201Response.js +6 -6
  301. package/src/model/PostCustomerPaymentInstrumentRequest.js +6 -6
  302. package/src/model/PostCustomerRequest.js +6 -6
  303. package/src/model/PostPaymentInstrumentRequest.js +6 -6
  304. package/src/model/PostTokenizedCardRequest.js +12 -4
  305. package/src/model/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation.js +45 -0
  306. package/src/model/PtsV2CreditsPost201Response.js +36 -4
  307. package/src/model/PtsV2CreditsPost201ResponseMerchantInformation.js +82 -0
  308. package/src/model/PtsV2CreditsPost201ResponsePaymentAccountInformation.js +81 -0
  309. package/src/model/PtsV2CreditsPost201ResponsePaymentInformation.js +12 -4
  310. package/src/model/PtsV2CreditsPost201ResponsePaymentInformationAccountFeatures.js +82 -0
  311. package/src/model/PtsV2CreditsPost201ResponseTokenInformation.js +81 -0
  312. package/src/model/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation.js +18 -0
  313. package/src/model/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation.js +9 -0
  314. package/src/model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.js +1 -1
  315. package/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails.js +1 -1
  316. package/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js +63 -0
  317. package/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication.js +9 -0
  318. package/src/model/PtsV2PaymentsPost201ResponsePaymentAccountInformation.js +12 -4
  319. package/src/model/{PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.js → PtsV2PaymentsPost201ResponsePaymentAccountInformationTokenizedCard.js} +8 -8
  320. package/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js +6 -6
  321. package/src/model/PtsV2PaymentsPost201ResponseProcessingInformation.js +9 -0
  322. package/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js +10 -1
  323. package/src/model/PtsV2PaymentsPost201ResponseTokenInformation.js +12 -4
  324. package/src/model/PtsV2PaymentsPost201ResponseTokenInformationThirdPartyToken.js +91 -0
  325. package/src/model/PtsV2PaymentsRefundPost201Response.js +1 -1
  326. package/src/model/PtsV2PaymentsRefundPost201ResponseErrorInformation.js +1 -1
  327. package/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js +9 -0
  328. package/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js +10 -1
  329. package/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js +1 -1
  330. package/src/model/PtsV2PaymentsVoidsPost201ResponseProcessorInformation.js +1 -1
  331. package/src/model/PtsV2PayoutsPost201ResponseProcessorInformation.js +36 -4
  332. package/src/model/{PullFunds201ResponseProcessorInformationAvs.js → PtsV2PayoutsPost201ResponseProcessorInformationAvs.js} +8 -8
  333. package/src/model/PtsV2PayoutsPost201ResponseProcessorInformationCustomer.js +82 -0
  334. package/src/model/PtsV2PayoutsPost201ResponseProcessorInformationElectronicVerificationResults.js +127 -0
  335. package/src/model/Ptsv1pullfundstransferBuyerInformation.js +82 -0
  336. package/src/model/Ptsv1pullfundstransferOrderInformationAmountDetails.js +2 -2
  337. package/src/model/Ptsv1pullfundstransferProcessingInformation.js +9 -0
  338. package/src/model/Ptsv1pushfundstransferProcessingInformation.js +10 -1
  339. package/src/model/Ptsv2billingagreementsAgreementInformation.js +45 -0
  340. package/src/model/Ptsv2billingagreementsOrderInformation.js +14 -6
  341. package/src/model/Ptsv2billingagreementsOrderInformationAmountDetails.js +100 -0
  342. package/src/model/{Ptsv2intentsOrderInformationInvoiceDetails.js → Ptsv2billingagreementsOrderInformationInvoiceDetails.js} +8 -8
  343. package/src/model/Ptsv2billingagreementsPaymentInformationBank.js +12 -4
  344. package/src/model/Ptsv2billingagreementsPaymentInformationBankAccountAlias.js +91 -0
  345. package/src/model/Ptsv2billingagreementsProcessingInformation.js +9 -0
  346. package/src/model/Ptsv2billingagreementsidAgreementInformation.js +27 -0
  347. package/src/model/Ptsv2billingagreementsidProcessingInformation.js +9 -0
  348. package/src/model/Ptsv2creditsProcessingInformation.js +18 -0
  349. package/src/model/Ptsv2creditsTokenInformation.js +108 -0
  350. package/src/model/Ptsv2intentsOrderInformation.js +6 -6
  351. package/src/model/Ptsv2intentsidOrderInformation.js +6 -6
  352. package/src/model/Ptsv2paymentsAggregatorInformationSubMerchant.js +8 -0
  353. package/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js +9 -0
  354. package/src/model/Ptsv2paymentsOrderInformation.js +21 -4
  355. package/src/model/Ptsv2paymentsOrderInformationDigitalCurrency.js +101 -0
  356. package/src/model/Ptsv2paymentsOrderInformationShippingDetails.js +10 -1
  357. package/src/model/Ptsv2paymentsPaymentInformation.js +21 -4
  358. package/src/model/Ptsv2paymentsPaymentInformationBank.js +12 -4
  359. package/src/model/Ptsv2paymentsPaymentInformationBankAccountAlias.js +91 -0
  360. package/src/model/Ptsv2paymentsPaymentInformationThirdPartyToken.js +82 -0
  361. package/src/model/Ptsv2paymentsPointOfSaleInformation.js +9 -0
  362. package/src/model/Ptsv2paymentsProcessingInformation.js +49 -5
  363. package/src/model/Ptsv2paymentsProcessingInformationProgramIndicators.js +92 -0
  364. package/src/model/Ptsv2paymentsProcessorInformation.js +27 -0
  365. package/src/model/Ptsv2paymentsRecipientInformation.js +9 -0
  366. package/src/model/Ptsv2paymentsSenderInformation.js +9 -0
  367. package/src/model/Ptsv2paymentsTokenInformation.js +21 -4
  368. package/src/model/Ptsv2paymentsTokenInformationTokenAuthenticationInformation.js +83 -0
  369. package/src/model/Ptsv2paymentsTokenInformationTokenAuthenticationInformationAuthenticatedIdentities.js +118 -0
  370. package/src/model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.js +8 -0
  371. package/src/model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.js +46 -0
  372. package/src/model/Ptsv2paymentsidcapturesPointOfSaleInformation.js +9 -0
  373. package/src/model/Ptsv2paymentsidcapturesProcessingInformation.js +9 -0
  374. package/src/model/Ptsv2paymentsidcapturesProcessorInformation.js +18 -0
  375. package/src/model/Ptsv2paymentsidrefundsOrderInformation.js +14 -6
  376. package/src/model/Ptsv2paymentsidrefundsOrderInformationShippingDetails.js +82 -0
  377. package/src/model/Ptsv2paymentsidrefundsPaymentInformation.js +21 -4
  378. package/src/model/Ptsv2paymentsidreversalsDeviceInformation.js +82 -0
  379. package/src/model/Ptsv2paymentsidreversalsPaymentInformation.js +9 -0
  380. package/src/model/Ptsv2payoutsProcessingInformation.js +9 -0
  381. package/src/model/PullFunds201ResponseProcessorInformation.js +30 -6
  382. package/src/model/PullFundsRequest.js +12 -4
  383. package/src/model/PushFunds201ResponseProcessorInformation.js +36 -4
  384. package/src/model/RiskProducts.js +12 -4
  385. package/src/model/Riskv1decisionsOrderInformationShipTo.js +18 -0
  386. package/src/model/Riskv1decisionsOrderInformationShippingDetails.js +1 -1
  387. package/src/model/TmsCardArt.js +18 -0
  388. package/src/model/TmsEmbeddedInstrumentIdentifierBillTo.js +9 -0
  389. package/src/model/TmsTokenizedCardDeleteRequest.js +81 -0
  390. package/src/model/Tmsv1paymentinstrumentsEmbedded.js +82 -0
  391. package/src/model/Tmsv2TokenizedCard.js +21 -4
  392. package/src/model/Tmsv2TokenizedCardCard.js +1 -1
  393. package/src/model/Tmsv2TokenizedCardMetadata.js +9 -0
  394. package/src/model/Tmsv2TokenizedCardMetadataIssuer.js +32 -7
  395. package/src/model/Tmsv2TokenizedCardMetadataIssuerBankApplications.js +91 -0
  396. package/src/model/Tmsv2TokenizedCardMetadataIssuerCapabilities.js +137 -0
  397. package/src/model/Tmsv2TokenizedCardVerificationResults.js +92 -0
  398. package/src/model/Tmsv2customersEmbedded.js +90 -0
  399. package/src/model/{Tmsv3tokenstokenIdpaymentcredentialsOrderInformationBillTo.js → Tmsv2tokenizedcardsBillTo.js} +8 -8
  400. package/src/model/Tmsv2tokenizedcardstokenizedCardIddeleteReason.js +92 -0
  401. package/src/model/Tmsv3tokenstokenIdpaymentcredentialsOrderInformation.js +6 -6
  402. package/src/model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.js +1 -1
  403. package/src/model/TssV2TransactionsGet200ResponseSenderInformation.js +1 -1
  404. package/src/model/Ucv1sessionsData.js +32 -8
  405. package/src/model/Ucv1sessionsDataAggregatorInformation.js +153 -0
  406. package/src/model/Ucv1sessionsDataAggregatorInformationSubMerchant.js +172 -0
  407. package/src/model/Ucv1sessionsDataConsumerAuthenticationInformation.js +9 -0
  408. package/src/model/Ucv1sessionsDataInstallmentInformation.js +82 -0
  409. package/src/model/Ucv1sessionsDataMerchantInformation.js +9 -0
  410. package/src/model/Ucv1sessionsDataMerchantInformationMerchantDescriptor.js +9 -0
  411. package/src/model/Ucv1sessionsDataOrderInformation.js +16 -8
  412. package/src/model/Ucv1sessionsDataOrderInformationAmountDetails.js +44 -8
  413. package/src/model/Ucv1sessionsDataOrderInformationInvoiceDetails.js +108 -0
  414. package/src/model/Ucv1sessionsDataOrderInformationInvoiceDetailsTransactionAdviceAddendum.js +82 -0
  415. package/src/model/Ucv1sessionsDataOrderInformationLineItems.js +368 -0
  416. package/src/model/Ucv1sessionsDataOrderInformationShippingDetails.js +91 -0
  417. package/src/model/Ucv1sessionsDataProcessingInformation.js +29 -4
  418. package/src/model/Ucv1sessionsDataProcessingInformationBankTransferOptions.js +82 -0
  419. package/src/model/Ucv1sessionsDataProcessingInformationRecurringOptions.js +83 -0
  420. package/src/model/Ucv1sessionsDataRecipientInformation.js +55 -25
  421. package/src/model/Ucv1sessionsDataSenderInformation.js +180 -0
  422. package/src/model/Ucv1sessionsDataSenderInformationAccount.js +91 -0
  423. package/src/model/UpdatePayments.js +82 -0
  424. package/src/model/ValueAddedServicesProducts.js +16 -0
  425. package/docs/InlineResponse4007Details.md +0 -9
  426. package/docs/TokenApi.md +0 -169
  427. package/docs/TokenizedCardApi.md +0 -214
  428. package/src/api/TokenApi.js +0 -288
  429. package/src/api/TokenizedCardApi.js +0 -342
package/MLE.md CHANGED
@@ -11,6 +11,17 @@ MLE supports both **Request Encryption** (encrypting outgoing request payloads)
11
11
  - **Request MLE**: Only supported with `JWT (JSON Web Token)` authentication type
12
12
  - **Response MLE**: Only supported with `JWT (JSON Web Token)` authentication type
13
13
 
14
+ ### MLE with JWT Key Types
15
+
16
+ MLE works with both JWT key types:
17
+
18
+ | JWT Key Type | MLE Support | Request MLE Certificate Source |
19
+ |---|---|---|
20
+ | `P12` (default) | Supported | Auto-extracted from the P12 file (using `requestMleKeyAlias`), or from a separate file via `mleForRequestPublicCertPath` |
21
+ | `SHARED_SECRET` | Supported | **Must** be provided via `mleForRequestPublicCertPath` (since there is no P12 file to extract from) |
22
+
23
+ > **Important:** When using `jwtKeyType=SHARED_SECRET` with MLE, the `mleForRequestPublicCertPath` property is **required** for request MLE. The SDK cannot auto-extract the MLE certificate from a P12 file because shared secret authentication does not use one. The request MLE public certificate can be downloaded from the CyberSource Business Center ([Test](https://businesscentertest.cybersource.com/ebc2) | [Production](https://businesscenter.cybersource.com/ebc2)).
24
+
14
25
  <br/>
15
26
 
16
27
  ## Configuration
@@ -292,6 +303,58 @@ var merchantConfig = {
292
303
  };
293
304
  ```
294
305
 
306
+ ### (ix) Request MLE with Shared Secret (JWT Symmetric Key) Authentication
307
+
308
+ ```javascript
309
+ // MLE with JWT SHARED_SECRET authentication — requires mleForRequestPublicCertPath
310
+ var merchantConfig = {
311
+ // JWT authentication with SHARED_SECRET key type
312
+ authenticationType: 'jwt',
313
+ jwtKeyType: 'SHARED_SECRET',
314
+ merchantID: 'your_merchant_id',
315
+ runEnvironment: 'apitest.cybersource.com',
316
+ merchantKeyId: 'your_key_id',
317
+ merchantsecretKey: 'your_base64_encoded_shared_secret',
318
+
319
+ // Request MLE settings
320
+ enableRequestMLEForOptionalApisGlobally: true,
321
+ // mleForRequestPublicCertPath is REQUIRED for SHARED_SECRET since there is no P12 file
322
+ mleForRequestPublicCertPath: '/path/to/mle/public/cert.pem',
323
+ requestMleKeyAlias: 'CyberSource_SJC_US' // Optional, defaults to CyberSource_SJC_US
324
+ };
325
+ ```
326
+
327
+ > **Note:** When using `jwtKeyType=SHARED_SECRET`, the MLE certificate cannot be auto-extracted from a P12 file. You **must** provide the certificate via `mleForRequestPublicCertPath`. The request MLE public certificate can be downloaded from the CyberSource Business Center ([Test](https://businesscentertest.cybersource.com/ebc2) | [Production](https://businesscenter.cybersource.com/ebc2)).
328
+
329
+ ### (x) Response MLE with MetaKey
330
+
331
+ When using MetaKey (`useMetaKey: true`) with Response MLE, the response MLE private key and KID must belong to the **portfolio (parent account)**, not the transacting merchant.
332
+
333
+ ```javascript
334
+ // MetaKey + Response MLE — portfolio's response MLE key is required
335
+ var merchantConfig = {
336
+ // JWT authentication with MetaKey
337
+ authenticationType: 'jwt',
338
+ jwtKeyType: 'SHARED_SECRET',
339
+ merchantID: 'your_transacting_merchant_id',
340
+ merchantKeyId: 'your_metakey_portfolio_KeyId',
341
+ merchantsecretKey: 'your_metakey_portfolio_shared_secret_key',
342
+ portfolioID: 'your_portfolio_id',
343
+ useMetaKey: true,
344
+ runEnvironment: 'apitest.cybersource.com',
345
+
346
+ // Response MLE — use the portfolio's response MLE key, not the transacting merchant's
347
+ enableResponseMleGlobally: true,
348
+ responseMlePrivateKeyFilePath: '/path/to/portfolio/response/mle/private/key.p12',
349
+ responseMlePrivateKeyFilePassword: 'portfolio_private_key_password'
350
+ // responseMleKID is optional when using a CyberSource-generated P12 file (auto-fetched from P12)
351
+ // Required when using PEM files or responseMlePrivateKey object
352
+ // responseMleKID: 'your_portfolio_response_mle_kid'
353
+ };
354
+ ```
355
+
356
+ > **Important:** In MetaKey mode, the portfolio is the transaction submitter. The response is encrypted using the portfolio's MLE certificate, so the decryption key must also be the portfolio's.
357
+
295
358
  <br/>
296
359
 
297
360
  ## 5. Common Pitfalls
@@ -612,7 +675,8 @@ For Response MLE private key files, the following formats are supported:
612
675
  - If `enableRequestMLEForOptionalApisGlobally` is set to `true`, it enables request MLE for all APIs that have optional MLE support
613
676
  - APIs with mandatory MLE requirements are enabled by default unless `disableRequestMLEForMandatoryApisGlobally` is set to `true`
614
677
  - If `mapToControlMLEonAPI` doesn't contain a specific API, the global setting applies
615
- - For HTTP Signature authentication, request MLE will fall back to non-encrypted requests with a warning
678
+ - When using `jwtKeyType=SHARED_SECRET`, the `mleForRequestPublicCertPath` parameter is **required** because the SDK cannot auto-extract the MLE certificate from a P12 file. See [Example (ix)](#ix-request-mle-with-shared-secret-jwt-symmetric-key-authentication) for a complete configuration.
679
+ - For HTTP Signature authentication, request MLE will fall back to non-encrypted requests with a warning. **Note:** HTTP Signature is being deprecated — migrate to JWT with Shared Secret (`jwtKeyType=SHARED_SECRET`) to enable full MLE support using the same credentials. See [Example (ix)](#ix-request-mle-with-shared-secret-jwt-symmetric-key-authentication) for details.
616
680
 
617
681
  ### (ii) Response MLE
618
682
  - Response MLE requires either `responseMlePrivateKey` object OR `responseMlePrivateKeyFilePath` (not both)
@@ -622,6 +686,7 @@ For Response MLE private key files, the following formats are supported:
622
686
  - **Required** when using PEM format files (`.pem`, `.key`, `.p8`)
623
687
  - **Required** when using `responseMlePrivateKey` object directly
624
688
  - When both auto-fetched and user-provided values exist, the user-provided value takes precedence
689
+ - **MetaKey (`useMetaKey=true`):** When Response MLE is used with MetaKey, the `responseMlePrivateKeyFilePath` (or `responseMlePrivateKey` object) and `responseMleKID` must belong to the **portfolio (parent account)** — not the transacting merchant. This is because in MetaKey mode the portfolio is the transaction submitter, and the response is encrypted using the portfolio's MLE certificate.
625
690
  - If an API expects a mandatory MLE response but the map specifies non-MLE response, the API might return an error
626
691
  - Both the private key object and file path approaches are mutually exclusive
627
692
 
package/README.md CHANGED
@@ -25,6 +25,130 @@ Follow the first step mentioned in [Getting Started with CyberSource REST SDKs](
25
25
 
26
26
  Follow the second step mentioned in [Getting Started with CyberSource REST SDKs](https://developer.cybersource.com/hello-world/rest-api-sdks.html#gettingstarted) to configure the SDK by inputting your credentials.
27
27
 
28
+ > **⚠️ HTTP Signature Deprecation Notice:** HTTP Signature authentication is being deprecated. **JWT with Shared Secret** is the recommended migration path — it uses the same `merchantKeyId` and `merchantsecretKey` credentials, requires only two property changes, and enables MLE (Message Level Encryption) support that HTTP Signature does not provide.
29
+
30
+ ## Authentication Configuration
31
+
32
+ To set your API credentials for an API request, configure the following information in your configuration object:
33
+
34
+ ### For HTTP Signature authentication (⚠️ Deprecated — migrate to JWT with Shared Secret)
35
+
36
+ ```javascript
37
+ var merchantConfig = {
38
+ authenticationType: 'http_signature',
39
+ merchantID: 'testrest',
40
+ runEnvironment: 'apitest.cybersource.com',
41
+ merchantKeyId: 'your_merchant_key_id',
42
+ merchantsecretKey: 'your_merchant_secret_key',
43
+ enableLog: true,
44
+ logDirectory: './log',
45
+ logFilename: 'cybs'
46
+ };
47
+ ```
48
+
49
+ ### For JWT authentication (with P12 certificate)
50
+
51
+ ```javascript
52
+ var merchantConfig = {
53
+ authenticationType: 'jwt',
54
+ merchantID: 'testrest',
55
+ runEnvironment: 'apitest.cybersource.com',
56
+ keyAlias: 'testrest',
57
+ keyPass: 'testrest',
58
+ keyFileName: 'testrest',
59
+ keysDirectory: './resource',
60
+ enableLog: true,
61
+ logDirectory: './log',
62
+ logFilename: 'cybs'
63
+ };
64
+ ```
65
+
66
+ ### For JWT authentication with Shared Secret (Recommended migration from HTTP Signature)
67
+
68
+ Uses the **same** `merchantKeyId` and `merchantsecretKey` credentials as HTTP Signature. Only two properties change:
69
+
70
+ ```javascript
71
+ var merchantConfig = {
72
+ authenticationType: 'jwt',
73
+ jwtKeyType: 'SHARED_SECRET',
74
+ merchantID: 'testrest',
75
+ runEnvironment: 'apitest.cybersource.com',
76
+ merchantKeyId: 'your_merchant_key_id',
77
+ merchantsecretKey: 'your_merchant_secret_key',
78
+ enableLog: true,
79
+ logDirectory: './log',
80
+ logFilename: 'cybs'
81
+ };
82
+ ```
83
+
84
+ ### For using MetaKey
85
+
86
+ MetaKey can be used for HTTP Signature, JWT (P12), and JWT with Shared Secret authentication.
87
+
88
+ #### For HTTP Signature Authentication (⚠️ Deprecated)
89
+
90
+ ```javascript
91
+ var merchantConfig = {
92
+ authenticationType: 'http_signature',
93
+ merchantID: '<transacting merchantID>',
94
+ merchantKeyId: '<MetaKey Portfolio KeyId>',
95
+ merchantsecretKey: '<MetaKey Portfolio Shared Secret Key>',
96
+ useMetaKey: true,
97
+ portfolioID: '<Portfolio ID>'
98
+ };
99
+ ```
100
+
101
+ #### For JWT Authentication (P12)
102
+
103
+ ```javascript
104
+ var merchantConfig = {
105
+ authenticationType: 'jwt',
106
+ merchantID: '<transacting merchantID>',
107
+ keyAlias: '<Portfolio ID>',
108
+ keyPass: '<MetaKey Portfolio P12 File Password>',
109
+ keyFileName: '<MetaKey Portfolio P12 File Name>',
110
+ keysDirectory: '<keysDirectory>',
111
+ useMetaKey: true
112
+ };
113
+ ```
114
+
115
+ #### For JWT Authentication with Shared Secret (Recommended)
116
+
117
+ ```javascript
118
+ var merchantConfig = {
119
+ authenticationType: 'jwt',
120
+ jwtKeyType: 'SHARED_SECRET',
121
+ merchantID: '<transacting merchantID>',
122
+ merchantKeyId: '<MetaKey Portfolio KeyId>',
123
+ merchantsecretKey: '<MetaKey Portfolio Shared Secret Key>',
124
+ useMetaKey: true,
125
+ portfolioID: '<Portfolio ID>'
126
+ };
127
+ ```
128
+
129
+ #### Response MLE with MetaKey
130
+
131
+ When Response MLE is enabled (`enableResponseMleGlobally: true`) and MetaKey is in use (`useMetaKey: true`), the Response MLE configuration must use the **portfolio's** response MLE key — not the transacting merchant's. Specifically:
132
+
133
+ - `responseMlePrivateKeyFilePath` (or the `responseMlePrivateKey` object) must point to the **portfolio's** response MLE private key.
134
+ - `responseMleKID` — the KID value associated with the **portfolio's** response MLE certificate.
135
+ - **Optional** when `responseMlePrivateKeyFilePath` points to a CyberSource-generated P12 file (SDK auto-fetches from P12).
136
+ - **Required** when using PEM format files (`.pem`, `.key`, `.p8`) or when providing `responseMlePrivateKey` object directly.
137
+
138
+ ```javascript
139
+ var merchantConfig = {
140
+ // ... other MetaKey configuration ...
141
+ enableResponseMleGlobally: true,
142
+ responseMlePrivateKeyFilePath: '/path/to/portfolio/response/mle/private/key.p12',
143
+ responseMlePrivateKeyFilePassword: 'portfolio_private_key_password'
144
+ // responseMleKID is optional when using a CyberSource-generated P12 file (auto-fetched from P12)
145
+ // Required when using PEM files or responseMlePrivateKey object
146
+ // responseMleKID: '<Portfolio Response MLE KID>'
147
+ };
148
+ ```
149
+
150
+ > **Important:** The response MLE private key (and KID, if applicable) must belong to the portfolio (parent account), since in MetaKey mode the portfolio is the transaction submitter and the response is encrypted using the portfolio's MLE certificate.
151
+
28
152
  ## How to Use
29
153
 
30
154
  To get started using this SDK, it's highly recommended to download our sample code repository:
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  **clientReferenceInformation** | [**Bavsv1accountvalidationsClientReferenceInformation**](Bavsv1accountvalidationsClientReferenceInformation.md) | | [optional]
7
7
  **processingInformation** | [**Bavsv1accountvalidationsProcessingInformation**](Bavsv1accountvalidationsProcessingInformation.md) | |
8
8
  **paymentInformation** | [**Bavsv1accountvalidationsPaymentInformation**](Bavsv1accountvalidationsPaymentInformation.md) | |
9
+ **tokenInformation** | [**Bavsv1accountvalidationsTokenInformation**](Bavsv1accountvalidationsTokenInformation.md) | | [optional]
9
10
 
10
11
 
@@ -0,0 +1,15 @@
1
+ # CyberSource.Acpv1mppcredentialsChallenge
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Unique challenge identifier issued by the merchant server. |
7
+ **realm** | **String** | Merchant realm (typically the API domain). |
8
+ **amount** | **String** | Amount in the smallest currency unit (e.g., '4999' = $49.99). |
9
+ **currency** | **String** | Three-letter ISO 4217 currency code, lowercase (e.g., 'usd'). |
10
+ **acceptedNetworks** | **[String]** | Card networks accepted by the merchant (e.g., ['visa', 'mastercard']). |
11
+ **merchantId** | **String** | Merchant identifier (maps to 'recipient' in MPP spec request object). |
12
+ **merchantName** | **String** | Human-readable merchant name. |
13
+ **encryptionJwk** | [**Acpv1mppcredentialsChallengeEncryptionJwk**](Acpv1mppcredentialsChallengeEncryptionJwk.md) | |
14
+
15
+
@@ -0,0 +1,13 @@
1
+ # CyberSource.Acpv1mppcredentialsChallengeEncryptionJwk
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **kty** | **String** | Key type. MUST be 'RSA'. |
7
+ **kid** | **String** | Key ID. Identifies the key within a JWKS. |
8
+ **use** | **String** | Public key use. MUST be 'enc'. |
9
+ **alg** | **String** | Algorithm. MUST be 'RSA-OAEP-256'. |
10
+ **n** | **String** | RSA modulus (Base64urlUInt-encoded per RFC 7518 Section 6.3.1.1). |
11
+ **e** | **String** | RSA public exponent (Base64urlUInt-encoded per RFC 7518 Section 6.3.1.2). |
12
+
13
+
@@ -3,12 +3,12 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **verificationType** | **String** | Type of the verification data. Possible values: - `CARDHOLDER` (Default) - `DEVICE` | [optional]
7
- **verificationEntity** | **String** | Entity performing the verification. Possible value: - `10` - VISA (Default) | [optional]
8
- **verificationEvents** | **[String]** | Event where the verification occurred. Possible values: - `01` - Payment transaction - `02` - Add card/Card enrollment - `03` - Profile access - `04` - Account verification | [optional]
9
- **verificationMethod** | **String** | Method of the verification. Possible values: - `02` - App-based authentication - `04` - One-time passcode - `21` - Visa Token Service step-up: Device binding - `22` - Visa Token Service step-up: Cardholder verification - `23` - FIDO2 |
10
- **verificationResults** | **String** | Result of the verification. Possible values: - `01` - Verified - `02` - Not Verified - `03` - Not performed - `04` - Not required - `21` - Not allowed |
11
- **verificationTimestamp** | **String** | Date and time the verification occurred. UTC time in Unix epoch format. |
6
+ **verificationType** | **String** | Optional. Type of the verification data. Possible values: - `CARDHOLDER` (Default) - `DEVICE` | [optional]
7
+ **verificationEntity** | **String** | Optional. Entity performing the verification. Possible value: - `10` - VISA (Default) | [optional]
8
+ **verificationEvents** | **[String]** | Optional. Event where the verification occurred. Possible values: - `01` - Payment transaction - `02` - Add card/Card enrollment - `03` - Profile access - `04` - Account verification | [optional]
9
+ **verificationMethod** | **String** | Required. Method of the verification. Possible values: - `02` - App-based authentication - `04` - One-time passcode - `21` - Visa Token Service step-up: Device binding - `22` - Visa Token Service step-up: Cardholder verification - `23` - FIDO2 |
10
+ **verificationResults** | **String** | Required. Result of the verification. Possible values: - `01` - Verified - `02` - Not Verified - `03` - Not performed - `04` - Not required - `21` - Not allowed |
11
+ **verificationTimestamp** | **String** | Required. Date and time the verification occurred. UTC time in Unix epoch format. |
12
12
  **authenticationContext** | [**Acpv1tokensAuthenticationContext**](Acpv1tokensAuthenticationContext.md) | | [optional]
13
13
  **authenticatedIdentities** | [**Acpv1tokensAuthenticatedIdentities**](Acpv1tokensAuthenticatedIdentities.md) | | [optional]
14
14
  **additionalData** | **String** | Additional data related to assurance. | [optional]
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **orderInformation** | [**Ptsv2paymentsidreversalsOrderInformation**](Ptsv2paymentsidreversalsOrderInformation.md) | | [optional]
10
10
  **pointOfSaleInformation** | [**Ptsv2paymentsidreversalsPointOfSaleInformation**](Ptsv2paymentsidreversalsPointOfSaleInformation.md) | | [optional]
11
11
  **paymentInformation** | [**Ptsv2paymentsidreversalsPaymentInformation**](Ptsv2paymentsidreversalsPaymentInformation.md) | | [optional]
12
+ **deviceInformation** | [**Ptsv2paymentsidreversalsDeviceInformation**](Ptsv2paymentsidreversalsDeviceInformation.md) | | [optional]
12
13
  **processorInformation** | [**Ptsv2paymentsProcessorInformationReversal**](Ptsv2paymentsProcessorInformationReversal.md) | | [optional]
13
14
 
14
15
 
@@ -153,7 +153,7 @@ No authorization required
153
153
  ### HTTP request headers
154
154
 
155
155
  - **Content-Type**: application/json;charset=utf-8
156
- - **Accept**: application/json;charset=utf-8
156
+ - **Accept**: application/json, application/json;charset=utf-8
157
157
 
158
158
  <a name="postBatch"></a>
159
159
  # **postBatch**
@@ -3,6 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **bank** | [**Bavsv1accountvalidationsPaymentInformationBank**](Bavsv1accountvalidationsPaymentInformationBank.md) | |
6
+ **customer** | [**Bavsv1accountvalidationsPaymentInformationCustomer**](Bavsv1accountvalidationsPaymentInformationCustomer.md) | | [optional]
7
+ **paymentInstrument** | [**Bavsv1accountvalidationsPaymentInformationPaymentInstrument**](Bavsv1accountvalidationsPaymentInformationPaymentInstrument.md) | | [optional]
8
+ **instrumentIdentifier** | [**Bavsv1accountvalidationsPaymentInformationInstrumentIdentifier**](Bavsv1accountvalidationsPaymentInformationInstrumentIdentifier.md) | | [optional]
9
+ **bank** | [**Bavsv1accountvalidationsPaymentInformationBank**](Bavsv1accountvalidationsPaymentInformationBank.md) | | [optional]
7
10
 
8
11
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **routingNumber** | **String** | Bank routing number. This is also called the transit number. Non-Negative Integer |
6
+ **routingNumber** | **String** | Bank routing number. This is also called the transit number. Non-Negative String, containing only digits. |
7
7
  **account** | [**Bavsv1accountvalidationsPaymentInformationBankAccount**](Bavsv1accountvalidationsPaymentInformationBankAccount.md) | |
8
8
 
9
9
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **_number** | **String** | Account Number. Non-Negative Integer. example: 12345678901234577 |
6
+ **_number** | **String** | Account Number. Non-Negative String, containing only digits. |
7
7
 
8
8
 
@@ -0,0 +1,8 @@
1
+ # CyberSource.Bavsv1accountvalidationsPaymentInformationCustomer
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Unique identifier for the Customer token. When this value is included in your request, the bank object becomes optional. | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Bavsv1accountvalidationsPaymentInformationInstrumentIdentifier
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Unique identifier for the Instrument Identifier token. When this value is included in your request, the bank object becomes optional. | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Bavsv1accountvalidationsPaymentInformationPaymentInstrument
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Unique identifier for the Payment Instrument token. When this value is included in your request, the bank object becomes optional. | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # CyberSource.Bavsv1accountvalidationsTokenInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **jti** | **String** | TMS Transient Token for BAVS detokenization. A 64 hexadecimal character identifier representing captured payment credentials. | [optional]
7
+ **transientTokenJwt** | **String** | Flex API Transient Token encoded as JWT for BAVS detokenization. Contains encrypted bank account information from Flex microform or Unified Payment checkout. | [optional]
8
+
9
+
@@ -48,6 +48,10 @@ Name | Type | Description | Notes
48
48
  **enableLeastCostRouting** | **Boolean** | Indicates whether Least Cost Routing is enabled. Applicable for EFTPOS and CUP processors. | [optional]
49
49
  **enableCVVResponseIndicator** | **Boolean** | This field denotes EFTPOS Merchant's choice of receiving CVV Processing Response in return. Applicable for EFTPOS processors. | [optional]
50
50
  **enableMultiCurrencyProcessing** | **String** | Applicable for Barclays (barclays2) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>Yes</td></tr> </table> | [optional]
51
+ **transactionTypeIdentifier** | **String** | Transaction Type Identifier (TTI) field for Mastercard AFT transactions. Maps to ISO field F104.65.32. Used to ensure compliance with Mastercard's requirements for money send transactions when wallet classifications differ between Visa and Mastercard schemes. Takes priority over BAI values for Mastercard AFT transactions when present. | [optional]
52
+ **subMerchantId** | **String** | The Sub merchant ID, sometimes referred to as the 'Seller ID' is generally used and *required for Aggregators and OptBlue participants. The 'Sub Merchant' is the Merchant whose transactions are submitted by a payment aggregator. | [optional]
53
+ **subMerchantEmail** | **String** | Sub Merchant Email of the Payment Facilitator's, OptBlue Participant | [optional]
54
+ **subMerchantPhoneNumber** | **String** | Sub Merchant Phone Number of the Payment Facilitator's, OptBlue Participant's | [optional]
51
55
  **enablePosNetworkSwitching** | **Boolean** | 'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor. | [optional]
52
56
  **enableDynamicCurrencyConversion** | **Boolean** | Enable dynamic currency conversion for a merchant. | [optional]
53
57
  **merchantTier** | **String** | Merchant Tier defines the type of merchant, the numeric Merchant Tier value is allocated by EFTPOS. Applicable for EFTPOS processors. | [optional]
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  **tokenManagement** | [**CommerceSolutionsProductsTokenManagement**](CommerceSolutionsProductsTokenManagement.md) | | [optional]
7
7
  **accountUpdater** | [**CommerceSolutionsProductsAccountUpdater**](CommerceSolutionsProductsAccountUpdater.md) | | [optional]
8
8
  **binLookup** | [**CommerceSolutionsProductsBinLookup**](CommerceSolutionsProductsBinLookup.md) | | [optional]
9
+ **agenticCommerce** | [**PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional]
9
10
 
10
11
 
@@ -20,5 +20,6 @@ Name | Type | Description | Notes
20
20
  **senderInformation** | [**Ptsv2creditsSenderInformation**](Ptsv2creditsSenderInformation.md) | | [optional]
21
21
  **promotionInformation** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.md) | | [optional]
22
22
  **processorInformation** | [**Ptsv2reversalsProcessorInformation**](Ptsv2reversalsProcessorInformation.md) | | [optional]
23
+ **tokenInformation** | [**Ptsv2creditsTokenInformation**](Ptsv2creditsTokenInformation.md) | | [optional]
23
24
 
24
25
 
@@ -100,11 +100,11 @@ No authorization required
100
100
  ### HTTP request headers
101
101
 
102
102
  - **Content-Type**: application/json;charset=utf-8
103
- - **Accept**: application/hal+json;charset=utf-8
103
+ - **Accept**: application/json;charset=utf-8
104
104
 
105
105
  <a name="saveSymEgressKey"></a>
106
106
  # **saveSymEgressKey**
107
- > InlineResponse2015 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, opts)
107
+ > InlineResponse2015 saveSymEgressKey(opts)
108
108
 
109
109
  Create Webhook Security Keys
110
110
 
@@ -116,12 +116,10 @@ var CyberSource = require('CyberSource');
116
116
 
117
117
  var apiInstance = new CyberSource.CreateNewWebhooksApi();
118
118
 
119
- var vCSenderOrganizationId = "vCSenderOrganizationId_example"; // String | Sender organization id
120
-
121
- var vCPermissions = "vCPermissions_example"; // String | Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
122
-
123
119
  var opts = {
124
120
  'vCCorrelationId': "vCCorrelationId_example", // String | A globally unique id associated with your request
121
+ 'vCSenderOrganizationId': "vCSenderOrganizationId_example", // String | Sender organization id
122
+ 'vCPermissions': "vCPermissions_example", // String | Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
125
123
  'saveSymEgressKey': new CyberSource.SaveSymEgressKey() // SaveSymEgressKey | Provide egress Symmetric key information to save (create or store or refresh)
126
124
  };
127
125
 
@@ -132,16 +130,16 @@ var callback = function(error, data, response) {
132
130
  console.log('API called successfully. Returned data: ' + data);
133
131
  }
134
132
  };
135
- apiInstance.saveSymEgressKey(vCSenderOrganizationId, vCPermissions, opts, callback);
133
+ apiInstance.saveSymEgressKey(opts, callback);
136
134
  ```
137
135
 
138
136
  ### Parameters
139
137
 
140
138
  Name | Type | Description | Notes
141
139
  ------------- | ------------- | ------------- | -------------
142
- **vCSenderOrganizationId** | **String**| Sender organization id |
143
- **vCPermissions** | **String**| Encoded user permissions returned by the CGK, for the entity user who initiated the boarding |
144
140
  **vCCorrelationId** | **String**| A globally unique id associated with your request | [optional]
141
+ **vCSenderOrganizationId** | **String**| Sender organization id | [optional]
142
+ **vCPermissions** | **String**| Encoded user permissions returned by the CGK, for the entity user who initiated the boarding | [optional]
145
143
  **saveSymEgressKey** | [**SaveSymEgressKey**](SaveSymEgressKey.md)| Provide egress Symmetric key information to save (create or store or refresh) | [optional]
146
144
 
147
145
  ### Return type
@@ -0,0 +1,55 @@
1
+ # CyberSource.CredentialsApi
2
+
3
+ All URIs are relative to *https://apitest.cybersource.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**provisionMppCredentials**](CredentialsApi.md#provisionMppCredentials) | **POST** /acp/v1/mpp/credentials | Provision MPP credentials
8
+
9
+
10
+ <a name="provisionMppCredentials"></a>
11
+ # **provisionMppCredentials**
12
+ > MppCredentialsResponse200 provisionMppCredentials(mppCredentialsRequest)
13
+
14
+ Provision MPP credentials
15
+
16
+ Provisions an encrypted MPP credential for use as the credential payload in an Authorization: Payment header (MPP spec Section 8.2). The caller provides an instrument identifier (referencing a stored card in TMS) and the challenge context from the merchant's 402 response, including the merchant's RSA public encryption key. This service: 1. Calls TMS to retrieve the network token and cryptogram for the instrument. 2. Builds the token plaintext (MPP spec Section 8.3, type: network_token). 3. Encrypts the plaintext using RSA-OAEP with SHA-256 and the merchant's public key. 4. Returns the MPP credential payload fields (MPP spec Section 8.2, Table 4).
17
+
18
+ ### Example
19
+ ```javascript
20
+ var CyberSource = require('CyberSource');
21
+
22
+ var apiInstance = new CyberSource.CredentialsApi();
23
+
24
+ var mppCredentialsRequest = new CyberSource.MppCredentialsRequest(); // MppCredentialsRequest |
25
+
26
+
27
+ var callback = function(error, data, response) {
28
+ if (error) {
29
+ console.error(error);
30
+ } else {
31
+ console.log('API called successfully. Returned data: ' + data);
32
+ }
33
+ };
34
+ apiInstance.provisionMppCredentials(mppCredentialsRequest, callback);
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ Name | Type | Description | Notes
40
+ ------------- | ------------- | ------------- | -------------
41
+ **mppCredentialsRequest** | [**MppCredentialsRequest**](MppCredentialsRequest.md)| |
42
+
43
+ ### Return type
44
+
45
+ [**MppCredentialsResponse200**](MppCredentialsResponse200.md)
46
+
47
+ ### Authorization
48
+
49
+ No authorization required
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: application/json;charset=utf-8
54
+ - **Accept**: application/hal+json;charset=utf-8
55
+
@@ -119,7 +119,7 @@ No authorization required
119
119
 
120
120
  <a name="getCustomerPaymentInstrumentsList"></a>
121
121
  # **getCustomerPaymentInstrumentsList**
122
- > PaymentInstrumentList getCustomerPaymentInstrumentsList(customerId, opts)
122
+ > PaymentInstrumentList1 getCustomerPaymentInstrumentsList(customerId, opts)
123
123
 
124
124
  List Payment Instruments for a Customer
125
125
 
@@ -160,7 +160,7 @@ Name | Type | Description | Notes
160
160
 
161
161
  ### Return type
162
162
 
163
- [**PaymentInstrumentList**](PaymentInstrumentList.md)
163
+ [**PaymentInstrumentList1**](PaymentInstrumentList1.md)
164
164
 
165
165
  ### Authorization
166
166
 
@@ -13,7 +13,7 @@ Method | HTTP request | Description
13
13
 
14
14
  Enroll a card
15
15
 
16
- Enroll a card for tokenization during the customer's account registration or when the customer starts a new purchase intent.
16
+ Enroll a payment card for agentic or e-commerce transactions. This is typically the first step in the Intelligent Commerce payment lifecycle — the agent calls this endpoint to register a consumer's card, creating a tokenized reference that can be used in subsequent purchase instructions and payment credential retrieval. Requires device information, consumer identity, billing details, and payment instrument references. Returns a status of ACTIVE (HTTP 200) if enrollment completes immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. Call this endpoint when a consumer wants to add a new payment card or when setting up a card for agentic payment flows.
17
17
 
18
18
  ### Example
19
19
  ```javascript
@@ -4,5 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **amount** | **String** | Surcharge amount that you are charging the customer for this subscription. The surcharge amount will be added to the billing amount. The issuer can provide information about the surcharge amount to the customer. **NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8. | [optional]
7
+ **description** | **String** | Description of the surcharge. | [optional]
7
8
 
8
9
 
@@ -0,0 +1,13 @@
1
+ # CyberSource.GetSubscriptionsPaymentsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **links** | [**GetSubscriptionsPaymentsResponseLinks**](GetSubscriptionsPaymentsResponseLinks.md) | | [optional]
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
+ **totalCount** | **Number** | Total number of payments returned for the subscription, including both past payments and those specified in scheduledPaymentsCount. | [optional]
9
+ **cyclesCompletedCount** | [**GetSubscriptionsPaymentsResponseCyclesCompletedCount**](GetSubscriptionsPaymentsResponseCyclesCompletedCount.md) | | [optional]
10
+ **billingCyclesToSkip** | **[Number]** | A list of billing cycles that are marked to be skipped. | [optional]
11
+ **subscriptionPayment** | [**[GetSubscriptionsPaymentsResponseSubscriptionPayment]**](GetSubscriptionsPaymentsResponseSubscriptionPayment.md) | The list of subscription payment details. | [optional]
12
+
13
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.GetSubscriptionsPaymentsResponse1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **links** | [**GetSubscriptionsPaymentsResponse1Links**](GetSubscriptionsPaymentsResponse1Links.md) | | [optional]
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
+ **status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional]
9
+ **billingCyclesToSkip** | **[Number]** | A list of billing cycles that are marked to be skipped. | [optional]
10
+
11
+
@@ -1,4 +1,4 @@
1
- # CyberSource.PblPaymentLinksPost201ResponseLinks
1
+ # CyberSource.GetSubscriptionsPaymentsResponse1Links
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
@@ -0,0 +1,8 @@
1
+ # CyberSource.GetSubscriptionsPaymentsResponseCyclesCompletedCount
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **paid** | **Number** | The number of payment cycles that have status PAID. | [optional]
7
+
8
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.GetSubscriptionsPaymentsResponseLinks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **self** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional]
7
+ **next** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional]
8
+ **prev** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional]
9
+
10
+
@@ -0,0 +1,22 @@
1
+ # CyberSource.GetSubscriptionsPaymentsResponseSubscriptionPayment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Identifier assigned by Recurring Billing to uniquely reference this billing cycle's payment, distinct from the Cybersource transactionID. | [optional]
7
+ **status** | **String** | The current status of the payment. Possible values: - SCHEDULED - PAID - FAILED - SKIPPED - SCHEDULED_SKIPPED | [optional]
8
+ **paymentType** | **String** | The type of payment. Possible values: - STANDARD - RETRY | [optional]
9
+ **transactionID** | **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]
10
+ **_date** | **Date** | The date and time of the payment processing. | [optional]
11
+ **currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional]
12
+ **billingStartDate** | **Date** | The start date of the billing cycle for this payment. | [optional]
13
+ **billingEndDate** | **Date** | The end date of the billing cycle for this payment. | [optional]
14
+ **billingCycle** | **String** | The billing cycle number. | [optional]
15
+ **paymentNumber** | **String** | The sequential number of the payment in the subscription. | [optional]
16
+ **billingAmount** | **String** | The amount billed for this payment. | [optional]
17
+ **setupFee** | **String** | The setup fee associated with the payment. | [optional]
18
+ **surchargeAmount** | **String** | The surcharge amount, if any. | [optional]
19
+ **surchargeDescription** | **String** | The description for the surcharge. | [optional]
20
+ **modifiable** | **Boolean** | Indicates if the payment is modifiable, meaning it can be skipped or restored. | [optional]
21
+
22
+