From 34977908e438abdc174a3b287fae2ac2ce20afef Mon Sep 17 00:00:00 2001 From: "Goel, Aastvik" Date: Tue, 28 Oct 2025 13:00:23 +0530 Subject: [PATCH] updated spec and generated code for oct25 release --- docs/CapturePaymentRequest.md | 2 +- docs/GenerateCaptureContextRequest.md | 2 +- ...ateUnifiedCheckoutCaptureContextRequest.md | 7 +- docs/InlineResponse20014.md | 15 + ...Response20014ClientReferenceInformation.md | 14 + docs/InlineResponse2018.md | 16 + ...eResponse2018ClientReferenceInformation.md | 10 + docs/InlineResponse2018ErrorInformation.md | 11 + docs/InlineResponse2018OrderInformation.md | 10 + ...e2018OrderInformationCurrencyConversion.md | 13 + ...OrderInformationCurrencyConversionOffer.md | 20 + .../InlineResponse2018ProcessorInformation.md | 10 + docs/InlineResponse40010.md | 15 + docs/InlineResponse403Errors.md | 2 +- docs/InlineResponse5022.md | 14 + docs/MerchantDefinedFieldsApi.md | 64 +- docs/OfferRequest.md | 13 + docs/OffersApi.md | 120 + docs/PatchInstrumentIdentifierRequest.md | 2 + ...stInstrumentIdentifierEnrollmentRequest.md | 2 + docs/PostInstrumentIdentifierRequest.md | 2 + docs/PostIssuerLifeCycleSimulationRequest.md | 12 - docs/PostPaymentCredentialsRequest.md | 5 + ...ponseProcessorInformationMerchantAdvice.md | 4 +- ...fundPost201ResponseProcessorInformation.md | 1 + ...ponseProcessorInformationMerchantAdvice.md | 11 + ...outsPost201ResponseProcessorInformation.md | 1 + docs/Ptsv2paymentsProcessorInformation.md | 1 + ...paymentsidcapturesProcessingInformation.md | 1 + ...rocessingInformationJapanPaymentOptions.md | 17 + ...2paymentsidcapturesProcessorInformation.md | 11 + docs/Riskv1decisionsDeviceInformation.md | 1 + docs/TmsEmbeddedInstrumentIdentifier.md | 2 + ...trumentIdentifierPointOfSaleInformation.md | 10 + ...IdentifierPointOfSaleInformationEmvTags.md | 12 + docs/Tmsv2TokenizedCard.md | 2 +- docs/Tmsv2TokenizedCardCard.md | 5 + ...msv2TokenizedCardCardTermsAndConditions.md | 10 + docs/Tmsv2TokenizedCardMetadataIssuer.md | 9 +- ...rdIdissuerlifecycleeventsimulationsCard.md | 12 - ...issuerlifecycleeventsimulationsMetadata.md | 10 - ...ifecycleeventsimulationsMetadataCardArt.md | 10 - ...simulationsMetadataCardArtCombinedAsset.md | 10 - ...ymentcredentialsAuthenticatedIdentities.md | 13 + ...enIdpaymentcredentialsDeviceInformation.md | 20 + ...IdpaymentcredentialsMerchantInformation.md | 10 + ...lsMerchantInformationMerchantDescriptor.md | 11 + ...kenIdpaymentcredentialsOrderInformation.md | 11 + ...redentialsOrderInformationAmountDetails.md | 11 + ...aymentcredentialsOrderInformationBillTo.md | 17 + docs/TokenApi.md | 2 +- docs/TokenizedCardApi.md | 51 +- docs/TokenizedcardRequest.md | 2 +- docs/Upv1capturecontextsCompleteMandate.md | 1 + docs/Upv1capturecontextsCompleteMandateTms.md | 11 + docs/Upv1capturecontextsData.md | 17 + ...Upv1capturecontextsDataBuyerInformation.md | 12 + ...aBuyerInformationPersonalIdentification.md | 10 + ...econtextsDataClientReferenceInformation.md | 11 + ...tsDataClientReferenceInformationPartner.md | 11 + ...tsDataConsumerAuthenticationInformation.md | 11 + ...econtextsDataMerchantDefinedInformation.md | 11 + ...1capturecontextsDataMerchantInformation.md | 10 + ...taMerchantInformationMerchantDescriptor.md | 10 + ...Upv1capturecontextsDataOrderInformation.md | 13 + ...ntextsDataOrderInformationAmountDetails.md | 16 + ...aOrderInformationAmountDetailsSurcharge.md | 10 + ...turecontextsDataOrderInformationBillTo.md} | 4 +- ...textsDataOrderInformationBillToCompany.md} | 2 +- ...recontextsDataOrderInformationLineItems.md | 41 + ...sDataOrderInformationLineItemsPassenger.md | 17 + ...DataOrderInformationLineItemsTaxDetails.md | 16 + ...turecontextsDataOrderInformationShipTo.md} | 2 +- ...apturecontextsDataProcessingInformation.md | 11 + ...ocessingInformationAuthorizationOptions.md | 12 + ...nformationAuthorizationOptionsInitiator.md | 11 + ...nsInitiatorMerchantInitiatedTransaction.md | 10 + ...capturecontextsDataRecipientInformation.md | 16 + docs/Upv1capturecontextsOrderInformation.md | 4 +- ...ncyconversionClientReferenceInformation.md | 14 + ...ersionClientReferenceInformationPartner.md | 11 + ...Vasv1currencyconversionOrderInformation.md | 11 + ...conversionOrderInformationAmountDetails.md | 11 + ...rsionOrderInformationCurrencyConversion.md | 10 + ...sv1currencyconversionPaymentInformation.md | 10 + ...urrencyconversionPaymentInformationCard.md | 10 + ...urrencyconversionPointOfSaleInformation.md | 11 + generator/cybersource-rest-spec-java.json | 8751 ++++++++++++++--- generator/cybersource-rest-spec.json | 8751 ++++++++++++++--- .../java/Api/MerchantDefinedFieldsApi.java | 192 +- src/main/java/Api/OffersApi.java | 487 + src/main/java/Api/TokenApi.java | 6 +- src/main/java/Api/TokenizedCardApi.java | 172 +- src/main/java/Invokers/ApiClient.java | 2 +- .../java/Model/CapturePaymentRequest.java | 10 +- .../Model/GenerateCaptureContextRequest.java | 4 +- ...eUnifiedCheckoutCaptureContextRequest.java | 78 +- src/main/java/Model/InlineResponse20014.java | 212 + ...sponse20014ClientReferenceInformation.java | 187 + src/main/java/Model/InlineResponse2018.java | 236 + ...esponse2018ClientReferenceInformation.java | 94 + .../InlineResponse2018ErrorInformation.java | 117 + ...> InlineResponse2018OrderInformation.java} | 36 +- ...018OrderInformationCurrencyConversion.java | 174 + ...derInformationCurrencyConversionOffer.java | 324 + ...nlineResponse2018ProcessorInformation.java | 94 + src/main/java/Model/InlineResponse40010.java | 220 + .../java/Model/InlineResponse403Errors.java | 4 +- src/main/java/Model/InlineResponse5022.java | 186 + src/main/java/Model/OfferRequest.java | 167 + .../PatchInstrumentIdentifierRequest.java | 49 +- ...InstrumentIdentifierEnrollmentRequest.java | 49 +- .../PostInstrumentIdentifierRequest.java | 49 +- .../PostIssuerLifeCycleSimulationRequest.java | 143 - .../Model/PostPaymentCredentialsRequest.java | 137 +- ...nseProcessorInformationMerchantAdvice.java | 8 +- ...ndPost201ResponseProcessorInformation.java | 28 +- ...nseProcessorInformationMerchantAdvice.java | 117 + ...tsPost201ResponseProcessorInformation.java | 28 +- .../Ptsv2paymentsProcessorInformation.java | 27 +- ...ymentsidcapturesProcessingInformation.java | 28 +- ...cessingInformationJapanPaymentOptions.java | 255 + ...aymentsidcapturesProcessorInformation.java | 118 + .../Riskv1decisionsDeviceInformation.java | 25 +- .../TmsEmbeddedInstrumentIdentifier.java | 49 +- ...umentIdentifierPointOfSaleInformation.java | 102 + ...entifierPointOfSaleInformationEmvTags.java | 140 + src/main/java/Model/Tmsv2TokenizedCard.java | 4 +- .../java/Model/Tmsv2TokenizedCardCard.java | 85 +- ...v2TokenizedCardCardTermsAndConditions.java | 85 + .../Tmsv2TokenizedCardMetadataIssuer.java | 58 +- ...IdissuerlifecycleeventsimulationsCard.java | 140 - ...ecycleeventsimulationsMetadataCardArt.java | 95 - ...mulationsMetadataCardArtCombinedAsset.java | 94 - ...entcredentialsAuthenticatedIdentities.java | 163 + ...IdpaymentcredentialsDeviceInformation.java | 324 + ...paymentcredentialsMerchantInformation.java | 95 + ...MerchantInformationMerchantDescriptor.java | 117 + ...nIdpaymentcredentialsOrderInformation.java | 119 + ...dentialsOrderInformationAmountDetails.java | 117 + ...mentcredentialsOrderInformationBillTo.java | 255 + src/main/java/Model/TokenizedcardRequest.java | 4 +- .../Upv1capturecontextsCompleteMandate.java | 26 +- ...Upv1capturecontextsCompleteMandateTms.java | 128 + .../java/Model/Upv1capturecontextsData.java | 263 + ...v1capturecontextsDataBuyerInformation.java | 141 + ...uyerInformationPersonalIdentification.java | 94 + ...ontextsDataClientReferenceInformation.java | 118 + ...DataClientReferenceInformationPartner.java | 117 + ...DataConsumerAuthenticationInformation.java | 117 + ...ontextsDataMerchantDefinedInformation.java | 117 + ...apturecontextsDataMerchantInformation.java | 95 + ...MerchantInformationMerchantDescriptor.java | 94 + ...v1capturecontextsDataOrderInformation.java | 167 + ...extsDataOrderInformationAmountDetails.java | 233 + ...rderInformationAmountDetailsSurcharge.java | 94 + ...recontextsDataOrderInformationBillTo.java} | 92 +- ...xtsDataOrderInformationBillToCompany.java} | 52 +- ...contextsDataOrderInformationLineItems.java | 811 ++ ...ataOrderInformationLineItemsPassenger.java | 255 + ...taOrderInformationLineItemsTaxDetails.java | 232 + ...recontextsDataOrderInformationShipTo.java} | 56 +- ...turecontextsDataProcessingInformation.java | 118 + ...essingInformationAuthorizationOptions.java | 141 + ...ormationAuthorizationOptionsInitiator.java | 118 + ...InitiatorMerchantInitiatedTransaction.java | 94 + ...pturecontextsDataRecipientInformation.java | 232 + .../Upv1capturecontextsOrderInformation.java | 20 +- ...yconversionClientReferenceInformation.java | 187 + ...sionClientReferenceInformationPartner.java | 117 + ...sv1currencyconversionOrderInformation.java | 119 + ...nversionOrderInformationAmountDetails.java | 117 + ...ionOrderInformationCurrencyConversion.java | 94 + ...1currencyconversionPaymentInformation.java | 95 + ...rencyconversionPaymentInformationCard.java | 94 + ...rencyconversionPointOfSaleInformation.java | 117 + .../Api/MerchantDefinedFieldsApiTest.java | 18 +- src/test/java/Api/OffersApiTest.java | 81 + src/test/java/Api/TokenApiTest.java | 2 +- src/test/java/Api/TokenizedCardApiTest.java | 21 +- 180 files changed, 26204 insertions(+), 3551 deletions(-) create mode 100644 docs/InlineResponse20014.md create mode 100644 docs/InlineResponse20014ClientReferenceInformation.md create mode 100644 docs/InlineResponse2018.md create mode 100644 docs/InlineResponse2018ClientReferenceInformation.md create mode 100644 docs/InlineResponse2018ErrorInformation.md create mode 100644 docs/InlineResponse2018OrderInformation.md create mode 100644 docs/InlineResponse2018OrderInformationCurrencyConversion.md create mode 100644 docs/InlineResponse2018OrderInformationCurrencyConversionOffer.md create mode 100644 docs/InlineResponse2018ProcessorInformation.md create mode 100644 docs/InlineResponse40010.md create mode 100644 docs/InlineResponse5022.md create mode 100644 docs/OfferRequest.md create mode 100644 docs/OffersApi.md delete mode 100644 docs/PostIssuerLifeCycleSimulationRequest.md create mode 100644 docs/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md create mode 100644 docs/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.md create mode 100644 docs/Ptsv2paymentsidcapturesProcessorInformation.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.md create mode 100644 docs/Tmsv2TokenizedCardCardTermsAndConditions.md delete mode 100644 docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md delete mode 100644 docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md delete mode 100644 docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md delete mode 100644 docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.md create mode 100644 docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.md create mode 100644 docs/Upv1capturecontextsCompleteMandateTms.md create mode 100644 docs/Upv1capturecontextsData.md create mode 100644 docs/Upv1capturecontextsDataBuyerInformation.md create mode 100644 docs/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md create mode 100644 docs/Upv1capturecontextsDataClientReferenceInformation.md create mode 100644 docs/Upv1capturecontextsDataClientReferenceInformationPartner.md create mode 100644 docs/Upv1capturecontextsDataConsumerAuthenticationInformation.md create mode 100644 docs/Upv1capturecontextsDataMerchantDefinedInformation.md create mode 100644 docs/Upv1capturecontextsDataMerchantInformation.md create mode 100644 docs/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md create mode 100644 docs/Upv1capturecontextsDataOrderInformation.md create mode 100644 docs/Upv1capturecontextsDataOrderInformationAmountDetails.md create mode 100644 docs/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.md rename docs/{Upv1capturecontextsOrderInformationBillTo.md => Upv1capturecontextsDataOrderInformationBillTo.md} (92%) rename docs/{Upv1capturecontextsOrderInformationBillToCompany.md => Upv1capturecontextsDataOrderInformationBillToCompany.md} (96%) create mode 100644 docs/Upv1capturecontextsDataOrderInformationLineItems.md create mode 100644 docs/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md create mode 100644 docs/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md rename docs/{Upv1capturecontextsOrderInformationShipTo.md => Upv1capturecontextsDataOrderInformationShipTo.md} (96%) create mode 100644 docs/Upv1capturecontextsDataProcessingInformation.md create mode 100644 docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md create mode 100644 docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md create mode 100644 docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md create mode 100644 docs/Upv1capturecontextsDataRecipientInformation.md create mode 100644 docs/Vasv1currencyconversionClientReferenceInformation.md create mode 100644 docs/Vasv1currencyconversionClientReferenceInformationPartner.md create mode 100644 docs/Vasv1currencyconversionOrderInformation.md create mode 100644 docs/Vasv1currencyconversionOrderInformationAmountDetails.md create mode 100644 docs/Vasv1currencyconversionOrderInformationCurrencyConversion.md create mode 100644 docs/Vasv1currencyconversionPaymentInformation.md create mode 100644 docs/Vasv1currencyconversionPaymentInformationCard.md create mode 100644 docs/Vasv1currencyconversionPointOfSaleInformation.md create mode 100644 src/main/java/Api/OffersApi.java create mode 100644 src/main/java/Model/InlineResponse20014.java create mode 100644 src/main/java/Model/InlineResponse20014ClientReferenceInformation.java create mode 100644 src/main/java/Model/InlineResponse2018.java create mode 100644 src/main/java/Model/InlineResponse2018ClientReferenceInformation.java create mode 100644 src/main/java/Model/InlineResponse2018ErrorInformation.java rename src/main/java/Model/{Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.java => InlineResponse2018OrderInformation.java} (50%) create mode 100644 src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversion.java create mode 100644 src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversionOffer.java create mode 100644 src/main/java/Model/InlineResponse2018ProcessorInformation.java create mode 100644 src/main/java/Model/InlineResponse40010.java create mode 100644 src/main/java/Model/InlineResponse5022.java create mode 100644 src/main/java/Model/OfferRequest.java delete mode 100644 src/main/java/Model/PostIssuerLifeCycleSimulationRequest.java create mode 100644 src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.java create mode 100644 src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.java create mode 100644 src/main/java/Model/Ptsv2paymentsidcapturesProcessorInformation.java create mode 100644 src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.java create mode 100644 src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.java create mode 100644 src/main/java/Model/Tmsv2TokenizedCardCardTermsAndConditions.java delete mode 100644 src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.java delete mode 100644 src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.java delete mode 100644 src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.java create mode 100644 src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.java create mode 100644 src/main/java/Model/Upv1capturecontextsCompleteMandateTms.java create mode 100644 src/main/java/Model/Upv1capturecontextsData.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataBuyerInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataClientReferenceInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataClientReferenceInformationPartner.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataMerchantDefinedInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataMerchantInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetails.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.java rename src/main/java/Model/{Upv1capturecontextsOrderInformationBillTo.java => Upv1capturecontextsDataOrderInformationBillTo.java} (76%) rename src/main/java/Model/{Upv1capturecontextsOrderInformationBillToCompany.java => Upv1capturecontextsDataOrderInformationBillToCompany.java} (77%) create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItems.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.java rename src/main/java/Model/{Upv1capturecontextsOrderInformationShipTo.java => Upv1capturecontextsDataOrderInformationShipTo.java} (78%) create mode 100644 src/main/java/Model/Upv1capturecontextsDataProcessingInformation.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java create mode 100644 src/main/java/Model/Upv1capturecontextsDataRecipientInformation.java create mode 100644 src/main/java/Model/Vasv1currencyconversionClientReferenceInformation.java create mode 100644 src/main/java/Model/Vasv1currencyconversionClientReferenceInformationPartner.java create mode 100644 src/main/java/Model/Vasv1currencyconversionOrderInformation.java create mode 100644 src/main/java/Model/Vasv1currencyconversionOrderInformationAmountDetails.java create mode 100644 src/main/java/Model/Vasv1currencyconversionOrderInformationCurrencyConversion.java create mode 100644 src/main/java/Model/Vasv1currencyconversionPaymentInformation.java create mode 100644 src/main/java/Model/Vasv1currencyconversionPaymentInformationCard.java create mode 100644 src/main/java/Model/Vasv1currencyconversionPointOfSaleInformation.java create mode 100644 src/test/java/Api/OffersApiTest.java diff --git a/docs/CapturePaymentRequest.md b/docs/CapturePaymentRequest.md index a2aac09ec..005fb9e8a 100644 --- a/docs/CapturePaymentRequest.md +++ b/docs/CapturePaymentRequest.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **installmentInformation** | [**Ptsv2paymentsidcapturesInstallmentInformation**](Ptsv2paymentsidcapturesInstallmentInformation.md) | | [optional] **travelInformation** | [**Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional] **promotionInformation** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.md) | | [optional] -**processorInformation** | [**Ptsv2reversalsProcessorInformation**](Ptsv2reversalsProcessorInformation.md) | | [optional] +**processorInformation** | [**Ptsv2paymentsidcapturesProcessorInformation**](Ptsv2paymentsidcapturesProcessorInformation.md) | | [optional] diff --git a/docs/GenerateCaptureContextRequest.md b/docs/GenerateCaptureContextRequest.md index 417f62430..7fb9f4880 100644 --- a/docs/GenerateCaptureContextRequest.md +++ b/docs/GenerateCaptureContextRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional] **targetOrigins** | **List<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\" ]<br><br> You can supply up to nine origins within the targetOrigins field for nested iframes. If the list of origins exceeds five ensure that you: - Compare the list of origins in the v2/sessions targetOrigins field against the location.ancestorOrigins of the browser. - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Microform from loading and display a client-side error message. | [optional] -**allowedCardNetworks** | **List<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 - PAYPAK **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional] +**allowedCardNetworks** | **List<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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional] **allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional] **transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional] diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md index a94091480..361a99da5 100644 --- a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md +++ b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md @@ -6,14 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional] **targetOrigins** | **List<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] -**allowedCardNetworks** | **List<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 - PAYPAK | [optional] -**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout also supports the following Alternative Payments: - AFTERPAY<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.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional] +**allowedCardNetworks** | **List<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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP | [optional] +**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY<br><br> Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) 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.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional] **country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional] **locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional] **captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional] **completeMandate** | [**Upv1capturecontextsCompleteMandate**](Upv1capturecontextsCompleteMandate.md) | | [optional] -**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional] **transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional] +**data** | [**Upv1capturecontextsData**](Upv1capturecontextsData.md) | | [optional] +**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional] diff --git a/docs/InlineResponse20014.md b/docs/InlineResponse20014.md new file mode 100644 index 000000000..f9042e65e --- /dev/null +++ b/docs/InlineResponse20014.md @@ -0,0 +1,15 @@ + +# InlineResponse20014 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**InlineResponse20014ClientReferenceInformation**](InlineResponse20014ClientReferenceInformation.md) | | [optional] +**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | +**status** | **String** | Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` | +**errorInformation** | [**InlineResponse2018ErrorInformation**](InlineResponse2018ErrorInformation.md) | | [optional] +**orderInformation** | [**InlineResponse2018OrderInformation**](InlineResponse2018OrderInformation.md) | | [optional] + + + diff --git a/docs/InlineResponse20014ClientReferenceInformation.md b/docs/InlineResponse20014ClientReferenceInformation.md new file mode 100644 index 000000000..2b5717a76 --- /dev/null +++ b/docs/InlineResponse20014ClientReferenceInformation.md @@ -0,0 +1,14 @@ + +# InlineResponse20014ClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] +**applicationName** | **String** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] +**applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction. | [optional] +**applicationUser** | **String** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional] +**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] + + + diff --git a/docs/InlineResponse2018.md b/docs/InlineResponse2018.md new file mode 100644 index 000000000..22c8beddd --- /dev/null +++ b/docs/InlineResponse2018.md @@ -0,0 +1,16 @@ + +# InlineResponse2018 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**InlineResponse2018ClientReferenceInformation**](InlineResponse2018ClientReferenceInformation.md) | | [optional] +**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | +**status** | **String** | Message describing the status of the currency conversion request. Possible values: - PENDING - DECLINED - SERVER_ERROR | +**errorInformation** | [**InlineResponse2018ErrorInformation**](InlineResponse2018ErrorInformation.md) | | [optional] +**orderInformation** | [**InlineResponse2018OrderInformation**](InlineResponse2018OrderInformation.md) | | [optional] +**processorInformation** | [**InlineResponse2018ProcessorInformation**](InlineResponse2018ProcessorInformation.md) | | [optional] + + + diff --git a/docs/InlineResponse2018ClientReferenceInformation.md b/docs/InlineResponse2018ClientReferenceInformation.md new file mode 100644 index 000000000..c3f1cedc9 --- /dev/null +++ b/docs/InlineResponse2018ClientReferenceInformation.md @@ -0,0 +1,10 @@ + +# InlineResponse2018ClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] + + + diff --git a/docs/InlineResponse2018ErrorInformation.md b/docs/InlineResponse2018ErrorInformation.md new file mode 100644 index 000000000..44eefc9fa --- /dev/null +++ b/docs/InlineResponse2018ErrorInformation.md @@ -0,0 +1,11 @@ + +# InlineResponse2018ErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **String** | Only required when offer cannot be made. The reason of the status. Possible values: - 'INVALID_MERCHANT_CONFIGURATION' - 'NOT_ELIGIBLE' - 'CURRENCY_NOT_CONFIGURED' - 'BIN_UNKNOWN' - 'CURRENCY_MATCH' - 'CURRENCY_NOT_ALLOWED' - 'LOOKUP_FAILED' - 'EXCHANGE_RATE_NOT_FOUND' - 'CARD_TYPE_NOT_ACCEPTED' - 'INVALID_AMOUNT' - 'INVALID_CARD' - 'INVALID_CURRENCY' - 'INVALID_TERMINAL' - 'INVALID_ACQUIRER' - 'SERVICE_DISABLED' - 'DUPLICATE_REQUEST' - 'UNKNOWN' - 'PROCESSOR_ERROR' | [optional] +**message** | **String** | Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered. | [optional] + + + diff --git a/docs/InlineResponse2018OrderInformation.md b/docs/InlineResponse2018OrderInformation.md new file mode 100644 index 000000000..006288992 --- /dev/null +++ b/docs/InlineResponse2018OrderInformation.md @@ -0,0 +1,10 @@ + +# InlineResponse2018OrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currencyConversion** | [**InlineResponse2018OrderInformationCurrencyConversion**](InlineResponse2018OrderInformationCurrencyConversion.md) | | [optional] + + + diff --git a/docs/InlineResponse2018OrderInformationCurrencyConversion.md b/docs/InlineResponse2018OrderInformationCurrencyConversion.md new file mode 100644 index 000000000..9e84f7e84 --- /dev/null +++ b/docs/InlineResponse2018OrderInformationCurrencyConversion.md @@ -0,0 +1,13 @@ + +# InlineResponse2018OrderInformationCurrencyConversion + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing This should be echo'd from the request | [optional] +**reconciliationId** | **String** | Unique identifier generated by the DCC provider. | +**offer** | [**List<InlineResponse2018OrderInformationCurrencyConversionOffer>**](InlineResponse2018OrderInformationCurrencyConversionOffer.md) | When type is DCC this is a single item. When type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant. | [optional] +**disclaimer** | **String** | This text is intended to inform customers about their opt-in choices. It should include details such as the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as the mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency Conversion) and optional otherwise. This information will be displayed on the screen and printed on the receipt without modification. | [optional] + + + diff --git a/docs/InlineResponse2018OrderInformationCurrencyConversionOffer.md b/docs/InlineResponse2018OrderInformationCurrencyConversionOffer.md new file mode 100644 index 000000000..73c467467 --- /dev/null +++ b/docs/InlineResponse2018OrderInformationCurrencyConversionOffer.md @@ -0,0 +1,20 @@ + +# InlineResponse2018OrderInformationCurrencyConversionOffer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**originalAmount** | **String** | The amount of the sale in the merchant's currency. For DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency. | [optional] +**originalCurrency** | **String** | Currency of the transaction in the merchant's currency. For DCC this should be the same value as the request. For MCP will be the merchant's base currency as configured on the currency conversion provider's system. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) | [optional] +**amount** | **String** | The offer amount, calculated using the originalAmount and the exchangeRate. For DCC this is the amount in the card issuer's currency. | [optional] +**currency** | **String** | Currency of the offer. For DCC this is the card's issuers currency. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) | [optional] +**exchangeRate** | **String** | The exchange rate of the offer from 1 major unit of the sale currency including margin. This will be printed on the receipt. For example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up. The receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field. | [optional] +**exchangeRateInverted** | **Boolean** | An inverted exchange rate is the base currency amount divided by the converted currency amount. Ex. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR. | [optional] +**marginRate** | **String** | The margin between the offer exchange rate and wholesale rates, i.e. the mark up. Expressed as a percentage of 100, e.g. 3.75 | [optional] +**rateSource** | **String** | The source of the rate (excluding mark up). Optional field. | [optional] +**exchangeRateTimeUtc** | **String** | The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**exchangeRateExpirationTimeUtc** | **String** | The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` | [optional] +**rateId** | **String** | A unique MCP rate identifier. | [optional] + + + diff --git a/docs/InlineResponse2018ProcessorInformation.md b/docs/InlineResponse2018ProcessorInformation.md new file mode 100644 index 000000000..85194946e --- /dev/null +++ b/docs/InlineResponse2018ProcessorInformation.md @@ -0,0 +1,10 @@ + +# InlineResponse2018ProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**responseCode** | **String** | The error message sent directly from the currency conversion provider. Returned only when the provider returns this value. | [optional] + + + diff --git a/docs/InlineResponse40010.md b/docs/InlineResponse40010.md new file mode 100644 index 000000000..630a4ca57 --- /dev/null +++ b/docs/InlineResponse40010.md @@ -0,0 +1,15 @@ + +# InlineResponse40010 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | +**status** | **String** | Message describing the status of the currency conversion request. Possible values: - INVALID_REQUEST | +**reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA | [optional] +**message** | **String** | Descriptive message to add more detail to the status | [optional] +**details** | [**List<PushFunds400ResponseDetails>**](PushFunds400ResponseDetails.md) | | [optional] + + + diff --git a/docs/InlineResponse403Errors.md b/docs/InlineResponse403Errors.md index a7ecea795..b67baa6c2 100644 --- a/docs/InlineResponse403Errors.md +++ b/docs/InlineResponse403Errors.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | The type of error. Possible Values: - forbidden | [optional] +**type** | **String** | The type of error. Possible Values: - forbidden - declined | [optional] **message** | **String** | The detailed message related to the type. | [optional] diff --git a/docs/InlineResponse5022.md b/docs/InlineResponse5022.md new file mode 100644 index 000000000..5e85e434c --- /dev/null +++ b/docs/InlineResponse5022.md @@ -0,0 +1,14 @@ + +# InlineResponse5022 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**status** | **String** | Message describing the status of the currency conversion request. Possible values: - SERVER_ERROR | +**reason** | **String** | Only required when offer cannot be made. The reason of the status. Only required when the requested action cannot be performed cannot be made. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT | [optional] +**message** | **String** | The detail message related to the status and reason listed above. | [optional] + + + diff --git a/docs/MerchantDefinedFieldsApi.md b/docs/MerchantDefinedFieldsApi.md index 448684333..60fb92a0b 100644 --- a/docs/MerchantDefinedFieldsApi.md +++ b/docs/MerchantDefinedFieldsApi.md @@ -5,9 +5,9 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**createMerchantDefinedFieldDefinition**](MerchantDefinedFieldsApi.md#createMerchantDefinedFieldDefinition) | **POST** /invoicing/v2/{referenceType}/merchantDefinedFields | Create merchant defined field for a given reference type +[**deleteMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#deleteMerchantDefinedFieldsDefinitions) | **DELETE** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Delete a MerchantDefinedField by ID [**getMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#getMerchantDefinedFieldsDefinitions) | **GET** /invoicing/v2/{referenceType}/merchantDefinedFields | Get all merchant defined fields for a given reference type -[**invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete**](MerchantDefinedFieldsApi.md#invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete) | **DELETE** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Delete a MerchantDefinedField by ID -[**invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut**](MerchantDefinedFieldsApi.md#invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut) | **PUT** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Update a MerchantDefinedField by ID +[**putMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#putMerchantDefinedFieldsDefinitions) | **PUT** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Update a MerchantDefinedField by ID @@ -55,11 +55,11 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - -# **getMerchantDefinedFieldsDefinitions** -> List<InlineResponse2002> getMerchantDefinedFieldsDefinitions(referenceType) + +# **deleteMerchantDefinedFieldsDefinitions** +> deleteMerchantDefinedFieldsDefinitions(referenceType, id) -Get all merchant defined fields for a given reference type +Delete a MerchantDefinedField by ID ### Example ```java @@ -69,12 +69,12 @@ Get all merchant defined fields for a given reference type MerchantDefinedFieldsApi apiInstance = new MerchantDefinedFieldsApi(); -String referenceType = "referenceType_example"; // String | The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation +String referenceType = "referenceType_example"; // String | +Long id = 789L; // Long | try { - List result = apiInstance.getMerchantDefinedFieldsDefinitions(referenceType); - System.out.println(result); + apiInstance.deleteMerchantDefinedFieldsDefinitions(referenceType, id); } catch (ApiException e) { - System.err.println("Exception when calling MerchantDefinedFieldsApi#getMerchantDefinedFieldsDefinitions"); + System.err.println("Exception when calling MerchantDefinedFieldsApi#deleteMerchantDefinedFieldsDefinitions"); e.printStackTrace(); } ``` @@ -83,11 +83,12 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **referenceType** | **String**| The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation | [enum: Invoice, Purchase, Donation] + **referenceType** | **String**| | [enum: Invoice, Purchase, Donation] + **id** | **Long**| | ### Return type -[**List<InlineResponse2002>**](InlineResponse2002.md) +null (empty response body) ### Authorization @@ -95,14 +96,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 - -# **invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete** -> invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(referenceType, id) + +# **getMerchantDefinedFieldsDefinitions** +> List<InlineResponse2002> getMerchantDefinedFieldsDefinitions(referenceType) -Delete a MerchantDefinedField by ID +Get all merchant defined fields for a given reference type ### Example ```java @@ -112,12 +113,12 @@ Delete a MerchantDefinedField by ID MerchantDefinedFieldsApi apiInstance = new MerchantDefinedFieldsApi(); -String referenceType = "referenceType_example"; // String | -Long id = 789L; // Long | +String referenceType = "referenceType_example"; // String | The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation try { - apiInstance.invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(referenceType, id); + List result = apiInstance.getMerchantDefinedFieldsDefinitions(referenceType); + System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MerchantDefinedFieldsApi#invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete"); + System.err.println("Exception when calling MerchantDefinedFieldsApi#getMerchantDefinedFieldsDefinitions"); e.printStackTrace(); } ``` @@ -126,12 +127,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **referenceType** | **String**| | [enum: Invoice, Purchase, Donation] - **id** | **Long**| | + **referenceType** | **String**| The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation | [enum: Invoice, Purchase, Donation] ### Return type -null (empty response body) +[**List<InlineResponse2002>**](InlineResponse2002.md) ### Authorization @@ -139,12 +139,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 + - **Content-Type**: application/json + - **Accept**: application/json - -# **invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut** -> List<InlineResponse2002> invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(referenceType, id, merchantDefinedFieldCore) + +# **putMerchantDefinedFieldsDefinitions** +> List<InlineResponse2002> putMerchantDefinedFieldsDefinitions(referenceType, id, merchantDefinedFieldCore) Update a MerchantDefinedField by ID @@ -160,10 +160,10 @@ String referenceType = "referenceType_example"; // String | Long id = 789L; // Long | MerchantDefinedFieldCore merchantDefinedFieldCore = new MerchantDefinedFieldCore(); // MerchantDefinedFieldCore | try { - List result = apiInstance.invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(referenceType, id, merchantDefinedFieldCore); + List result = apiInstance.putMerchantDefinedFieldsDefinitions(referenceType, id, merchantDefinedFieldCore); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MerchantDefinedFieldsApi#invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut"); + System.err.println("Exception when calling MerchantDefinedFieldsApi#putMerchantDefinedFieldsDefinitions"); e.printStackTrace(); } ``` diff --git a/docs/OfferRequest.md b/docs/OfferRequest.md new file mode 100644 index 000000000..c8e59a3d2 --- /dev/null +++ b/docs/OfferRequest.md @@ -0,0 +1,13 @@ + +# OfferRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**Vasv1currencyconversionClientReferenceInformation**](Vasv1currencyconversionClientReferenceInformation.md) | | [optional] +**paymentInformation** | [**Vasv1currencyconversionPaymentInformation**](Vasv1currencyconversionPaymentInformation.md) | | [optional] +**orderInformation** | [**Vasv1currencyconversionOrderInformation**](Vasv1currencyconversionOrderInformation.md) | | [optional] +**pointOfSaleInformation** | [**Vasv1currencyconversionPointOfSaleInformation**](Vasv1currencyconversionPointOfSaleInformation.md) | | [optional] + + + diff --git a/docs/OffersApi.md b/docs/OffersApi.md new file mode 100644 index 000000000..36bf68f79 --- /dev/null +++ b/docs/OffersApi.md @@ -0,0 +1,120 @@ +# OffersApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createOffer**](OffersApi.md#createOffer) | **POST** /vas/v1/currencyconversion | Create an Offer +[**getOffer**](OffersApi.md#getOffer) | **GET** /vas/v1/currencyconversion/{id} | Retrieve an Offer + + + +# **createOffer** +> InlineResponse2018 createOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest) + +Create an Offer + +Creates an offer record on the provider system. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.OffersApi; + + +OffersApi apiInstance = new OffersApi(); +String contentType = "contentType_example"; // String | +String xRequestid = "xRequestid_example"; // String | +String vCMerchantId = "vCMerchantId_example"; // String | +String vCCorrelationId = "vCCorrelationId_example"; // String | +String vCOrganizationId = "vCOrganizationId_example"; // String | +OfferRequest offerRequest = new OfferRequest(); // OfferRequest | +try { + InlineResponse2018 result = apiInstance.createOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling OffersApi#createOffer"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contentType** | **String**| | + **xRequestid** | **String**| | + **vCMerchantId** | **String**| | + **vCCorrelationId** | **String**| | + **vCOrganizationId** | **String**| | + **offerRequest** | [**OfferRequest**](OfferRequest.md)| | + +### Return type + +[**InlineResponse2018**](InlineResponse2018.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + + +# **getOffer** +> InlineResponse20014 getOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id) + +Retrieve an Offer + +Retrieves an offer record from the system. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.OffersApi; + + +OffersApi apiInstance = new OffersApi(); +String contentType = "contentType_example"; // String | +String xRequestid = "xRequestid_example"; // String | +String vCMerchantId = "vCMerchantId_example"; // String | +String vCCorrelationId = "vCCorrelationId_example"; // String | +String vCOrganizationId = "vCOrganizationId_example"; // String | +String id = "id_example"; // String | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id +try { + InlineResponse20014 result = apiInstance.getOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling OffersApi#getOffer"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contentType** | **String**| | + **xRequestid** | **String**| | + **vCMerchantId** | **String**| | + **vCCorrelationId** | **String**| | + **vCOrganizationId** | **String**| | + **id** | **String**| Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id | + +### Return type + +[**InlineResponse20014**](InlineResponse20014.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + diff --git a/docs/PatchInstrumentIdentifierRequest.md b/docs/PatchInstrumentIdentifierRequest.md index e0cee8e46..608d2f4ee 100644 --- a/docs/PatchInstrumentIdentifierRequest.md +++ b/docs/PatchInstrumentIdentifierRequest.md @@ -9,8 +9,10 @@ Name | Type | Description | Notes **object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**source** | **String** | Source of the card details. Possible Values: - CONTACTLESS_TAP | [optional] **tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] +**pointOfSaleInformation** | [**TmsEmbeddedInstrumentIdentifierPointOfSaleInformation**](TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] **issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] diff --git a/docs/PostInstrumentIdentifierEnrollmentRequest.md b/docs/PostInstrumentIdentifierEnrollmentRequest.md index 6fcbdaf23..5a203dec0 100644 --- a/docs/PostInstrumentIdentifierEnrollmentRequest.md +++ b/docs/PostInstrumentIdentifierEnrollmentRequest.md @@ -9,8 +9,10 @@ Name | Type | Description | Notes **object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**source** | **String** | Source of the card details. Possible Values: - CONTACTLESS_TAP | [optional] **tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] +**pointOfSaleInformation** | [**TmsEmbeddedInstrumentIdentifierPointOfSaleInformation**](TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] **issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] diff --git a/docs/PostInstrumentIdentifierRequest.md b/docs/PostInstrumentIdentifierRequest.md index 6c920f7ab..13dc4e78c 100644 --- a/docs/PostInstrumentIdentifierRequest.md +++ b/docs/PostInstrumentIdentifierRequest.md @@ -9,8 +9,10 @@ Name | Type | Description | Notes **object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**source** | **String** | Source of the card details. Possible Values: - CONTACTLESS_TAP | [optional] **tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] +**pointOfSaleInformation** | [**TmsEmbeddedInstrumentIdentifierPointOfSaleInformation**](TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] **issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] diff --git a/docs/PostIssuerLifeCycleSimulationRequest.md b/docs/PostIssuerLifeCycleSimulationRequest.md deleted file mode 100644 index 549f4daee..000000000 --- a/docs/PostIssuerLifeCycleSimulationRequest.md +++ /dev/null @@ -1,12 +0,0 @@ - -# PostIssuerLifeCycleSimulationRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**state** | **String** | The new state of the Tokenized Card. Possible Values: - ACTIVE - SUSPENDED - DELETED | [optional] -**card** | [**Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md) | | [optional] -**metadata** | [**Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md) | | [optional] - - - diff --git a/docs/PostPaymentCredentialsRequest.md b/docs/PostPaymentCredentialsRequest.md index e617ae7f4..a63969168 100644 --- a/docs/PostPaymentCredentialsRequest.md +++ b/docs/PostPaymentCredentialsRequest.md @@ -6,6 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] **transactionType** | **String** | Specifies the type of transaction for which the network token credentials are required. Possible Values: - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default. - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM. | [optional] +**clientCorrelationId** | **String** | Used to correlate authentication and payment credential requests. | [optional] +**orderInformation** | [**Tmsv2tokenstokenIdpaymentcredentialsOrderInformation**](Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.md) | | [optional] +**merchantInformation** | [**Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation**](Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.md) | | [optional] +**deviceInformation** | [**Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation**](Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.md) | | [optional] +**authenticatedIdentities** | [**List<Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities>**](Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md index c7dd06bd6..4e7b9a5d3 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | | [optional] -**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code | [optional] +**code** | **String** | - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company | [optional] +**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme | [optional] **nameMatch** | **String** | #### Visa Platform Connect The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are: 00 = Name Match Performed 01 = Name Match not Performed 02 = Name Match not supported | [optional] diff --git a/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md index 1a0f4ff70..c0c72ea65 100644 --- a/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **settlementDate** | **String** | Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day. | [optional] **updateTimeUtc** | **String** | The date and time when the transaction was last updated, in Internet date and time format. | [optional] **network** | [**Ptsv2paymentsProcessorInformationReversalNetwork**](Ptsv2paymentsProcessorInformationReversalNetwork.md) | | [optional] +**merchantAdvice** | [**PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice**](PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md) | | [optional] diff --git a/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md b/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md new file mode 100644 index 000000000..7d35e0c49 --- /dev/null +++ b/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md @@ -0,0 +1,11 @@ + +# PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company | [optional] +**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme | [optional] + + + diff --git a/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md b/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md index 31d8c68e6..577f61b48 100644 --- a/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **transactionId** | **String** | Network transaction identifier (TID). This value can be used to identify a specific transaction when you are discussing the transaction with your processor. | [optional] **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] **responseCodeSource** | **String** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] +**merchantAdvice** | [**PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice**](PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessorInformation.md b/docs/Ptsv2paymentsProcessorInformation.md index 1e87b03c9..61a59fa2e 100644 --- a/docs/Ptsv2paymentsProcessorInformation.md +++ b/docs/Ptsv2paymentsProcessorInformation.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **authorizationOptions** | [**Ptsv2paymentsProcessorInformationAuthorizationOptions**](Ptsv2paymentsProcessorInformationAuthorizationOptions.md) | | [optional] **reversal** | [**Ptsv2paymentsProcessorInformationReversal**](Ptsv2paymentsProcessorInformationReversal.md) | | [optional] **network** | [**Ptsv2paymentsProcessorInformationReversalNetwork**](Ptsv2paymentsProcessorInformationReversalNetwork.md) | | [optional] +**responseSourceCode** | **String** | Field contains the response source code that identifies the source. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformation.md b/docs/Ptsv2paymentsidcapturesProcessingInformation.md index 5eb9a860c..c3c4de442 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformation.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformation.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **loanOptions** | [**Ptsv2paymentsProcessingInformationLoanOptions**](Ptsv2paymentsProcessingInformationLoanOptions.md) | | [optional] **payByPointsIndicator** | **Boolean** | Flag that indicates if the transaction is pay by points transaction true: Transaction uses loyalty points false: Transaction does not use loyalty points Default: false | [optional] **actionList** | **List<String>** | Array of actions (one or more) to be included in the capture to invoke bundled services along with capture. Possible values : - `AP_CAPTURE`: Use this when Alternative Payment Capture service is requested. | [optional] +**japanPaymentOptions** | [**Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions**](Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.md b/docs/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.md new file mode 100644 index 000000000..c9967a79b --- /dev/null +++ b/docs/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.md @@ -0,0 +1,17 @@ + +# Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paymentMethod** | **String** | This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) | [optional] +**bonuses** | **String** | Field contains the number of bonuses. | [optional] +**installments** | **String** | Number of Installments. | [optional] +**firstBillingMonth** | **String** | Billing month in MM format. | [optional] +**bonusAmount** | **String** | This field contains the bonus amount. | [optional] +**bonusMonth** | **String** | This field contains the Japan specific first bonus month. | [optional] +**secondBonusAmount** | **String** | Field contains the second bonus amount. | [optional] +**secondBonusMonth** | **String** | Field contains the Japan specific second bonus month. | [optional] + + + diff --git a/docs/Ptsv2paymentsidcapturesProcessorInformation.md b/docs/Ptsv2paymentsidcapturesProcessorInformation.md new file mode 100644 index 000000000..d4ac7d7df --- /dev/null +++ b/docs/Ptsv2paymentsidcapturesProcessorInformation.md @@ -0,0 +1,11 @@ + +# Ptsv2paymentsidcapturesProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**network** | [**Ptsv2paymentsProcessorInformationReversalNetwork**](Ptsv2paymentsProcessorInformationReversalNetwork.md) | | [optional] +**responseSourceCode** | **String** | Field contains the response source code that identifies the source. | [optional] + + + diff --git a/docs/Riskv1decisionsDeviceInformation.md b/docs/Riskv1decisionsDeviceInformation.md index cda2ec97d..317244684 100644 --- a/docs/Riskv1decisionsDeviceInformation.md +++ b/docs/Riskv1decisionsDeviceInformation.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **ipAddress** | **String** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] **hostName** | **String** | DNS resolved hostname from `ipAddress`. | [optional] **fingerprintSessionId** | **String** | Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual's web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. | [optional] +**useRawFingerprintSessionId** | **Boolean** | Boolean that indicates whether request contains the device fingerprint information. Values: - `true`: Use raw fingerprintSessionId when looking up device details. - `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection. | [optional] **httpBrowserEmail** | **String** | Email address set in the customer's browser, which may differ from customer email. | [optional] **userAgent** | **String** | Customer's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. | [optional] **rawData** | [**List<Ptsv2paymentsDeviceInformationRawData>**](Ptsv2paymentsDeviceInformationRawData.md) | | [optional] diff --git a/docs/TmsEmbeddedInstrumentIdentifier.md b/docs/TmsEmbeddedInstrumentIdentifier.md index 4500179bf..41a6b55e1 100644 --- a/docs/TmsEmbeddedInstrumentIdentifier.md +++ b/docs/TmsEmbeddedInstrumentIdentifier.md @@ -9,8 +9,10 @@ Name | Type | Description | Notes **object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**source** | **String** | Source of the card details. Possible Values: - CONTACTLESS_TAP | [optional] **tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] +**pointOfSaleInformation** | [**TmsEmbeddedInstrumentIdentifierPointOfSaleInformation**](TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] **issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] diff --git a/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md b/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md new file mode 100644 index 000000000..38ff48efc --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.md @@ -0,0 +1,10 @@ + +# TmsEmbeddedInstrumentIdentifierPointOfSaleInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**emvTags** | [**List<TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags>**](TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.md) | | + + + diff --git a/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.md b/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.md new file mode 100644 index 000000000..f91c2b02b --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.md @@ -0,0 +1,12 @@ + +# TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tag** | **String** | EMV tag, 1-10 hex characters. | +**value** | **String** | EMV tag value, 1-64 characters. | +**source** | **String** | Source of the tag. Possible Values: - CARD - TERMINAL | + + + diff --git a/docs/Tmsv2TokenizedCard.md b/docs/Tmsv2TokenizedCard.md index b36d776a3..435daf89e 100644 --- a/docs/Tmsv2TokenizedCard.md +++ b/docs/Tmsv2TokenizedCard.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **accountReferenceId** | **String** | An identifier provided by the issuer for the account. | [optional] **consumerId** | **String** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] **createInstrumentIdentifier** | **Boolean** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] -**source** | **String** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] +**source** | **String** | Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] **state** | **String** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] **reason** | **String** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] **number** | **String** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] diff --git a/docs/Tmsv2TokenizedCardCard.md b/docs/Tmsv2TokenizedCardCard.md index 67dda0ef7..8a1bed17f 100644 --- a/docs/Tmsv2TokenizedCardCard.md +++ b/docs/Tmsv2TokenizedCardCard.md @@ -9,6 +9,11 @@ Name | Type | Description | Notes **expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] **type** | **String** | The type of card (Card Network). Possible Values: - 001: visa | [optional] **suffix** | **String** | The customer's latest payment card number suffix. | [optional] +**issueDate** | [**LocalDate**](LocalDate.md) | Card issuance date. XML date format: YYYY-MM-DD. | [optional] +**activationDate** | [**LocalDate**](LocalDate.md) | Card activation date. XML date format: YYYY-MM-DD | [optional] +**expirationPrinted** | **Boolean** | Indicates if the expiration date is printed on the card. | [optional] +**securityCodePrinted** | **Boolean** | Indicates if the Card Verification Number is printed on the card. | [optional] +**termsAndConditions** | [**Tmsv2TokenizedCardCardTermsAndConditions**](Tmsv2TokenizedCardCardTermsAndConditions.md) | | [optional] diff --git a/docs/Tmsv2TokenizedCardCardTermsAndConditions.md b/docs/Tmsv2TokenizedCardCardTermsAndConditions.md new file mode 100644 index 000000000..91af167e1 --- /dev/null +++ b/docs/Tmsv2TokenizedCardCardTermsAndConditions.md @@ -0,0 +1,10 @@ + +# Tmsv2TokenizedCardCardTermsAndConditions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **String** | Issuer Card Terms and Conditions url. | [optional] + + + diff --git a/docs/Tmsv2TokenizedCardMetadataIssuer.md b/docs/Tmsv2TokenizedCardMetadataIssuer.md index 7a8437847..9de1149c9 100644 --- a/docs/Tmsv2TokenizedCardMetadataIssuer.md +++ b/docs/Tmsv2TokenizedCardMetadataIssuer.md @@ -4,9 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | issuer name. | [optional] -**shortDescription** | **String** | issuer short description. | [optional] -**longDescription** | **String** | issuer long description. | [optional] +**name** | **String** | Issuer name. | [optional] +**shortDescription** | **String** | Short description of the card. | [optional] +**longDescription** | **String** | Long description of the card. | [optional] +**email** | **String** | Issuer customer service email address. | [optional] +**phoneNumber** | **String** | Issuer customer service phone number. | [optional] +**url** | **String** | Issuer customer service url. | [optional] diff --git a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md b/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md deleted file mode 100644 index 5a9c137be..000000000 --- a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last4** | **String** | The new last 4 digits of the card number associated to the Tokenized Card. | [optional] -**expirationMonth** | **String** | The new two-digit month of the card associated to the Tokenized Card. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expirationYear** | **String** | The new four-digit year of the card associated to the Tokenized Card. Format: `YYYY`. | [optional] - - - diff --git a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md b/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md deleted file mode 100644 index dc0f32d4f..000000000 --- a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardArt** | [**Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md) | | [optional] - - - diff --git a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md b/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md deleted file mode 100644 index 0f5785508..000000000 --- a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**combinedAsset** | [**Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md) | | [optional] - - - diff --git a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md b/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md deleted file mode 100644 index c3be70685..000000000 --- a/docs/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**update** | **String** | Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card. | [optional] - - - diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.md new file mode 100644 index 000000000..5d553d565 --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.md @@ -0,0 +1,13 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | The id from the authenticated identity. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. | [optional] +**provider** | **String** | The provider of the authenticated identity. Possible Values: - VISA_PAYMENT_PASSKEY | [optional] +**data** | **String** | The data from the authenticated identity, for FIDO this could be the Attestation. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. | [optional] +**relyingPartyId** | **String** | The id of the Relying Party. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.md new file mode 100644 index 000000000..4efef5d6a --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.md @@ -0,0 +1,20 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**platformType** | **String** | Platform type. Possible Values: - iOS: iOS app - ANDROID: Android app - WINDOWS: Windows app - WEB: Browser-based app | [optional] +**ipAddress** | **String** | IP address of the customer. | [optional] +**httpAcceptContent** | **String** | The exact content of the HTTP accept header. | [optional] +**httpBrowserLanguage** | **String** | Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. | [optional] +**httpBrowserJavaEnabled** | **Boolean** | A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False | [optional] +**httpBrowserJavaScriptEnabled** | **Boolean** | A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. | [optional] +**httpBrowserColorDepth** | **String** | Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details | [optional] +**httpBrowserScreenHeight** | **String** | Total height of the Cardholder's screen in pixels. | [optional] +**httpBrowserScreenWidth** | **String** | Total width of the cardholder's screen in pixels. | [optional] +**httpBrowserTimeDifference** | **String** | Time difference between UTC time and the cardholder browser local time, in minutes. | [optional] +**userAgentBrowserValue** | **String** | Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.md new file mode 100644 index 000000000..9549eb20c --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.md @@ -0,0 +1,10 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchantDescriptor** | [**Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor**](Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.md) | | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.md new file mode 100644 index 000000000..a958dbc39 --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.md @@ -0,0 +1,11 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Merchant's name | [optional] +**url** | **String** | Address of company's website provided by merchant | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.md new file mode 100644 index 000000000..5d5749fba --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.md @@ -0,0 +1,11 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amountDetails** | [**Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails**](Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.md) | | [optional] +**billTo** | [**Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo**](Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.md) | | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.md new file mode 100644 index 000000000..63a815358 --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**totalAmount** | **String** | Total amount for the order | [optional] +**currency** | **String** | Currency used for the order. Use an ISO 4217 numeric format currency code. | [optional] + + + diff --git a/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.md b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.md new file mode 100644 index 000000000..63728d932 --- /dev/null +++ b/docs/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.md @@ -0,0 +1,17 @@ + +# Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstName** | **String** | Customer's first name. This name must be the same as the name on the card. | [optional] +**lastName** | **String** | Customer's last name. This name must be the same as the name on the card. | [optional] +**address1** | **String** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] +**locality** | **String** | Payment card billing city. | [optional] +**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] +**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` | [optional] +**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. | [optional] +**email** | **String** | Customer's email address, including the full domain name. | [optional] + + + diff --git a/docs/TokenApi.md b/docs/TokenApi.md index a9f3f3a45..f7f9b3cee 100644 --- a/docs/TokenApi.md +++ b/docs/TokenApi.md @@ -63,7 +63,7 @@ No authorization required Generate Payment Credentials for a TMS Token -| | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. +| | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. ### Example ```java diff --git a/docs/TokenizedCardApi.md b/docs/TokenizedCardApi.md index 3d77f1af7..f977fcb14 100644 --- a/docs/TokenizedCardApi.md +++ b/docs/TokenizedCardApi.md @@ -6,7 +6,6 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**deleteTokenizedCard**](TokenizedCardApi.md#deleteTokenizedCard) | **DELETE** /tms/v2/tokenized-cards/{tokenizedCardId} | Delete a Tokenized Card [**getTokenizedCard**](TokenizedCardApi.md#getTokenizedCard) | **GET** /tms/v2/tokenized-cards/{tokenizedCardId} | Retrieve a Tokenized Card -[**postIssuerLifeCycleSimulation**](TokenizedCardApi.md#postIssuerLifeCycleSimulation) | **POST** /tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations | Simulate Issuer Life Cycle Management Events [**postTokenizedCard**](TokenizedCardApi.md#postTokenizedCard) | **POST** /tms/v2/tokenized-cards | Create a Tokenized Card @@ -62,7 +61,7 @@ No authorization required Retrieve a Tokenized Card -| | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. +| | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. ### Example ```java @@ -98,54 +97,6 @@ Name | Type | Description | Notes No authorization required -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **postIssuerLifeCycleSimulation** -> postIssuerLifeCycleSimulation(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest) - -Simulate Issuer Life Cycle Management Events - -**Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.TokenizedCardApi; - - -TokenizedCardApi apiInstance = new TokenizedCardApi(); -String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration. -String tokenizedCardId = "tokenizedCardId_example"; // String | The Id of a tokenized card. -PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest = new PostIssuerLifeCycleSimulationRequest(); // PostIssuerLifeCycleSimulationRequest | -try { - apiInstance.postIssuerLifeCycleSimulation(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest); -} catch (ApiException e) { - System.err.println("Exception when calling TokenizedCardApi#postIssuerLifeCycleSimulation"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | - **tokenizedCardId** | **String**| The Id of a tokenized card. | - **postIssuerLifeCycleSimulationRequest** | [**PostIssuerLifeCycleSimulationRequest**](PostIssuerLifeCycleSimulationRequest.md)| | - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 diff --git a/docs/TokenizedcardRequest.md b/docs/TokenizedcardRequest.md index 093bb24e2..d2d1775d7 100644 --- a/docs/TokenizedcardRequest.md +++ b/docs/TokenizedcardRequest.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **accountReferenceId** | **String** | An identifier provided by the issuer for the account. | [optional] **consumerId** | **String** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] **createInstrumentIdentifier** | **Boolean** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] -**source** | **String** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] +**source** | **String** | Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] **state** | **String** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] **reason** | **String** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] **number** | **String** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] diff --git a/docs/Upv1capturecontextsCompleteMandate.md b/docs/Upv1capturecontextsCompleteMandate.md index 2145b3a07..cc8c5f873 100644 --- a/docs/Upv1capturecontextsCompleteMandate.md +++ b/docs/Upv1capturecontextsCompleteMandate.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | This field is used to indicate how a payment should be processed. Possible values: - AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.<br><br> - CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.<br><br> - PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable. | [optional] +**tms** | [**Upv1capturecontextsCompleteMandateTms**](Upv1capturecontextsCompleteMandateTms.md) | | [optional] **decisionManager** | **Boolean** | Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True indicates that device fingerprinting will be executed to add additional information for risk service Setting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services. | [optional] **consumerAuthentication** | **Boolean** | Configure Unified Checkout to determine whether Consumer Authentication is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True will attempt to perform authentication using the Payer Authentication Service. Setting this value to False (or not provided) indicates that you do not wish to perform authentication using the Payer Authentication Service. | [optional] diff --git a/docs/Upv1capturecontextsCompleteMandateTms.md b/docs/Upv1capturecontextsCompleteMandateTms.md new file mode 100644 index 000000000..495e3fa43 --- /dev/null +++ b/docs/Upv1capturecontextsCompleteMandateTms.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsCompleteMandateTms + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tokenCreate** | **Boolean** | Use this when you want to create a token from the card/bank data in your payment request. Possible values: - True - False<br><br> | [optional] +**tokenTypes** | **List<String>** | Cybersource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Possible values: - Customer - paymentInstrument - instrumentIdentifier - shippingAddress | [optional] + + + diff --git a/docs/Upv1capturecontextsData.md b/docs/Upv1capturecontextsData.md new file mode 100644 index 000000000..c887d39ef --- /dev/null +++ b/docs/Upv1capturecontextsData.md @@ -0,0 +1,17 @@ + +# Upv1capturecontextsData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orderInformation** | [**Upv1capturecontextsDataOrderInformation**](Upv1capturecontextsDataOrderInformation.md) | | [optional] +**buyerInformation** | [**Upv1capturecontextsDataBuyerInformation**](Upv1capturecontextsDataBuyerInformation.md) | | [optional] +**clientReferenceInformation** | [**Upv1capturecontextsDataClientReferenceInformation**](Upv1capturecontextsDataClientReferenceInformation.md) | | [optional] +**consumerAuthenticationInformation** | [**Upv1capturecontextsDataConsumerAuthenticationInformation**](Upv1capturecontextsDataConsumerAuthenticationInformation.md) | | [optional] +**merchantInformation** | [**Upv1capturecontextsDataMerchantInformation**](Upv1capturecontextsDataMerchantInformation.md) | | [optional] +**processingInformation** | [**Upv1capturecontextsDataProcessingInformation**](Upv1capturecontextsDataProcessingInformation.md) | | [optional] +**recipientInformation** | [**Upv1capturecontextsDataRecipientInformation**](Upv1capturecontextsDataRecipientInformation.md) | | [optional] +**merchantDefinedInformation** | [**Upv1capturecontextsDataMerchantDefinedInformation**](Upv1capturecontextsDataMerchantDefinedInformation.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataBuyerInformation.md b/docs/Upv1capturecontextsDataBuyerInformation.md new file mode 100644 index 000000000..8ffac2bad --- /dev/null +++ b/docs/Upv1capturecontextsDataBuyerInformation.md @@ -0,0 +1,12 @@ + +# Upv1capturecontextsDataBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**personalIdentification** | [**Upv1capturecontextsDataBuyerInformationPersonalIdentification**](Upv1capturecontextsDataBuyerInformationPersonalIdentification.md) | | [optional] +**merchantCustomerId** | **String** | | [optional] +**companyTaxId** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md b/docs/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md new file mode 100644 index 000000000..44443a505 --- /dev/null +++ b/docs/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md @@ -0,0 +1,10 @@ + +# Upv1capturecontextsDataBuyerInformationPersonalIdentification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cpf** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataClientReferenceInformation.md b/docs/Upv1capturecontextsDataClientReferenceInformation.md new file mode 100644 index 000000000..aac793c10 --- /dev/null +++ b/docs/Upv1capturecontextsDataClientReferenceInformation.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | | [optional] +**partner** | [**Upv1capturecontextsDataClientReferenceInformationPartner**](Upv1capturecontextsDataClientReferenceInformationPartner.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataClientReferenceInformationPartner.md b/docs/Upv1capturecontextsDataClientReferenceInformationPartner.md new file mode 100644 index 000000000..77a3e9c07 --- /dev/null +++ b/docs/Upv1capturecontextsDataClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**developerId** | **String** | | [optional] +**solutionId** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataConsumerAuthenticationInformation.md b/docs/Upv1capturecontextsDataConsumerAuthenticationInformation.md new file mode 100644 index 000000000..08c766e7b --- /dev/null +++ b/docs/Upv1capturecontextsDataConsumerAuthenticationInformation.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**challengeCode** | **String** | | [optional] +**messageCategory** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataMerchantDefinedInformation.md b/docs/Upv1capturecontextsDataMerchantDefinedInformation.md new file mode 100644 index 000000000..f6f2cbb90 --- /dev/null +++ b/docs/Upv1capturecontextsDataMerchantDefinedInformation.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataMerchantDefinedInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | The key or identifier for the merchant-defined data field | [optional] +**value** | **String** | The value associated with the merchant-defined data field | [optional] + + + diff --git a/docs/Upv1capturecontextsDataMerchantInformation.md b/docs/Upv1capturecontextsDataMerchantInformation.md new file mode 100644 index 000000000..f8243fd8f --- /dev/null +++ b/docs/Upv1capturecontextsDataMerchantInformation.md @@ -0,0 +1,10 @@ + +# Upv1capturecontextsDataMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchantDescriptor** | [**Upv1capturecontextsDataMerchantInformationMerchantDescriptor**](Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md b/docs/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md new file mode 100644 index 000000000..d93cfcaf8 --- /dev/null +++ b/docs/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md @@ -0,0 +1,10 @@ + +# Upv1capturecontextsDataMerchantInformationMerchantDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The name of the merchant | [optional] + + + diff --git a/docs/Upv1capturecontextsDataOrderInformation.md b/docs/Upv1capturecontextsDataOrderInformation.md new file mode 100644 index 000000000..f680fe715 --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformation.md @@ -0,0 +1,13 @@ + +# Upv1capturecontextsDataOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amountDetails** | [**Upv1capturecontextsDataOrderInformationAmountDetails**](Upv1capturecontextsDataOrderInformationAmountDetails.md) | | [optional] +**billTo** | [**Upv1capturecontextsDataOrderInformationBillTo**](Upv1capturecontextsDataOrderInformationBillTo.md) | | [optional] +**shipTo** | [**Upv1capturecontextsDataOrderInformationShipTo**](Upv1capturecontextsDataOrderInformationShipTo.md) | | [optional] +**lineItems** | [**Upv1capturecontextsDataOrderInformationLineItems**](Upv1capturecontextsDataOrderInformationLineItems.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataOrderInformationAmountDetails.md b/docs/Upv1capturecontextsDataOrderInformationAmountDetails.md new file mode 100644 index 000000000..17579d954 --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformationAmountDetails.md @@ -0,0 +1,16 @@ + +# Upv1capturecontextsDataOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**totalAmount** | **String** | This field defines the total order amount. | [optional] +**currency** | **String** | This field defines the currency applicable to the order. | [optional] +**surcharge** | [**Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge**](Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.md) | | [optional] +**discountAmount** | **String** | This field defines the discount amount applicable to the order. | [optional] +**subTotalAmount** | **String** | This field defines the sub total amount applicable to the order. | [optional] +**serviceFeeAmount** | **String** | This field defines the service fee amount applicable to the order. | [optional] +**taxAmount** | **String** | This field defines the tax amount applicable to the order. | [optional] + + + diff --git a/docs/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.md b/docs/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.md new file mode 100644 index 000000000..e85bcfb86 --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.md @@ -0,0 +1,10 @@ + +# Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **String** | This field defines the surcharge amount applicable to the order. | [optional] + + + diff --git a/docs/Upv1capturecontextsOrderInformationBillTo.md b/docs/Upv1capturecontextsDataOrderInformationBillTo.md similarity index 92% rename from docs/Upv1capturecontextsOrderInformationBillTo.md rename to docs/Upv1capturecontextsDataOrderInformationBillTo.md index dc8b4c732..deb610f3e 100644 --- a/docs/Upv1capturecontextsOrderInformationBillTo.md +++ b/docs/Upv1capturecontextsDataOrderInformationBillTo.md @@ -1,5 +1,5 @@ -# Upv1capturecontextsOrderInformationBillTo +# Upv1capturecontextsDataOrderInformationBillTo ## Properties Name | Type | Description | Notes @@ -14,7 +14,7 @@ Name | Type | Description | Notes **district** | **String** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality | [optional] **locality** | **String** | Payment card billing city. | [optional] **postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. | [optional] -**company** | [**Upv1capturecontextsOrderInformationBillToCompany**](Upv1capturecontextsOrderInformationBillToCompany.md) | | [optional] +**company** | [**Upv1capturecontextsDataOrderInformationBillToCompany**](Upv1capturecontextsDataOrderInformationBillToCompany.md) | | [optional] **email** | **String** | Customer's email address, including the full domain name. | [optional] **firstName** | **String** | Customer's first name. This name must be the same as the name on the card | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. | [optional] diff --git a/docs/Upv1capturecontextsOrderInformationBillToCompany.md b/docs/Upv1capturecontextsDataOrderInformationBillToCompany.md similarity index 96% rename from docs/Upv1capturecontextsOrderInformationBillToCompany.md rename to docs/Upv1capturecontextsDataOrderInformationBillToCompany.md index 2ef27f253..dbfe814dc 100644 --- a/docs/Upv1capturecontextsOrderInformationBillToCompany.md +++ b/docs/Upv1capturecontextsDataOrderInformationBillToCompany.md @@ -1,5 +1,5 @@ -# Upv1capturecontextsOrderInformationBillToCompany +# Upv1capturecontextsDataOrderInformationBillToCompany ## Properties Name | Type | Description | Notes diff --git a/docs/Upv1capturecontextsDataOrderInformationLineItems.md b/docs/Upv1capturecontextsDataOrderInformationLineItems.md new file mode 100644 index 000000000..40c4a59fe --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformationLineItems.md @@ -0,0 +1,41 @@ + +# Upv1capturecontextsDataOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**productCode** | **String** | | [optional] +**productName** | **String** | | [optional] +**productSku** | **String** | | [optional] +**quantity** | **Integer** | | [optional] +**unitPrice** | **String** | | [optional] +**unitOfMeasure** | **String** | | [optional] +**totalAmount** | **String** | | [optional] +**taxAmount** | **String** | | [optional] +**taxRate** | **String** | | [optional] +**taxAppliedAfterDiscount** | **String** | | [optional] +**taxStatusIndicator** | **String** | | [optional] +**taxTypeCode** | **String** | | [optional] +**amountIncludesTax** | **Boolean** | | [optional] +**typeOfSupply** | **String** | | [optional] +**commodityCode** | **String** | | [optional] +**discountAmount** | **String** | | [optional] +**discountApplied** | **Boolean** | | [optional] +**discountRate** | **String** | | [optional] +**invoiceNumber** | **String** | | [optional] +**taxDetails** | [**Upv1capturecontextsDataOrderInformationLineItemsTaxDetails**](Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md) | | [optional] +**fulfillmentType** | **String** | | [optional] +**weight** | **String** | | [optional] +**weightIdentifier** | **String** | | [optional] +**weightUnit** | **String** | | [optional] +**referenceDataCode** | **String** | | [optional] +**referenceDataNumber** | **String** | | [optional] +**unitTaxAmount** | **String** | | [optional] +**productDescription** | **String** | | [optional] +**giftCardCurrency** | **String** | | [optional] +**shippingDestinationTypes** | **String** | | [optional] +**gift** | **Boolean** | | [optional] +**passenger** | [**Upv1capturecontextsDataOrderInformationLineItemsPassenger**](Upv1capturecontextsDataOrderInformationLineItemsPassenger.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md b/docs/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md new file mode 100644 index 000000000..494bd1658 --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md @@ -0,0 +1,17 @@ + +# Upv1capturecontextsDataOrderInformationLineItemsPassenger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | | [optional] +**status** | **String** | | [optional] +**phone** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**id** | **String** | | [optional] +**email** | **String** | | [optional] +**nationality** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md b/docs/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md new file mode 100644 index 000000000..e6278fd20 --- /dev/null +++ b/docs/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md @@ -0,0 +1,16 @@ + +# Upv1capturecontextsDataOrderInformationLineItemsTaxDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | | [optional] +**amount** | **String** | | [optional] +**rate** | **String** | | [optional] +**code** | **String** | | [optional] +**taxId** | **String** | | [optional] +**applied** | **Boolean** | | [optional] +**exemptionCode** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsOrderInformationShipTo.md b/docs/Upv1capturecontextsDataOrderInformationShipTo.md similarity index 96% rename from docs/Upv1capturecontextsOrderInformationShipTo.md rename to docs/Upv1capturecontextsDataOrderInformationShipTo.md index bb5720190..6b520c8be 100644 --- a/docs/Upv1capturecontextsOrderInformationShipTo.md +++ b/docs/Upv1capturecontextsDataOrderInformationShipTo.md @@ -1,5 +1,5 @@ -# Upv1capturecontextsOrderInformationShipTo +# Upv1capturecontextsDataOrderInformationShipTo ## Properties Name | Type | Description | Notes diff --git a/docs/Upv1capturecontextsDataProcessingInformation.md b/docs/Upv1capturecontextsDataProcessingInformation.md new file mode 100644 index 000000000..3d3f4b4bd --- /dev/null +++ b/docs/Upv1capturecontextsDataProcessingInformation.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reconciliationId** | **String** | | [optional] +**authorizationOptions** | [**Upv1capturecontextsDataProcessingInformationAuthorizationOptions**](Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md new file mode 100644 index 000000000..da567ca17 --- /dev/null +++ b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md @@ -0,0 +1,12 @@ + +# Upv1capturecontextsDataProcessingInformationAuthorizationOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aftIndicator** | **Boolean** | | [optional] +**initiator** | [**Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator**](Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] +**businessApplicationId** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md new file mode 100644 index 000000000..1f040f14e --- /dev/null +++ b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md @@ -0,0 +1,11 @@ + +# Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**credentialStoredOnFile** | **Boolean** | | [optional] +**merchantInitiatedTransaction** | [**Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md new file mode 100644 index 000000000..5b28758ad --- /dev/null +++ b/docs/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -0,0 +1,10 @@ + +# Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **String** | | [optional] + + + diff --git a/docs/Upv1capturecontextsDataRecipientInformation.md b/docs/Upv1capturecontextsDataRecipientInformation.md new file mode 100644 index 000000000..208bdbcb6 --- /dev/null +++ b/docs/Upv1capturecontextsDataRecipientInformation.md @@ -0,0 +1,16 @@ + +# Upv1capturecontextsDataRecipientInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstName** | **String** | | [optional] +**middleName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**country** | **String** | The country code of the recipient's country | [optional] +**accountId** | **String** | The account ID of the recipient | [optional] +**administrativeArea** | **String** | The administrative area of the recipient | [optional] +**accountType** | **String** | The account type of the recipient | [optional] + + + diff --git a/docs/Upv1capturecontextsOrderInformation.md b/docs/Upv1capturecontextsOrderInformation.md index 7f71d07c0..7e59a739a 100644 --- a/docs/Upv1capturecontextsOrderInformation.md +++ b/docs/Upv1capturecontextsOrderInformation.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **amountDetails** | [**Upv1capturecontextsOrderInformationAmountDetails**](Upv1capturecontextsOrderInformationAmountDetails.md) | | [optional] -**billTo** | [**Upv1capturecontextsOrderInformationBillTo**](Upv1capturecontextsOrderInformationBillTo.md) | | [optional] -**shipTo** | [**Upv1capturecontextsOrderInformationShipTo**](Upv1capturecontextsOrderInformationShipTo.md) | | [optional] +**billTo** | [**Upv1capturecontextsDataOrderInformationBillTo**](Upv1capturecontextsDataOrderInformationBillTo.md) | | [optional] +**shipTo** | [**Upv1capturecontextsDataOrderInformationShipTo**](Upv1capturecontextsDataOrderInformationShipTo.md) | | [optional] diff --git a/docs/Vasv1currencyconversionClientReferenceInformation.md b/docs/Vasv1currencyconversionClientReferenceInformation.md new file mode 100644 index 000000000..0cfaf2bfe --- /dev/null +++ b/docs/Vasv1currencyconversionClientReferenceInformation.md @@ -0,0 +1,14 @@ + +# Vasv1currencyconversionClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] +**applicationName** | **String** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] +**applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction. | [optional] +**applicationUser** | **String** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional] +**partner** | [**Vasv1currencyconversionClientReferenceInformationPartner**](Vasv1currencyconversionClientReferenceInformationPartner.md) | | [optional] + + + diff --git a/docs/Vasv1currencyconversionClientReferenceInformationPartner.md b/docs/Vasv1currencyconversionClientReferenceInformationPartner.md new file mode 100644 index 000000000..2d89ee727 --- /dev/null +++ b/docs/Vasv1currencyconversionClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ + +# Vasv1currencyconversionClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**developerId** | **String** | Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] +**solutionId** | **String** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional] + + + diff --git a/docs/Vasv1currencyconversionOrderInformation.md b/docs/Vasv1currencyconversionOrderInformation.md new file mode 100644 index 000000000..2d11141b8 --- /dev/null +++ b/docs/Vasv1currencyconversionOrderInformation.md @@ -0,0 +1,11 @@ + +# Vasv1currencyconversionOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amountDetails** | [**Vasv1currencyconversionOrderInformationAmountDetails**](Vasv1currencyconversionOrderInformationAmountDetails.md) | | [optional] +**currencyConversion** | [**Vasv1currencyconversionOrderInformationCurrencyConversion**](Vasv1currencyconversionOrderInformationCurrencyConversion.md) | | [optional] + + + diff --git a/docs/Vasv1currencyconversionOrderInformationAmountDetails.md b/docs/Vasv1currencyconversionOrderInformationAmountDetails.md new file mode 100644 index 000000000..9376207b0 --- /dev/null +++ b/docs/Vasv1currencyconversionOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ + +# Vasv1currencyconversionOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**originalAmount** | **String** | The amount of the sale in the merchant's currency. Mandatory when type=DCC, optional otherwise. This value cannot be negative. You can include a decimal point (.), but no other special characters. | [optional] +**originalCurrency** | **String** | Original currency of the transaction in the merchant's currency. Mandatory when type=DCC, optional otherwise. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) | [optional] + + + diff --git a/docs/Vasv1currencyconversionOrderInformationCurrencyConversion.md b/docs/Vasv1currencyconversionOrderInformationCurrencyConversion.md new file mode 100644 index 000000000..35ac84114 --- /dev/null +++ b/docs/Vasv1currencyconversionOrderInformationCurrencyConversion.md @@ -0,0 +1,10 @@ + +# Vasv1currencyconversionOrderInformationCurrencyConversion + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing | [optional] + + + diff --git a/docs/Vasv1currencyconversionPaymentInformation.md b/docs/Vasv1currencyconversionPaymentInformation.md new file mode 100644 index 000000000..9215a786e --- /dev/null +++ b/docs/Vasv1currencyconversionPaymentInformation.md @@ -0,0 +1,10 @@ + +# Vasv1currencyconversionPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Vasv1currencyconversionPaymentInformationCard**](Vasv1currencyconversionPaymentInformationCard.md) | | [optional] + + + diff --git a/docs/Vasv1currencyconversionPaymentInformationCard.md b/docs/Vasv1currencyconversionPaymentInformationCard.md new file mode 100644 index 000000000..3eb2ec68d --- /dev/null +++ b/docs/Vasv1currencyconversionPaymentInformationCard.md @@ -0,0 +1,10 @@ + +# Vasv1currencyconversionPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **String** | First 11 digits of the card number for which an offer is being sought. Mandatory when type=DCC. | [optional] + + + diff --git a/docs/Vasv1currencyconversionPointOfSaleInformation.md b/docs/Vasv1currencyconversionPointOfSaleInformation.md new file mode 100644 index 000000000..0268b39c5 --- /dev/null +++ b/docs/Vasv1currencyconversionPointOfSaleInformation.md @@ -0,0 +1,11 @@ + +# Vasv1currencyconversionPointOfSaleInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terminalId** | **String** | Identifier for the terminal used by the merchant's to process the transaction. | [optional] +**entryMode** | **String** | Valid Values: - 'KEYED' - 'SWIPED' - 'CONTACT' - 'CONTACTLESS' How the transaction information was captured. Optional. `KEYED` can refer to MOTO on a terminal, MOTO on a virtual terminal, or eCommerce. All other options refer to card holder present transactions. Optional. | [optional] + + + diff --git a/generator/cybersource-rest-spec-java.json b/generator/cybersource-rest-spec-java.json index 723cfca3e..9db4d9e02 100644 --- a/generator/cybersource-rest-spec-java.json +++ b/generator/cybersource-rest-spec-java.json @@ -293,6 +293,10 @@ { "name": "bankAccountValidation", "description": "The Visa Bank Account Validation Service is a new standalone product designed to validate customer's routing and bank account number combination for ACH transactions. Merchant's can use this standalone product to validate their customer's account prior to processing an ACH transaction against the customer's account to comply with Nacha's account validation mandate for Web-debit transactions.\n" + }, + { + "name": "Offers", + "description": "Operations related to creating, retrieving, and updating offers.\n" } ], "x-devcenter-metaData": { @@ -393,6 +397,9 @@ { "name": "Visa_Bank_Account_Validation", "description": "The Visa Bank Account Validation Service is a new standalone product designed to validate customer's routing and bank account number combination for ACH transactions. Merchant's can use this standalone product to validate their customer's account prior to processing an ACH transaction against the customer's account to comply with Nacha's account validation mandate for Web-debit transactions.\n" + }, + { + "name": "Currency Conversion" } ] }, @@ -4976,6 +4983,11 @@ "description": "Indicates the economically related transaction id" } } + }, + "responseSourceCode": { + "type": "string", + "maxLength": 1, + "description": "Field contains the response source code that identifies the source.\n" } } }, @@ -5676,12 +5688,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" }, "nameMatch": { "type": "string", @@ -7936,6 +7948,33 @@ "example0": { "summary": "Simple Authorization(Internet)", "sample-name": "Process Payment", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -7969,6 +8008,33 @@ "example1": { "summary": "Authorization with Capture(Sale)", "sample-name": "Process Payment Simple Authorization with Capture(Sale)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8005,6 +8071,33 @@ "example2": { "summary": "Payment with Flex Token", "sample-name": "Payment with Flex Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8036,6 +8129,33 @@ "example3": { "summary": "Payment with Flex Token(Create Permanent TMS token)", "sample-name": "Payment with Flex Token(Create Permanent TMS token)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8084,6 +8204,33 @@ "example4": { "summary": "Authorization with Customer Token Creation", "sample-name": "Authorization with Customer Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8138,6 +8285,33 @@ "example5": { "summary": "Authorization with Customer Token Id", "sample-name": "Authorization with Customer Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8159,6 +8333,33 @@ "example6": { "summary": "Authorization & Create Default Payment Instrument, Shipping Address for existing Customer", "sample-name": "Authorization & Create Default Payment Instrument, Shipping Address for existing Customer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8223,6 +8424,33 @@ "example7": { "summary": "Authorization with Instrument Identifier Token Id bypassing Network Token", "sample-name": "Authorization with Instrument Identifier Token Id bypassing Network Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8247,6 +8475,33 @@ "example8": { "summary": "Authorization with Customer, Payment Instrument and Shipping Address Token Id", "sample-name": "Authorization with Customer, Payment Instrument and Shipping Address Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8274,6 +8529,33 @@ "example9": { "summary": "Authorization with Instrument Identifier Token Creation", "sample-name": "Authorization with Instrument Identifier Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8327,6 +8609,33 @@ "example10": { "summary": "Authorization with Decision Manager", "sample-name": "Authorization with Decision Manager", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TSYS_Eh_FE_01" @@ -8361,6 +8670,33 @@ "example11": { "summary": "Authorization - Skip DecisionManager for single transaction", "sample-name": "Authorization - Skip DecisionManager for single transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "processingInformation": { "actionList": [ @@ -8399,6 +8735,33 @@ }, "example12": { "summary": "Authorization with Decision Manager (Device Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8439,6 +8802,33 @@ }, "example13": { "summary": "Authorization with Decision Manager (Merchant Defined Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8482,6 +8872,33 @@ }, "example14": { "summary": "Authorization with Decision Manager (Travel Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8530,6 +8947,33 @@ }, "example15": { "summary": "Authorization with Decision Manager (Buyer Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8573,6 +9017,33 @@ }, "example16": { "summary": "Authorization with Decision Manager (Shipping Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8617,6 +9088,33 @@ "example17": { "summary": "Authorization with Decision Manager (custom setup)", "sample-name": "Authorization with Decision Manager (custom setup)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "processingInformation": { "actionList": [ @@ -8656,6 +9154,33 @@ "example18": { "summary": "Authorization with PA Enroll (Authentication Needed)", "sample-name": "Authorization with PA Enroll (Authentication Needed)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8701,6 +9226,33 @@ "example19": { "summary": "Authorization with Payer Auth Validation", "sample-name": "Authorization with Payer Auth Validation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8745,6 +9297,33 @@ "example20": { "summary": "Authorization with DM(Accept) + PA Enroll", "sample-name": "Authorization with DM(Accept) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "cbys_test" @@ -8785,6 +9364,33 @@ "example21": { "summary": "Authorization with DM(Review) + PA Enroll", "sample-name": "Authorization with DM(Review) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8825,6 +9431,33 @@ "example22": { "summary": "Authorization with DM(Reject) + PA Enroll", "sample-name": "Authorization with DM(Reject) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8865,6 +9498,33 @@ "example23": { "summary": "Payment Network Tokenization", "sample-name": "Process Payment with Network Tokenization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_123122" @@ -8908,6 +9568,33 @@ "example24": { "summary": "Digital Payment - GooglePay", "sample-name": "Process Payment with GooglePay", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_1231223" @@ -8952,6 +9639,33 @@ "example25": { "summary": "Digital Payments - ApplePay", "sample-name": "Process Payment with ApplePay", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_1231223" @@ -8996,6 +9710,33 @@ "example26": { "summary": "Zero Dollar Authorization", "sample-name": "Process Payment for Zero Dollar Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "1234567890" @@ -9030,6 +9771,33 @@ "example27": { "summary": "Level II Data", "sample-name": "Process Payment with Level II Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_12" @@ -9068,6 +9836,33 @@ "example28": { "summary": "Level III Data", "sample-name": "Process Payment with Level III Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_14" @@ -9119,6 +9914,33 @@ "example29": { "summary": "Partial Authorization", "sample-name": "Process Payment with Partial Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "1234567890" @@ -9162,6 +9984,33 @@ "example30": { "summary": "Account Funding Transaction", "sample-name": "Process Account Funding Transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "RTS-AFT3-8" @@ -9229,6 +10078,33 @@ "example31": { "summary": "Electronic Check Debits", "sample-name": "Process Payment ECheck Debits", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9267,6 +10143,33 @@ "example32": { "summary": "Electronic Check Debits with Legacy Token", "sample-name": "Process Payment ECheck Debits with Legacy Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9301,6 +10204,33 @@ "example33": { "summary": "Service Fees with Credit Card transaction", "sample-name": "Process Payment Service Fees with Credit Card transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9344,6 +10274,29 @@ "example34": { "summary": "Authorization Using Swiped Track Data", "sample-name": "Authorization Using Swiped Track Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "ABC123", @@ -9375,6 +10328,29 @@ "example35": { "summary": "Sale Using Swiped Track Data with Visa Platform Connect", "sample-name": "Sale Using Swiped Track Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "123456" @@ -9404,6 +10380,29 @@ "example36": { "summary": "Sale Using Keyed Data with Visa Platform Connect", "sample-name": "Sale Using Keyed Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9445,6 +10444,29 @@ "example37": { "summary": "Sale Using Keyed Data with Balance Inquiry", "sample-name": "Sale Using Keyed Data with Balance Inquiry", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9489,6 +10511,29 @@ "example38": { "summary": "Sale Using EMV Technology with Contact Read with Visa Platform Connect", "sample-name": "Sale Using EMV Technology with Contact Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9522,6 +10567,29 @@ "example39": { "summary": "Sale Using EMV Technology with Contactless Read with Visa Platform Connect", "sample-name": "Sale Using EMV Technology with Contactless Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9555,6 +10623,29 @@ "example40": { "summary": "Authorization Using Bluefin PCI P2PE with Visa Platform Connect", "sample-name": "Authorization Using Bluefin PCI P2PE with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant" @@ -9607,6 +10698,29 @@ "example41": { "summary": "Restaurant Authorization", "sample-name": "Restaurant Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant", @@ -9638,6 +10752,29 @@ "example42": { "summary": "Sale Using EMV Technology with a Contactless", "sample-name": "Sale Using EMV Technology with a Contactless", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9667,6 +10804,29 @@ "example43": { "summary": "Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9697,6 +10857,29 @@ "example44": { "summary": "Swiped", "sample-name": "Swiped", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9722,6 +10905,29 @@ "example45": { "summary": "Sale Using Swiped Track Data for Card Present Enabled Acquirer", "sample-name": "Sale Using Swiped Track Data for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9748,6 +10954,29 @@ "example46": { "summary": "Sale Using Keyed Data for Card Present Enabled Acquirer", "sample-name": "Sale Using Keyed Data for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9781,6 +11010,29 @@ "example47": { "summary": "American Express Direct - EMV with Contact Read", "sample-name": "American Express Direct - EMV with Contact Read", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9828,6 +11080,29 @@ "example48": { "summary": "Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9876,6 +11151,29 @@ "example49": { "summary": "Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9924,6 +11222,29 @@ "example50": { "summary": "Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer", "sample-name": "Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant" @@ -9971,6 +11292,33 @@ "example51": { "summary": "Authorization with Instrument Identifier Token Id", "sample-name": "Authorization with Instrument Identifier Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10011,6 +11359,33 @@ "example52": { "summary": "Authorization with Legacy Token", "sample-name": "Authorization with Legacy Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10043,6 +11418,33 @@ "example53": { "summary": "Authorization with PA Enroll (Authentication Needed) & Customer Token Creation", "sample-name": "Authorization with PA Enroll (Authentication Needed) & Customer Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10104,6 +11506,33 @@ "example54": { "summary": "Authorization with Transit Tap Id", "sample-name": "Authorization with Transit Tap Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10137,6 +11566,29 @@ "example55": { "summary": "Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using Swiped Track Data", @@ -10178,6 +11630,29 @@ "example56": { "summary": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using EMV Contact", @@ -10223,6 +11698,29 @@ "example57": { "summary": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using EMV Contactless", @@ -10265,6 +11763,29 @@ "example58": { "summary": "Pin Debit Purchase with Cashback Request with Visa Platform Connect", "sample-name": "Pin Debit Purchase with Cashback Request with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase With Cashback", @@ -10308,6 +11829,29 @@ "example59": { "summary": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase - Balance Inquiry", @@ -10353,6 +11897,29 @@ "example60": { "summary": "EBT - Purchase from SNAP Account with Visa Platform Connect", "sample-name": "EBT - Purchase from SNAP Account with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase From SNAP Account", @@ -10402,6 +11969,29 @@ "example61": { "summary": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect", "sample-name": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase From SNAP Account (Available Balance)", @@ -10451,6 +12041,29 @@ "example62": { "summary": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect", "sample-name": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Voucher Purchase From SNAP Account", @@ -10503,6 +12116,29 @@ "example63": { "summary": "EBT - Purchase from Cash Benefits Account with Cashback", "sample-name": "EBT - Purchase from Cash Benefits Account with Cashback", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase from Cash Benefits Account with CB", @@ -10556,6 +12192,33 @@ "example64": { "summary": "SI Completion Amount>0", "sample-name": "SI Completion", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "deviceInformation": { "httpAcceptBrowserValue": "http", @@ -10619,6 +12282,33 @@ "example65": { "summary": "Redirectional SI Completion Amount > 0", "sample-name": "S2S SI Completion", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "deviceInformation": { "httpAcceptBrowserValue": "http", @@ -10685,6 +12375,29 @@ "example66": { "summary": "PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50", "sample-name": "PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "PIN-less Debit Purchase Using EMV Contactless", @@ -10728,6 +12441,33 @@ "example67": { "summary": "CIT Initiating Recurring Subscription", "sample-name": "CIT Initiating Recurring Subscription", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10777,6 +12517,33 @@ "example68": { "summary": "MIT Recurring", "sample-name": "MIT Recurring", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10824,6 +12591,33 @@ "example69": { "summary": "CIT Initiating Instalment Subscription - UK", "sample-name": "CIT Initiating Instalment Subscription - UK", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10873,6 +12667,33 @@ "example70": { "summary": "MIT Instalment", "sample-name": "MIT Instalment", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10920,6 +12741,33 @@ "example71": { "summary": "CIT Placing Credential on File", "sample-name": "CIT Placing Credential on File", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10966,6 +12814,33 @@ "example72": { "summary": "MIT Unscheduled Credential on File", "sample-name": "MIT Unscheduled Credential on File", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -11013,6 +12888,33 @@ "example73": { "summary": "MIT Industry Practice - Resubmission", "sample-name": "MIT Industry Practice - Resubmission", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -11061,6 +12963,33 @@ "example74": { "summary": "MIT Industry Practice - Delayed Charge - 3RI Visa", "sample-name": "MIT Industry Practice - Delayed Charge - 3RI Visa", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -20959,12 +22888,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" }, "nameMatch": { "type": "string", @@ -22616,6 +24545,51 @@ "items": { "type": "string" } + }, + "japanPaymentOptions": { + "type": "object", + "properties": { + "paymentMethod": { + "type": "string", + "maxLength": 2, + "description": "This value is a 2-digit code indicating the payment method.\nUse Payment Method Code value that applies to the tranasction.\n- 10 (One-time payment)\n- 21, 22, 23, 24 (Bonus(one-time)payment)\n- 61 (Installment payment)\n- 31, 32, 33, 34 (Integrated (Bonus + Installment)payment)\n- 80 (Revolving payment)\n" + }, + "bonuses": { + "type": "string", + "maxLength": 2, + "description": "Field contains the number of bonuses.\n" + }, + "installments": { + "type": "string", + "maximum": 99, + "description": "Number of Installments.\n" + }, + "firstBillingMonth": { + "type": "string", + "maxLength": 2, + "description": "Billing month in MM format.\n" + }, + "bonusAmount": { + "type": "string", + "maxLength": 12, + "description": "This field contains the bonus amount.\n" + }, + "bonusMonth": { + "type": "string", + "maxLength": 2, + "description": "This field contains the Japan specific first bonus month.\n" + }, + "secondBonusAmount": { + "type": "string", + "maxLength": 12, + "description": "Field contains the second bonus amount.\n" + }, + "secondBonusMonth": { + "type": "string", + "maxLength": 2, + "description": "Field contains the Japan specific second bonus month.\n" + } + } } } }, @@ -24789,6 +26763,11 @@ "description": "Indicates the economically related transaction id" } } + }, + "responseSourceCode": { + "type": "string", + "maxLength": 1, + "description": "Field contains the response source code that identifies the source.\n" } } } @@ -27832,6 +29811,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -30545,6 +32539,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -33603,6 +35612,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -45993,6 +48017,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -46033,6 +48061,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -46094,7 +48167,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -46193,6 +48266,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -46342,19 +48452,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -47332,6 +49457,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -47372,6 +49501,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -47433,7 +49607,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -47532,6 +49706,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -47681,19 +49892,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -48229,7 +50455,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -48989,6 +51215,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -49029,6 +51259,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -49090,7 +51365,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -49189,6 +51464,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -49338,19 +51650,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -49886,7 +52213,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -50643,6 +52970,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -50683,6 +53014,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -50744,7 +53120,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -50843,6 +53219,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -50992,19 +53405,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -51991,6 +54419,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -52031,6 +54463,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -52092,7 +54569,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -52191,6 +54668,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -52340,19 +54854,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -52888,7 +55417,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -53352,7 +55881,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -53981,7 +56510,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -54601,7 +57130,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -55111,7 +57640,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -55777,7 +58306,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -56214,7 +58743,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -56869,6 +59398,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -56909,6 +59442,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -56970,7 +59548,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -57069,6 +59647,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -57218,19 +59833,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -57956,6 +60586,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -57996,6 +60630,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -58057,7 +60736,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -58156,6 +60835,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -58305,19 +61021,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -58732,7 +61463,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -59576,6 +62307,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -59616,6 +62351,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -59677,7 +62457,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -59776,6 +62556,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -59925,19 +62742,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -60357,7 +63189,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -61011,6 +63843,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -61051,6 +63887,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -61112,7 +63993,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -61211,6 +64092,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -61360,19 +64278,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -61787,7 +64720,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -62409,6 +65342,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -62449,6 +65386,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -62510,7 +65492,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -62609,6 +65591,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -62758,19 +65777,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -63492,6 +66526,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -63532,6 +66570,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -63593,7 +66676,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -63692,6 +66775,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -63841,19 +66961,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -64268,7 +67403,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -64780,7 +67915,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -65433,6 +68568,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -65473,6 +68612,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -65534,7 +68718,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -65633,6 +68817,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -65782,19 +69003,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -66502,6 +69738,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -66542,6 +69782,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -66603,7 +69888,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -66702,6 +69987,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -66851,19 +70173,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -67278,7 +70615,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -67979,6 +71316,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -68019,6 +71360,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -68080,7 +71466,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -68179,6 +71565,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -68328,19 +71751,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -68755,7 +72193,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -69375,6 +72813,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -69415,6 +72857,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -69476,7 +72963,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -69575,6 +73062,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -69724,19 +73248,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -70458,6 +73997,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -70498,6 +74041,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -70559,7 +74147,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -70658,6 +74246,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -70807,19 +74432,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -71234,7 +74874,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -71662,7 +75302,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -71964,6 +75604,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -72004,6 +75648,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -72065,7 +75754,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -72164,6 +75853,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -72313,19 +76039,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -72726,6 +76467,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -72766,6 +76511,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -72827,7 +76617,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -72926,6 +76716,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -73075,19 +76902,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -73476,6 +77318,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -73516,6 +77362,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -73577,7 +77468,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -73676,6 +77567,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -73825,19 +77753,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -74248,7 +78191,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -74458,6 +78401,26 @@ "expirationYear": "2031" } } + }, + "example4": { + "summary": "Create Instrument Identifier using EMV Tags and Create Network Token", + "value": { + "type": "enrollable card", + "source": "CONTACTLESS_TAP", + "card": { + "number": "4622943123116478", + "securityCode": "123" + }, + "pointOfSaleInformation": { + "emvTags": [ + { + "tag": "5F24", + "value": "261215", + "source": "CARD" + } + ] + } + } } } } @@ -74589,6 +78552,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -74629,6 +78596,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -74690,7 +78702,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -74789,6 +78801,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -74938,19 +78987,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -75361,7 +79425,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -75679,6 +79743,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -75719,6 +79787,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -75780,7 +79893,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -75879,6 +79992,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -76028,19 +80178,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -76455,6 +80620,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -76495,6 +80664,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -76556,7 +80770,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -76655,6 +80869,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -76804,19 +81055,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -77227,7 +81493,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -77603,7 +81869,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -78429,6 +82695,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -78469,6 +82739,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -78530,7 +82845,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -78629,6 +82944,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -78778,19 +83130,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -79210,7 +83577,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -79514,6 +83881,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -79554,6 +83925,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -79615,7 +84031,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -79714,6 +84130,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -79863,19 +84316,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -80342,7 +84810,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -80651,7 +85119,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -80750,352 +85218,46 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" - } - } - }, - "passcode": { - "type": "object", - "description": "Passcode by issuer for ID&V.\n", - "properties": { - "value": { + }, + "issueDate": { "type": "string", - "description": "OTP generated at issuer.\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "description": "Metadata associated with the tokenized card.\n", - "properties": { - "cardArt": { - "title": "TmsCardArt", - "description": "Card art associated with the tokenized card.\n", - "type": "object", "readOnly": true, - "properties": { - "foregroundColor": { - "description": "Card foreground color.\n", - "type": "string", - "readOnly": true - }, - "combinedAsset": { - "description": "Combined card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" - } - } - } - } - } - } - }, - "brandLogoAsset": { - "description": "Brand logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" - } - } - } - } - } - } - }, - "issuerLogoAsset": { - "description": "Issuer logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" - } - } - } - } - } - } - }, - "iconAsset": { - "description": "Icon card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" - } - } - } - } - } - } - } - } + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" }, - "issuer": { - "description": "Issuer associated with the tokenized card.\n", - "type": "object", + "activationDate": { + "type": "string", "readOnly": true, - "properties": { - "name": { - "description": "issuer name.\n", - "type": "string", - "readOnly": true - }, - "shortDescription": { - "description": "issuer short description.\n", - "type": "string", - "readOnly": true - }, - "longDescription": { - "description": "issuer long description.\n", - "type": "string", - "readOnly": true - } - } - } - } - } - } - } - } - ], - "tags": [ - "Tokenized Card" - ], - "operationId": "postTokenizedCard", - "x-devcenter-metaData": { - "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-create-cof-intro.html" - }, - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "responses": { - "200": { - "description": "Returns an existing tokenized card associated with the supplied Id.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally-unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { "type": "object", "readOnly": true, "properties": { - "href": { + "url": { "type": "string", "readOnly": true, - "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + "description": "Issuer Card Terms and Conditions url." } } } } }, - "id": { - "type": "string", - "readOnly": true, - "description": "The Id of the Tokenized Card.\n" - }, - "object": { - "type": "string", - "readOnly": true, - "example": "tokenizedCard", - "description": "The type.\nPossible Values:\n- tokenizedCard\n" - }, - "accountReferenceId": { - "type": "string", - "description": "An identifier provided by the issuer for the account.\n" - }, - "consumerId": { - "type": "string", - "maxLength": 36, - "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." - }, - "createInstrumentIdentifier": { - "type": "boolean", - "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" - }, - "source": { - "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" - }, - "reason": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" - }, - "number": { - "type": "string", - "readOnly": true, - "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" - }, - "expirationMonth": { - "type": "string", - "readOnly": true, - "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "readOnly": true, - "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" - }, - "cryptogram": { - "type": "string", - "readOnly": true, - "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", - "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" - }, - "securityCode": { - "type": "string", - "readOnly": true, - "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", - "example": "4523" - }, - "eci": { - "type": "string", - "readOnly": true, - "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" - }, - "requestorId": { - "type": "string", - "readOnly": true, - "maxLength": 11, - "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" - }, - "enrollmentId": { - "type": "string", - "readOnly": true, - "description": "Unique id to identify this PAN/ enrollment.\n" - }, - "tokenReferenceId": { - "type": "string", - "readOnly": true, - "description": "Unique ID for netwrok token.\n" - }, - "paymentAccountReference": { - "type": "string", - "readOnly": true, - "description": "Payment account reference.\n" - }, - "card": { - "type": "object", - "description": "Card object used to create a network token\n", - "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" - }, - "suffix": { - "type": "string", - "readOnly": true, - "description": "The customer's latest payment card number suffix.\n" - } - } - }, "passcode": { "type": "object", "description": "Passcode by issuer for ID&V.\n", @@ -81242,19 +85404,429 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenized Card" + ], + "operationId": "postTokenizedCard", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "Returns an existing tokenized card associated with the supplied Id.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally-unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -81325,7 +85897,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -81424,6 +85996,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -81573,19 +86182,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -81689,7 +86313,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -81862,21 +86486,23 @@ }, "x-example": { "example0": { - "summary": "Create Network Token using an Issuer Account Reference Id", + "summary": "Create Network Token using a Card", "value": { "createInstrumentIdentifier": true, - "source": "ISSUER", - "accountReferenceId": "c0e9dde7a241ec5e9e50cfd823a51c01", + "source": "ONFILE", "card": { - "type": "001" + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" } } }, "example1": { - "summary": "Create Network Token using a Card", + "summary": "Create Network Token using a Card and a Consumer Id", "value": { "createInstrumentIdentifier": true, "source": "ONFILE", + "consumerId": "consumerId-1234", "card": { "number": "4622943123116478", "expirationMonth": "12", @@ -81885,27 +86511,25 @@ } }, "example2": { - "summary": "Create Network Token using a Network Token (e.g digital PAN)", + "summary": "Create Network Token using an Issuer Account Reference Id", "value": { "createInstrumentIdentifier": true, - "source": "TOKEN", + "source": "ISSUER", + "accountReferenceId": "", "card": { - "number": "4895370017256311", - "expirationMonth": "12", - "expirationYear": "2031" + "type": "001" } } }, "example3": { - "summary": "Create Network Token using a Card and a Consumer Id", + "summary": "Create Network Token using a Network Token (e.g digital PAN)", "value": { "createInstrumentIdentifier": true, - "source": "ONFILE", - "consumerId": "consumerId-1234", + "source": "TOKEN", "card": { - "number": "4622943123116478", + "number": "4895370017256311", "expirationMonth": "12", - "expirationYear": "2026" + "expirationYear": "2031" } } } @@ -81915,7 +86539,7 @@ "/tms/v2/tokenized-cards/{tokenizedCardId}": { "get": { "summary": "Retrieve a Tokenized Card", - "description": "| | | |\n| --- | --- | --- |\n|**Tokenized Cards**
A Tokenized Card represents a network token.\nNetwork tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.\t\n", + "description": "| | | |\n| --- | --- | --- |\n|**Tokenized Cards**
A Tokenized Card represents a network token.\nNetwork tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.\n", "parameters": [ { "name": "profile-id", @@ -81943,7 +86567,7 @@ "operationId": "getTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-retrieve-tkn-consumer-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-retrieve-tkn-consumer-intro.html" }, "produces": [ "application/json;charset=utf-8" @@ -82021,7 +86645,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -82120,6 +86744,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -82269,19 +86930,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -82385,7 +87061,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -82587,7 +87263,7 @@ "operationId": "deleteTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-delete-tkn-consumer-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-delete-tkn-consumer-intro.html" }, "produces": [ "application/json;charset=utf-8" @@ -82645,7 +87321,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -82916,101 +87592,295 @@ } } }, - "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations": { + "/tms/v2/tokens/{tokenId}/payment-credentials": { "post": { - "summary": "Simulate Issuer Life Cycle Management Events", - "description": "**Lifecycle Management Events**
Simulates an issuer life cycle manegement event for updates on the tokenized card.\nThe events that can be simulated are:\n- Token status changes (e.g. active, suspended, deleted)\n- Updates to the underlying card, including card art changes, expiration date changes, and card number suffix.\n**Note:** This is only available in CAS environment.\n", + "summary": "Generate Payment Credentials for a TMS Token", + "description": "| | | | \n| --- | --- | --- | \n|**Token**
A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.
Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.\n", "parameters": [ { "name": "profile-id", "in": "header", - "required": true, - "type": "string", "description": "The Id of a profile containing user specific TMS configuration.", + "required": false, + "type": "string", "minLength": 36, - "maxLength": 36 + "maxLength": 36, + "x-hide-field": true }, { - "name": "tokenizedCardId", + "name": "tokenId", "in": "path", - "description": "The Id of a tokenized card.", + "description": "The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.", "required": true, "type": "string", - "minLength": 12, + "minLength": 1, "maxLength": 32 }, { - "name": "postIssuerLifeCycleSimulationRequest", + "name": "postPaymentCredentialsRequest", "in": "body", "required": true, "schema": { "type": "object", - "description": "Represents the Issuer LifeCycle Event Simulation for a Tokenized Card.\n", "properties": { - "state": { + "paymentCredentialType": { "type": "string", - "description": "The new state of the Tokenized Card.\nPossible Values:\n- ACTIVE\n- SUSPENDED\n- DELETED\n" + "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested.\nIf \"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.\nIf \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.\n\nPossible Values:\n - NETWORK_TOKEN\n - SECURITY_CODE\n - CRYPTOGRAM\n", + "example": "CRYPTOGRAM" }, - "card": { + "transactionType": { + "type": "string", + "description": "Specifies the type of transaction for which the network token credentials are required.\nPossible Values:\n - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default.\n - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.\n", + "example": "ECOM" + }, + "clientCorrelationId": { + "type": "string", + "maxLength": 36, + "pattern": "[A-Za-z0-9]+", + "description": "Used to correlate authentication and payment credential requests.\n", + "example": "ad30cf0c-b825-42ca-806c-bf06094b0b15" + }, + "orderInformation": { "type": "object", "properties": { - "last4": { - "type": "string", - "maxLength": 4, - "description": "The new last 4 digits of the card number associated to the Tokenized Card.\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "The new two-digit month of the card associated to the Tokenized Card.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "description": "Total amount for the order", + "example": "102.21" + }, + "currency": { + "type": "string", + "description": "Currency used for the order. Use an ISO 4217 numeric format currency code.\n", + "example": "978" + } + } }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "The new four-digit year of the card associated to the Tokenized Card.\nFormat: `YYYY`.\n" + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n", + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n", + "example": "Doe" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n", + "example": "1 Market St" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n", + "example": "San Francisco" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n", + "example": "CA" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n", + "example": "94105" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n", + "example": "US" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n", + "example": "test@cybs.com" + } + } } } }, - "metadata": { + "merchantInformation": { "type": "object", "properties": { - "cardArt": { + "merchantDescriptor": { "type": "object", "properties": { - "combinedAsset": { - "type": "object", - "properties": { - "update": { - "type": "string", - "description": "Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card.\n" - } - } + "name": { + "type": "string", + "description": "Merchant's name", + "example": "TWVyY2hhbnQgVlphRjVYQmo" + }, + "url": { + "type": "string", + "description": "Address of company's website provided by merchant", + "example": "aHR0cHM6Ly93d3cuTWVyY2hhbnQtVlphRjVYQmouY29t" } } } } + }, + "deviceInformation": { + "type": "object", + "properties": { + "platformType": { + "type": "string", + "description": "Platform type.\n\nPossible Values:\n - iOS: iOS app\n - ANDROID: Android app\n - WINDOWS: Windows app\n - WEB: Browser-based app\n", + "example": "WEB" + }, + "ipAddress": { + "type": "string", + "maxLength": 45, + "pattern": "[0-9A-Fa-f.]", + "description": "IP address of the customer.\n", + "example": "127.0.0.1" + }, + "httpAcceptContent": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 2048, + "description": "The exact content of the HTTP accept header.\n", + "example": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7" + }, + "httpBrowserLanguage": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 8, + "description": "Value represents the browser language as defined in IETF BCP47.\nExample:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details.\n", + "example": "en-US" + }, + "httpBrowserJavaEnabled": { + "type": "boolean", + "description": "A Boolean value that represents the ability of the cardholder browser to execute Java.\nValue is returned from the navigator.javaEnabled property. Possible Values:True/False\n", + "example": false + }, + "httpBrowserJavaScriptEnabled": { + "type": "boolean", + "description": "A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False.\n**Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser.\n", + "example": true + }, + "httpBrowserColorDepth": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 2, + "description": "Value represents the bit depth of the color palette for displaying images, in bits per pixel.\nExample : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details\n", + "example": "24" + }, + "httpBrowserScreenHeight": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 6, + "description": "Total height of the Cardholder's screen in pixels.\n", + "example": "1080" + }, + "httpBrowserScreenWidth": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 6, + "description": "Total width of the cardholder's screen in pixels.\n", + "example": "1920" + }, + "httpBrowserTimeDifference": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 5, + "description": "Time difference between UTC time and the cardholder browser local time, in minutes.\n", + "example": "420" + }, + "userAgentBrowserValue": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 2048, + "description": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n", + "example": "Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/134.0.0.0Safari/537.36Edg/134.0.0.0" + } + } + }, + "authenticatedIdentities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 50, + "description": "The id from the authenticated identity.\n Base64URL encoded string (RFC4648). \n The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "88662a11a11fa88627e217ab9cb00001" + }, + "provider": { + "type": "string", + "description": "The provider of the authenticated identity.\n\nPossible Values:\n - VISA_PAYMENT_PASSKEY\n", + "example": "VISA_PAYMENT_PASSKEY" + }, + "data": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 17000, + "description": "The data from the authenticated identity, for FIDO this could be the Attestation.\nBase64URL encoded string (RFC4648). \nThe encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "dj0xJmM9ezAwMX06QUFSTk" + }, + "relyingPartyId": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 2000, + "description": "The id of the Relying Party.\n Base64URL encoded string (RFC4648). \n The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "dnRzLmF1dGgudmlzYS5jb20=" + } + } + } } } } } ], "tags": [ - "Tokenized Card" + "Token" ], - "operationId": "postIssuerLifeCycleSimulation", + "operationId": "postTokenPaymentCredentials", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-simulate-issuer-life-cycle-event-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html" }, "consumes": [ "application/json;charset=utf-8" ], "produces": [ - "application/json;charset=utf-8" + "application/jose;charset=utf-8" ], "responses": { - "204": { - "description": "The request is fulfilled but does not need to return a body", + "201": { + "description": "A base64 encoded JSON Web Encryption (JWE) response containing encrypted Payment Credentials.\n\nExample:\n{\n\"kid\":\"a0eb65d572e556fddb68eb3a4078555605f7b283\",\n\"cty\":\"json\",\n\"typ\":\"JWT\",\n\"enc\":\"A256GCM\",\n\"alg\":\"RSA-OAEP-256\"\n}\n[Encrypted Instrument Identifier Payment Credentials]\n\nThe encrypted Payment Credentials will contain the network token and cryptogram or dynamic CVV.\n", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + }, + "v-c-correlation-id": { + "description": "The mandatory correlation id passed by upstream (calling) system.", + "type": "string" + } + }, + "schema": { + "type": "string", + "example": "eyJraWQiOiJhMGViNjVkNTcyZTU1NmZkZGI2OGViM2E0MDc4NTU1NjA1ZjdiMjgzIiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.o3V2waZn8TQgFXVJItH3EFv9IidsMQ45mskDJyAc6HVvIsT2Pw2blK1BpXv9l6JIU4pqKXzeKPTZTOLUOUoUf7Vr8bliMqCwJuHqq9Nx_qDJrL1MIGV9db8Ssog70-Cz5S6kPzWEWvLB-X8WvUsRfk9EY5Ge8r3BhcLyd-NVsIUKUBADS4-Ovrp2USlLehwVuiqbJzjblfwFCbOwAcDUBP3DGi6oZt8odrBCMV_W-1RH8KAZnS7NzkDgIRzzJoTvPLM4tMF2aSvrQG_GmZndLKeleZNa1voAdk35a2PGAyTc85vb_Eju79vV4C2nlCbxC2yImjumlJ_BZaKhj8q2xA.pWQZef3L3O0SFQtU.tfp2L0Jqqw-c4s9m7e0e8Y7eWAHVOEryLQlL3rLYPmo8OdEUaz-ftm_wpdtsycA5-iRZozDyyas6v6zqbXCMIG_Tg6cBS6cESrnBlgnkELtItv9Zw3UPSNVzoA97T0GxJVPmMkaHUkf0IAd7SXH4Zj5zCCTTDbpIwq4-TaGIxvXd_PJ4L6E1wcqEVaI6sU_PoTWvLJOFLDY_H4pjgVENVuPKVPJZodQxvpLo9L9B0zzOs4YMiv-1ACS_91vYUygBbwZuRnOD6jrW6V0J_nRQik2rCOTwV0B-Mt8nEV0xJpUByScrj91I5HBG1SEVDQPc6RJdNPM7SrPWfEc42Vc9F0oSehCpaIk7QXBCYZez629Li0KhUfqhPa5IJUygH8NB_UgfR5AcyzDr76Kq9Dht8PHPmkJVbPRdyVgkZsMmp_6GQ7Q7r2c3WrHESgbjGgsv4cz8Xui3cqw0Ni0Atozh46Kkd6yOPHC6y6IgdR32020Fs0cwTJnsAAkXy_wX4ScI9ElfpqxF9EshA9l5sHNfCPFbA2eHJUSA0x3vaRCoGCdF4GWq-2zgUEANPwkMNvHsB3E5_4gefqJi8K_nMMfekNGxFabqgkLxpqxXuyJ4cADatuE.kxPM1qm305qmJ6KuIU-9-A" + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83020,10 +87890,66 @@ "description": "A globally unique Id associated with your request.", "type": "string" } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } + } + } + } + } + } + }, + "examples": { + "Invalid Customer request body": { + "errors": [ + { + "type": "invalidRequest", + "message": "Invalid HTTP Body" + } + ] + } } }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83048,76 +87974,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - }, - "details": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the field that caused the error." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "The location of the field that caused the error." - } - } - } - } - } - } - } - } - }, - "examples": { - "Invalid Customer request body": { - "errors": [ - { - "type": "invalidRequest", - "message": "Invalid HTTP Body" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -83189,234 +88046,8 @@ } } }, - "500": { - "description": "Unexpected error.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - internalError\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - } - } - } - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Simulate Network Token Status Update", - "value": { - "state": "SUSPENDED" - } - }, - "example1": { - "summary": "Simulate Network Token Card Metadata Update", - "value": { - "card": { - "last4": "9876", - "expirationMonth": "11", - "expirationYear": "2040" - } - } - }, - "example2": { - "summary": "Simulate Network Token Card Art Update", - "value": { - "metadata": { - "cardArt": { - "combinedAsset": { - "update": "true" - } - } - } - } - } - } - } - }, - "/tms/v2/tokens/{tokenId}/payment-credentials": { - "post": { - "summary": "Generate Payment Credentials for a TMS Token", - "description": "| | | | \n| --- | --- | --- | \n|**Token**
A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.\n", - "parameters": [ - { - "name": "profile-id", - "in": "header", - "description": "The Id of a profile containing user specific TMS configuration.", - "required": false, - "type": "string", - "minLength": 36, - "maxLength": 36, - "x-hide-field": true - }, - { - "name": "tokenId", - "in": "path", - "description": "The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, - { - "name": "postPaymentCredentialsRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "paymentCredentialType": { - "type": "string", - "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested.\nIf \"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.\nIf \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.\n\nPossible Values:\n - NETWORK_TOKEN\n - SECURITY_CODE\n - CRYPTOGRAM\n" - }, - "transactionType": { - "type": "string", - "description": "Specifies the type of transaction for which the network token credentials are required.\nPossible Values:\n - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default.\n - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.\n" - } - } - } - } - ], - "tags": [ - "Token" - ], - "operationId": "postTokenPaymentCredentials", - "x-devcenter-metaData": { - "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-retrieve-pay-cred-intro.html" - }, - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/jose;charset=utf-8" - ], - "responses": { - "201": { - "description": "A base64 encoded JSON Web Encryption (JWE) response containing encrypted Payment Credentials.\n\nExample:\n{\n\"kid\":\"a0eb65d572e556fddb68eb3a4078555605f7b283\",\n\"cty\":\"json\",\n\"typ\":\"JWT\",\n\"enc\":\"A256GCM\",\n\"alg\":\"RSA-OAEP-256\"\n}\n[Encrypted Instrument Identifier Payment Credentials]\n\nThe encrypted Payment Credentials will contain the network token and cryptogram or dynamic CVV.\n", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - }, - "v-c-correlation-id": { - "description": "The mandatory correlation id passed by upstream (calling) system.", - "type": "string" - } - }, - "schema": { - "type": "string", - "example": "eyJraWQiOiJhMGViNjVkNTcyZTU1NmZkZGI2OGViM2E0MDc4NTU1NjA1ZjdiMjgzIiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.o3V2waZn8TQgFXVJItH3EFv9IidsMQ45mskDJyAc6HVvIsT2Pw2blK1BpXv9l6JIU4pqKXzeKPTZTOLUOUoUf7Vr8bliMqCwJuHqq9Nx_qDJrL1MIGV9db8Ssog70-Cz5S6kPzWEWvLB-X8WvUsRfk9EY5Ge8r3BhcLyd-NVsIUKUBADS4-Ovrp2USlLehwVuiqbJzjblfwFCbOwAcDUBP3DGi6oZt8odrBCMV_W-1RH8KAZnS7NzkDgIRzzJoTvPLM4tMF2aSvrQG_GmZndLKeleZNa1voAdk35a2PGAyTc85vb_Eju79vV4C2nlCbxC2yImjumlJ_BZaKhj8q2xA.pWQZef3L3O0SFQtU.tfp2L0Jqqw-c4s9m7e0e8Y7eWAHVOEryLQlL3rLYPmo8OdEUaz-ftm_wpdtsycA5-iRZozDyyas6v6zqbXCMIG_Tg6cBS6cESrnBlgnkELtItv9Zw3UPSNVzoA97T0GxJVPmMkaHUkf0IAd7SXH4Zj5zCCTTDbpIwq4-TaGIxvXd_PJ4L6E1wcqEVaI6sU_PoTWvLJOFLDY_H4pjgVENVuPKVPJZodQxvpLo9L9B0zzOs4YMiv-1ACS_91vYUygBbwZuRnOD6jrW6V0J_nRQik2rCOTwV0B-Mt8nEV0xJpUByScrj91I5HBG1SEVDQPc6RJdNPM7SrPWfEc42Vc9F0oSehCpaIk7QXBCYZez629Li0KhUfqhPa5IJUygH8NB_UgfR5AcyzDr76Kq9Dht8PHPmkJVbPRdyVgkZsMmp_6GQ7Q7r2c3WrHESgbjGgsv4cz8Xui3cqw0Ni0Atozh46Kkd6yOPHC6y6IgdR32020Fs0cwTJnsAAkXy_wX4ScI9ElfpqxF9EshA9l5sHNfCPFbA2eHJUSA0x3vaRCoGCdF4GWq-2zgUEANPwkMNvHsB3E5_4gefqJi8K_nMMfekNGxFabqgkLxpqxXuyJ4cADatuE.kxPM1qm305qmJ6KuIU-9-A" - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - }, - "details": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the field that caused the error." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "The location of the field that caused the error." - } - } - } - } - } - } - } - } - }, - "examples": { - "Invalid Customer request body": { - "errors": [ - { - "type": "invalidRequest", - "message": "Invalid HTTP Body" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", + "410": { + "description": "Token Not Available. The token has been deleted.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83441,7 +88072,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" }, "message": { "type": "string", @@ -83457,15 +88088,15 @@ "application/json": { "errors": [ { - "type": "forbidden", - "message": "Request not permitted" + "type": "notAvailable", + "message": "Token not available." } ] } } }, - "404": { - "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "500": { + "description": "Unexpected error.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83476,54 +88107,15 @@ "type": "string" } }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notFound\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - } - } - } - } - } - }, "examples": { "application/json": { "errors": [ { - "type": "notFound", - "message": "Token not found" + "type": "serverError", + "message": "Internal server error" } ] } - } - }, - "410": { - "description": "Token Not Available. The token has been deleted.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } }, "schema": { "type": "object", @@ -83539,7 +88131,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" + "description": "The type of error.\n\nPossible Values:\n - internalError\n" }, "message": { "type": "string", @@ -83550,19 +88142,9 @@ } } } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notAvailable", - "message": "Token not available." - } - ] - } } }, - "500": { + "502": { "description": "Unexpected error.", "headers": { "v-c-correlation-id": { @@ -83578,8 +88160,8 @@ "application/json": { "errors": [ { - "type": "serverError", - "message": "Internal server error" + "type": "badGateway", + "message": "An unexpected error occurred with network token service, check configuration" } ] } @@ -83622,6 +88204,56 @@ "paymentCredentialType": "CRYPTOGRAM", "transactionType": "AFT" } + }, + "example2": { + "summary": "Generate Network Token Credentials using Visa Payment Passkey (VPP) Authentication", + "value": { + "clientCorrelationId": "", + "transactionType": "ECOM", + "orderInformation": { + "amountDetails": { + "totalAmount": "1765.95", + "currency": "978" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "email": "test@cybs.com", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US" + } + }, + "merchantInformation": { + "merchantDescriptor": { + "name": "TWVyY2hhbnQgVlphRjVYQmo", + "url": "aHR0cHM6Ly93d3cuTWVyY2hhbnQtVlphRjVYQmouY29t" + } + }, + "deviceInformation": { + "platformType": "WEB", + "ipAddress": "127.0.0.1", + "httpAcceptContent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/41.0.2228.0 Safari/537.36", + "httpBrowserLanguage": "en-US", + "httpBrowserJavaEnabled": true, + "httpBrowserJavaScriptEnabled": true, + "httpBrowserColorDepth": "24", + "httpBrowserScreenHeight": "1080", + "httpBrowserScreenWidth": "1920", + "httpBrowserTimeDifference": "-480", + "userAgentBrowserValue": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/41.0.2228.0 Safari/537.36" + }, + "authenticatedIdentities": [ + { + "id": "", + "provider": "VISA_PAYMENT_PASSKEY", + "data": "", + "relyingPartyId": "dnRzLmF1dGgudmlzYS5jb20=" + } + ] + } } } } @@ -83786,7 +88418,7 @@ "items": { "type": "string" }, - "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n- VISA\n- MASTERCARD\n- AMEX\n- CARNET\n- CARTESBANCAIRES\n- CUP\n- DINERSCLUB\n- DISCOVER\n- EFTPOS\n- ELO\n- JCB\n- JCREW\n- MADA\n- MAESTRO\n- MEEZA\n- PAYPAK\n\n**Important:** \n - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request.\n - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n" + "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JAYWAN\n - JCB\n - JCREW\n - KCP\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n - UATP\n\n**Important:** \n - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request.\n - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n" }, "allowedPaymentTypes": { "type": "array", @@ -83844,12 +88476,15 @@ "DISCOVER", "EFTPOS", "ELO", + "JAYWAN", "JCB", "JCREW", + "KCP", "MADA", "MAESTRO", "MEEZA", - "PAYPAK" + "PAYPAK", + "UATP" ], "allowedPaymentTypes": [ "CARD" @@ -85240,6 +89875,10 @@ "type": "string", "description": "Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint\ninformation. The string can contain uppercase and lowercase letters, digits, hyphen (-), and\nunderscore (_). However, do not use the same uppercase and lowercase letters to indicate\ndifferent session IDs.\n\nThe session ID must be unique for each merchant ID. You can use any string that you are already\ngenerating, such as an order number or web session ID.\n\nThe session ID must be unique for each page load, regardless of an individual's web session ID.\nIf a user navigates to a profiled page and is assigned a web session, navigates away from the\nprofiled page, then navigates back to the profiled page, the generated session ID should be different\nand unique. You may use a web session ID, but it is preferable to use an application GUID (Globally\nUnique Identifier). This measure ensures that a unique ID is generated every time the page is\nloaded, even if it is the same user reloading the page.\n" }, + "useRawFingerprintSessionId": { + "type": "boolean", + "description": "Boolean that indicates whether request contains the device fingerprint information.\nValues:\n- `true`: Use raw fingerprintSessionId when looking up device details.\n- `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection.\n" + }, "httpBrowserEmail": { "type": "string", "description": "Email address set in the customer's browser, which may differ from customer email.\n" @@ -95348,6 +99987,21 @@ "type": "string", "maxLength": 1, "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -119801,7 +124455,7 @@ "summary": "Get all merchant defined fields for a given reference type", "operationId": "getMerchantDefinedFieldsDefinitions", "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields", + "categoryTag": "Invoicing", "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/invoicing/developer/all/rest/invoicing/Introduction.html" }, "consumes": [ @@ -119980,10 +124634,10 @@ }, "post": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Create merchant defined field for a given reference type", "operationId": "createMerchantDefinedFieldDefinition", @@ -120406,14 +125060,17 @@ }, "x-example": { "example0": { - "fieldType": "Text", - "label": "Cup", - "customerVisible": "true", - "readOnly": "false", - "textMinLength": 1, - "textMaxLength": 100, - "textDefaultValue": "default text", - "merchantDefinedDataIndex": 15 + "summary": "Create merchant defined field", + "value": { + "fieldType": "Text", + "label": "Cup", + "customerVisible": "true", + "readOnly": "false", + "textMinLength": 1, + "textMaxLength": 100, + "textDefaultValue": "default text", + "merchantDefinedDataIndex": 15 + } } } } @@ -120421,12 +125078,13 @@ "/invoicing/v2/{referenceType}/merchantDefinedFields/{id}": { "put": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Update a MerchantDefinedField by ID", + "operationId": "putMerchantDefinedFieldsDefinitions", "parameters": [ { "in": "path", @@ -120756,25 +125414,29 @@ }, "x-example": { "example0": { - "fieldType": "Text", - "label": "Cup", - "customerVisible": "true", - "readOnly": "false", - "textMinLength": 1, - "textMaxLength": 100, - "textDefaultValue": "default text", - "merchantDefinedDataIndex": 15 + "summary": "Create merchant defined field", + "value": { + "fieldType": "Text", + "label": "Cup", + "customerVisible": "true", + "readOnly": "false", + "textMinLength": 1, + "textMaxLength": 100, + "textDefaultValue": "default text", + "merchantDefinedDataIndex": 15 + } } } }, "delete": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Delete a MerchantDefinedField by ID", + "operationId": "deleteMerchantDefinedFieldsDefinitions", "parameters": [ { "in": "path", @@ -146867,14 +151529,14 @@ "MASTERCARD" ] }, - "description": "The list of card networks you want to use for this Unified Checkout transaction.\n\nUnified Checkout currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JCB\n - JCREW\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n" + "description": "The list of card networks you want to use for this Unified Checkout transaction.\n\nUnified Checkout currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JAYWAN\n - JCB\n - JCREW\n - KCP\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n - UATP\n" }, "allowedPaymentTypes": { "type": "array", "items": { "type": "string" }, - "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout also supports the following Alternative Payments:\n - AFTERPAY

\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - 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.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" + "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - 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.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" }, "country": { "type": "string", @@ -146954,6 +151616,28 @@ "maxLength": 25, "description": "This field is used to indicate how a payment should be processed.\n\nPossible values:\n- AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.

\n- CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.

\n- PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable.\n" }, + "tms": { + "type": "object", + "description": "Configure Unified Checkout to create a TMS token at the end of the payment journey\n", + "properties": { + "tokenCreate": { + "type": "boolean", + "example": true, + "description": "Use this when you want to create a token from the card/bank data in your payment request. \n\nPossible values:\n - True\n - False

\n" + }, + "tokenTypes": { + "type": "array", + "items": { + "type": "string", + "maxLength": 30, + "example": [ + "CUSTOMER" + ] + }, + "description": "Cybersource tokens types you are performing a create on.\nIf not supplied the default token type for the merchants token vault will be used.\n\nPossible values:\n- Customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n" + } + } + }, "decisionManager": { "type": "boolean", "description": "Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration.\n\nPossible values:\n - True\n - False

\n\nSetting this value to True indicates that device fingerprinting will be executed to add additional information for risk service\nSetting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services.\n" @@ -146964,6 +151648,747 @@ } } }, + "transientTokenResponseOptions": { + "type": "object", + "properties": { + "includeCardPrefix": { + "type": "boolean", + "description": "Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.\n\nPossible values:\n- True\n- False

\n\nTo select the type of card number prefix:\n- No field included: A 6-digit prefix is returned (default)\n- True: An 8-digit prefix is returned\n- False: No prefix is returned

\n\nThe following conditions apply:\n- 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more.\n- Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.

\n\n**Important:** \nIf your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure.\n" + } + } + }, + "data": { + "type": "object", + "properties": { + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "example": 21, + "description": "This field defines the total order amount.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "description": "This field defines the currency applicable to the order.\n" + }, + "surcharge": { + "type": "object", + "properties": { + "amount": { + "type": "string", + "example": 2.5, + "description": "This field defines the surcharge amount applicable to the order.\n" + } + } + }, + "discountAmount": { + "type": "string", + "example": 2, + "description": "This field defines the discount amount applicable to the order.\n" + }, + "subTotalAmount": { + "type": "string", + "example": 5, + "description": "This field defines the sub total amount applicable to the order.\n" + }, + "serviceFeeAmount": { + "type": "string", + "example": 5, + "description": "This field defines the service fee amount applicable to the order.\n" + }, + "taxAmount": { + "type": "string", + "example": 10, + "description": "This field defines the tax amount applicable to the order.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "example": "277 Park Avenue", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "example": "50th Floor", + "maxLength": 60, + "description": "Used for additional address information. For example: _Attention: Accounts Payable_\nOptional field.\n" + }, + "address3": { + "type": "string", + "example": "Desk NY-50110", + "maxLength": 60, + "description": "Additional address information (third line of the billing address)" + }, + "address4": { + "type": "string", + "example": "address4", + "maxLength": 60, + "description": "Additional address information (fourth line of the billing address)\n" + }, + "administrativeArea": { + "type": "string", + "example": "NY", + "maxLength": 20, + "description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n" + }, + "buildingNumber": { + "type": "string", + "example": "buildingNumber", + "maxLength": 256, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "US", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n" + }, + "district": { + "type": "string", + "example": "district", + "maxLength": 50, + "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n" + }, + "locality": { + "type": "string", + "example": "New York", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "postalCode": { + "type": "string", + "example": 10172, + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Visa Inc", + "maxLength": 60, + "description": "Name of the customer's company." + }, + "address1": { + "type": "string", + "example": "277 Park Avenue", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "example": "50th Floor", + "maxLength": 60, + "description": "Used for additional address information. For example: _Attention: Accounts Payable_\nOptional field.\n" + }, + "address3": { + "type": "string", + "example": "Desk NY-50110", + "maxLength": 60, + "description": "Additional address information (third line of the billing address)" + }, + "address4": { + "type": "string", + "example": "address4", + "maxLength": 60, + "description": "Additional address information (fourth line of the billing address)\n" + }, + "administrativeArea": { + "type": "string", + "example": "NY", + "maxLength": 20, + "description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n" + }, + "buildingNumber": { + "type": "string", + "example": "buildingNumber", + "maxLength": 256, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "US", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n" + }, + "district": { + "type": "string", + "example": "district", + "maxLength": 50, + "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n" + }, + "locality": { + "type": "string", + "example": "New York", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "postalCode": { + "type": "string", + "example": 10172, + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n" + } + } + }, + "email": { + "type": "string", + "example": "john.doe@visa.com", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card" + }, + "lastName": { + "type": "string", + "example": "Doe", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "middleName": { + "type": "string", + "example": "F", + "maxLength": 60, + "description": "Customer's middle name.\n" + }, + "nameSuffix": { + "type": "string", + "example": "Jr", + "maxLength": 60, + "description": "Customer's name suffix.\n" + }, + "title": { + "type": "string", + "example": "Mr", + "maxLength": 60, + "description": "Title.\n" + }, + "phoneNumber": { + "type": "string", + "example": 1234567890, + "description": "Customer's phone number.\n" + }, + "phoneType": { + "type": "string", + "example": "phoneType", + "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "example": "Victoria House", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "address3": { + "type": "string", + "example": "15-17 Gloucester Street", + "description": "Third line of the shipping address.\n" + }, + "address4": { + "type": "string", + "example": "string", + "maxLength": 60, + "description": "Fourth line of the shipping address." + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 2, + "description": "State or province of the shipping address.\n\nUse the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf)\n" + }, + "buildingNumber": { + "type": "string", + "example": "string", + "maxLength": 15, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "GB", + "description": "Country of the shipping address.\n\nUse the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n" + }, + "district": { + "type": "string", + "example": "string", + "maxLength": 50, + "description": "Neighborhood, community, or region within a city or municipality." + }, + "locality": { + "type": "string", + "example": "Belfast", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "postalCode": { + "type": "string", + "example": "BT1 4LS", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n" + }, + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "First name of the recipient" + }, + "lastName": { + "type": "string", + "example": "Doe", + "maxLength": 60, + "description": "Last name of the recipient." + } + } + }, + "lineItems": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "example": "electronics" + }, + "productName": { + "type": "string", + "maxLength": 255, + "example": "smartphone" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "example": "SKU12345" + }, + "quantity": { + "type": "integer", + "minimum": 1, + "maximum": 999999999, + "default": 1, + "example": 2 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "example": "399.99" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "example": "EA" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "example": "799.98" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "example": "64.00" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "example": "0.88" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "example": "Y" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "example": "N" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "example": "VAT" + }, + "amountIncludesTax": { + "type": "boolean", + "example": false + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "example": "GS" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "example": "123456" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "example": "10.00" + }, + "discountApplied": { + "type": "boolean", + "example": true + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "example": "0.05" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "example": "INV-001" + }, + "taxDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "VAT" + }, + "amount": { + "type": "string", + "maxLength": 13, + "example": 5.99 + }, + "rate": { + "type": "string", + "maxLength": 6, + "example": 20 + }, + "code": { + "type": "string", + "maxLength": 4, + "example": "VAT" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "example": "TAXID12345" + }, + "applied": { + "type": "boolean", + "example": true + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "example": "E" + } + } + }, + "fulfillmentType": { + "type": "string", + "example": "Delivery" + }, + "weight": { + "type": "string", + "maxLength": 9, + "example": "1.5" + }, + "weightIdentifier": { + "type": "string", + "maxLength": 1, + "example": "N" + }, + "weightUnit": { + "type": "string", + "maxLength": 2, + "example": "KG" + }, + "referenceDataCode": { + "type": "string", + "maxLength": 150, + "example": "REFCODE" + }, + "referenceDataNumber": { + "type": "string", + "maxLength": 30, + "example": "REF123" + }, + "unitTaxAmount": { + "type": "string", + "maxLength": 15, + "example": "3.20" + }, + "productDescription": { + "type": "string", + "maxLength": 30, + "example": "Latest model smartphone" + }, + "giftCardCurrency": { + "type": "string", + "maxLength": 3, + "example": "USD" + }, + "shippingDestinationTypes": { + "type": "string", + "maxLength": 50, + "example": "Residential" + }, + "gift": { + "type": "boolean", + "example": false + }, + "passenger": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 50, + "example": "Residential" + }, + "status": { + "type": "string", + "maxLength": 32, + "example": "Gold" + }, + "phone": { + "type": "string", + "maxLength": 15, + "example": "123456789" + }, + "firstName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "example": "Doe" + }, + "id": { + "type": "string", + "maxLength": 40, + "example": "AIR1234567" + }, + "email": { + "type": "string", + "maxLength": 50, + "example": "john.doe@example.com" + }, + "nationality": { + "type": "string", + "maxLength": 2, + "example": "US" + } + } + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "personalIdentification": { + "type": "object", + "properties": { + "cpf": { + "type": "string", + "minLength": 11, + "maxLength": 11, + "example": "12345678900" + } + } + }, + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "example": "M123456767" + }, + "companyTaxId": { + "type": "string", + "maxLength": 9, + "example": "" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "example": "TC50171_3" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "example": "DEV12345" + }, + "SolutionId": { + "type": "string", + "maxLength": 8, + "example": "SOL1234" + } + } + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "challengeCode": { + "type": "string", + "maxLength": 2, + "example": "01" + }, + "messageCategory": { + "type": "string", + "maxLength": 2, + "example": "01" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 22, + "example": "Euro Electronics", + "description": "The name of the merchant" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "reconciliationId": { + "type": "string", + "maxLength": 60, + "example": "01234567" + }, + "authorizationOptions": { + "type": "object", + "properties": { + "aftIndicator": { + "type": "boolean", + "example": true + }, + "initiator": { + "type": "object", + "properties": { + "credentialStoredOnFile": { + "type": "boolean", + "example": true + }, + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 1, + "example": 1 + } + } + } + } + }, + "businessApplicationId": { + "type": "string", + "maxLength": 2, + "example": "AA" + } + } + } + } + }, + "recipientInformation": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "middleName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "country": { + "type": "string", + "maxLength": 2, + "example": "GB", + "description": "The country code of the recipient's country" + }, + "accountId": { + "type": "string", + "maxLength": 10, + "example": "2342312", + "description": "The account ID of the recipient" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "example": "Devon", + "description": "The administrative area of the recipient" + }, + "accountType": { + "type": "string", + "maxLength": 2, + "example": "Checking", + "description": "The account type of the recipient" + } + } + }, + "merchantDefinedInformation": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The key or identifier for the merchant-defined data field" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value associated with the merchant-defined data field" + } + } + } + } + }, "orderInformation": { "type": "object", "properties": { @@ -147240,15 +152665,6 @@ } } } - }, - "transientTokenResponseOptions": { - "type": "object", - "properties": { - "includeCardPrefix": { - "type": "boolean", - "description": "Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.\n\nPossible values:\n- True\n- False

\n\nTo select the type of card number prefix:\n- No field included: A 6-digit prefix is returned (default)\n- True: An 8-digit prefix is returned\n- False: No prefix is returned

\n\nThe following conditions apply:\n- 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more.\n- Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.

\n\n**Important:** \nIf your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure.\n" - } - } } } } @@ -147258,7 +152674,7 @@ "example0": { "summary": "Generate Unified Checkout Capture Context", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147304,7 +152720,7 @@ "example1": { "summary": "Generate Unified Checkout Capture Context With Full List of Card Networks", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147312,19 +152728,22 @@ "VISA", "MASTERCARD", "AMEX", - "CARTESBANCAIRES", "CARNET", + "CARTESBANCAIRES", "CUP", "DINERSCLUB", "DISCOVER", "EFTPOS", "ELO", + "JAYWAN", "JCB", "JCREW", + "KCP", "MADA", "MAESTRO", "MEEZA", - "PAYPAK" + "PAYPAK", + "UATP" ], "allowedPaymentTypes": [ "APPLEPAY", @@ -147352,10 +152771,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147363,7 +152784,7 @@ "example2": { "summary": "Generate Unified Checkout Capture Context With Custom Google Payment Options", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147406,10 +152827,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147417,7 +152840,7 @@ "example3": { "summary": "Generate Unified Checkout Capture Context With Autocheck Enrollment", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147454,10 +152877,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147465,7 +152890,7 @@ "example4": { "summary": "Generate Unified Checkout Capture Context (Opt-out of receiving card number prefix)", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147500,10 +152925,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } }, "transientTokenResponseOptions": { @@ -147514,7 +152941,7 @@ "example5": { "summary": "Generate Unified Checkout Capture Context passing Billing & Shipping", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147549,57 +152976,59 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" - }, - "billTo": { - "address1": "277 Park Avenue", - "address2": "50th Floor", - "address3": "Desk NY-50110", - "address4": "address4", - "administrativeArea": "NY", - "buildingNumber": "buildingNumber", - "country": "US", - "district": "district", - "locality": "New York", - "postalCode": "10172", - "company": { - "name": "Visa Inc", - "address1": "900 Metro Center Blvd", - "address2": "address2", - "address3": "address3", + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + }, + "billTo": { + "address1": "277 Park Avenue", + "address2": "50th Floor", + "address3": "Desk NY-50110", "address4": "address4", - "administrativeArea": "CA", - "buildingNumber": "1", + "administrativeArea": "NY", + "buildingNumber": "buildingNumber", "country": "US", "district": "district", - "locality": "Foster City", - "postalCode": "94404" + "locality": "New York", + "postalCode": "10172", + "company": { + "name": "Visa Inc", + "address1": "900 Metro Center Blvd", + "address2": "address2", + "address3": "address3", + "address4": "address4", + "administrativeArea": "CA", + "buildingNumber": "1", + "country": "US", + "district": "district", + "locality": "Foster City", + "postalCode": "94404" + }, + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "middleName": "F", + "nameSuffix": "Jr", + "title": "Mr", + "phoneNumber": "1234567890", + "phoneType": "phoneType" }, - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "middleName": "F", - "nameSuffix": "Jr", - "title": "Mr", - "phoneNumber": "1234567890", - "phoneType": "phoneType" - }, - "shipTo": { - "address1": "CyberSource", - "address2": "Victoria House", - "address3": "15-17 Gloucester Street", - "address4": "string", - "administrativeArea": "CA", - "buildingNumber": "string", - "country": "GB", - "district": "string", - "locality": "Belfast", - "postalCode": "BT1 4LS", - "firstName": "Joe", - "lastName": "Soap" + "shipTo": { + "address1": "CyberSource", + "address2": "Victoria House", + "address3": "15-17 Gloucester Street", + "address4": "string", + "administrativeArea": "CA", + "buildingNumber": "string", + "country": "GB", + "district": "string", + "locality": "Belfast", + "postalCode": "BT1 4LS", + "firstName": "Joe", + "lastName": "Soap" + } } } } @@ -147607,7 +153036,7 @@ "example6": { "summary": "Generate Unified Checkout Capture Context For Click To Pay Drop-In UI", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147632,10 +153061,12 @@ ], "showAcceptedNetworkIcons": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147643,7 +153074,7 @@ "example7": { "summary": "Generate Unified Checkout Capture Context ($ Afterpay (US))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147679,31 +153110,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Galleria Road", - "administrativeArea": "TX", - "buildingNumber": 2, - "country": "US", - "locality": "Houston", - "postalCode": "22096" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 4N3" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Galleria Road", + "administrativeArea": "TX", + "buildingNumber": 2, + "country": "US", + "locality": "Houston", + "postalCode": "22096" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 4N3" + } } } }, @@ -147712,7 +153145,7 @@ "example8": { "summary": "Generate Unified Checkout Capture Context (Afterpay (CAN))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147748,31 +153181,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "CAD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Galleria Road", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 4N3" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 543" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "CAD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Galleria Road", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 4N3" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 543" + } } } }, @@ -147781,7 +153216,7 @@ "example9": { "summary": "Generate Unified Checkout Capture Context (Clearpay (GB))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147819,31 +153254,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "GBP" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Square Street", - "administrativeArea": "Devon", - "buildingNumber": 2, - "country": "GB", - "locality": "Plymouth", - "postalCode": "PL1 1AS" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "GBP" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Square Street", + "administrativeArea": "Devon", + "buildingNumber": 2, + "country": "GB", + "locality": "Plymouth", + "postalCode": "PL1 1AS" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -147852,7 +153289,7 @@ "example10": { "summary": "Generate Unified Checkout Capture Context (Afterpay (AU))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147888,31 +153325,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "AUD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Ocean Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Springtown Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "AUD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Ocean Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Springtown Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + } } } }, @@ -147921,7 +153360,7 @@ "example11": { "summary": "Generate Unified Checkout Capture Context (Afterpay (NZ))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147957,31 +153396,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "NZD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Maranui Avenue", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "NZ", - "locality": "Auckland", - "postalCode": "1022" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Springtown Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "NZD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Maranui Avenue", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "NZ", + "locality": "Auckland", + "postalCode": "1022" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Springtown Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + } } } }, @@ -147990,7 +153431,7 @@ "example12": { "summary": "Generate Unified Checkout Capture Context (iDEAL (NL))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148026,31 +153467,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Stationsstraat 12", - "administrativeArea": "NL-NH", - "buildingNumber": 2, - "country": "NL", - "locality": "Amsterdam", - "postalCode": "1071 JA" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Stationsstraat 12", + "administrativeArea": "NL-NH", + "buildingNumber": 2, + "country": "NL", + "locality": "Amsterdam", + "postalCode": "1071 JA" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -148059,7 +153502,7 @@ "example13": { "summary": "Generate Unified Checkout Capture Context (Multibanco (PT))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148096,31 +153539,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Rua da Liberdade 10", - "administrativeArea": "Mafra", - "buildingNumber": 2, - "country": "PT", - "locality": "Lisboa", - "postalCode": "1234-567" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Rua da Liberdade 10", + "administrativeArea": "Mafra", + "buildingNumber": 2, + "country": "PT", + "locality": "Lisboa", + "postalCode": "1234-567" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -148129,7 +153574,7 @@ "example14": { "summary": "Generate Unified Checkout Capture Context (Przelewy24|P24 (PL))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148166,31 +153611,103 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Ulica Podhalanska 2", - "administrativeArea": "Wroclaw", - "buildingNumber": 2, - "country": "PL", - "locality": "Gdansk", - "postalCode": "80-322" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Ulica Podhalanska 2", + "administrativeArea": "Wroclaw", + "buildingNumber": 2, + "country": "PL", + "locality": "Gdansk", + "postalCode": "80-322" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example15": { + "summary": "Generate Unified Checkout Capture Context (Tink Pay By Bank (GB))", + "value": { + "clientVersion": "0.31", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "TINKPAYBYBANK" + ], + "country": "GB", + "locale": "en-GB", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "GB" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "GBP" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Square Street", + "administrativeArea": "Devon", + "buildingNumber": 2, + "country": "GB", + "locality": "Plymouth", + "postalCode": "PL1 1AS" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -150118,6 +155635,816 @@ } } } + }, + "/vas/v1/currencyconversion": { + "post": { + "summary": "Create an Offer", + "description": "Creates an offer record on the provider system.\n", + "tags": [ + "Offers" + ], + "operationId": "createOffer", + "x-devcenter-metaData": { + "categoryTag": "Currency_Conversion" + }, + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "x-requestid", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-merchant-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-correlation-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-organization-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "offerRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + }, + "applicationName": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource." + }, + "applicationVersion": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "Version of the CyberSource application or integration used for a transaction." + }, + "applicationUser": { + "type": "string", + "maxLength": 60, + "x-nullable": true, + "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method." + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "x-nullable": true, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "x-nullable": true, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 11, + "x-nullable": true, + "description": "First 11 digits of the card number for which an offer is being sought. Mandatory when type=DCC." + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "x-nullable": true, + "description": "The amount of the sale in the merchant's currency. Mandatory when type=DCC, optional otherwise. This value cannot be negative. You can include a decimal point (.), but no other special characters." + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "x-nullable": true, + "description": "Original currency of the transaction in the merchant's currency. Mandatory when type=DCC, optional otherwise.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + } + } + }, + "currencyConversion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "default": "DCC", + "x-nullable": true, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "terminalId": { + "type": "string", + "maxLength": 16, + "x-nullable": true, + "description": "Identifier for the terminal used by the merchant's to process the transaction." + }, + "entryMode": { + "type": "string", + "maxLength": 30, + "x-nullable": true, + "description": "Valid Values:\n- 'KEYED'\n- 'SWIPED'\n- 'CONTACT'\n- 'CONTACTLESS'\n\nHow the transaction information was captured. Optional. `KEYED` can refer to MOTO on a terminal, MOTO on a virtual terminal, or eCommerce. All other options refer to card holder present transactions. Optional.\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909", + "partner": { + "developerId": "123456", + "solutionId": "123456" + }, + "applicationName": "REST API", + "applicationVersion": "1.23.44", + "applicationUser": "Bob" + }, + "paymentInformation": { + "card": { + "number": "41111111111" + } + }, + "orderInformation": { + "amountDetails": { + "originalAmount": "100.00", + "originalCurrency": "GBP" + }, + "currencyConversion": { + "type": "DCC" + } + }, + "pointOfSaleInformation": { + "terminalId": "12345678", + "entryMode": "CONTACT" + } + } + } + } + ], + "responses": { + "201": { + "description": "Request OK.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "maxLength": 18, + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- PENDING\n- DECLINED\n- SERVER_ERROR" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 30, + "description": "Only required when offer cannot be made. The reason of the status.\n\nPossible values:\n- 'INVALID_MERCHANT_CONFIGURATION'\n- 'NOT_ELIGIBLE'\n- 'CURRENCY_NOT_CONFIGURED'\n- 'BIN_UNKNOWN'\n- 'CURRENCY_MATCH'\n- 'CURRENCY_NOT_ALLOWED'\n- 'LOOKUP_FAILED'\n- 'EXCHANGE_RATE_NOT_FOUND'\n- 'CARD_TYPE_NOT_ACCEPTED'\n- 'INVALID_AMOUNT'\n- 'INVALID_CARD'\n- 'INVALID_CURRENCY'\n- 'INVALID_TERMINAL'\n- 'INVALID_ACQUIRER'\n- 'SERVICE_DISABLED'\n- 'DUPLICATE_REQUEST'\n- 'UNKNOWN'\n- 'PROCESSOR_ERROR'\n" + }, + "message": { + "type": "string", + "maxLength": 256, + "description": "Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "currencyConversion": { + "type": "object", + "required": [ + "reconciliationId" + ], + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\nThis should be echo'd from the request\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Unique identifier generated by the DCC provider." + }, + "offer": { + "type": "array", + "description": "When type is DCC this is a single item.\nWhen type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant.\n", + "items": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "description": "The amount of the sale in the merchant's currency. \nFor DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the transaction in the merchant's currency. \nFor DCC this should be the same value as the request. \nFor MCP will be the merchant's base currency as configured on the currency conversion provider's system.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "amount": { + "type": "string", + "maxLength": 15, + "description": "The offer amount, calculated using the originalAmount and the exchangeRate.\nFor DCC this is the amount in the card issuer's currency.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the offer. For DCC this is the card's issuers currency.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "The exchange rate of the offer from 1 major unit of the sale currency including margin.\nThis will be printed on the receipt.\nFor example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up.\nThe receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field.\n" + }, + "exchangeRateInverted": { + "type": "boolean", + "example": true, + "description": "An inverted exchange rate is the base currency amount divided by the converted currency amount.\nEx. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR.\n" + }, + "marginRate": { + "type": "string", + "maxLength": 8, + "description": "The margin between the offer exchange rate and wholesale rates, i.e. the mark up.\nExpressed as a percentage of 100, e.g. 3.75\n" + }, + "rateSource": { + "type": "string", + "maxLength": 50, + "description": "The source of the rate (excluding mark up). Optional field.\n" + }, + "exchangeRateTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "exchangeRateExpirationTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n" + }, + "rateId": { + "type": "string", + "maxLength": 36, + "description": "A unique MCP rate identifier.\n" + } + } + } + }, + "disclaimer": { + "type": "string", + "maxLength": 1024, + "description": "This text is intended to inform customers about their opt-in choices. It should include details such \nas the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as \nthe mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency \nConversion) and optional otherwise. This information will be displayed on the screen and printed on \nthe receipt without modification.\n" + } + } + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "The error message sent directly from the currency conversion provider. Returned only when the provider returns this value.\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909" + }, + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "DECLINED", + "errorInformation": { + "reason": "INVALID_MERCHANT_CONFIGURATION", + "message": "Only required when valid request cannot be fulfilled" + }, + "orderInformation": { + "currencyConversion": { + "type": "DCC", + "reconciliationId": "ABC123", + "offer": [ + { + "originalAmount": "100.00", + "originalCurrency": "GBP", + "amount": "123.21", + "currency": "EUR", + "exchangeRate": "0.8116", + "marginRate": "3.75", + "rateSource": "European Central Bank", + "exchangeRateTimeUtc": "2023-05-17T23:47:57Z", + "exchangeRateExpirationTimeUtc": "2024-05-18T22:47:57Z", + "exchangeRateInverted": true, + "rateId": "009F303309AF07234520190628143445" + } + ], + "disclaimer": "I accept I have been offered a choice of currencies for payment. I accept the conversion rate and sale amount and that the selected currency is EUR. I acknowledge I had a choice to pay in GBP. Currency Conversion for this transaction is offered by the Merchant and is based on the reference rate of the currency conversion provider. Mark up on reference rate: 3.7500." + } + } + } + } + }, + "400": { + "description": "Bad Request Data, e.g. missing field, field containing invalid data.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- INVALID_REQUEST" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n \nPossible values:\n- MISSING_FIELD\n- INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Descriptive message to add more detail to the status\n" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n- MISSING_FIELD\n- INVALID_DATA\n" + } + } + } + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "INVALID_REQUEST", + "reason": "MISSING_FIELD", + "message": "string", + "details": [ + { + "field": "paymentInformation.card.number", + "reason": "MISSING_FIELD" + } + ] + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- SERVER_ERROR" + }, + "reason": { + "type": "string", + "description": "Only required when offer cannot be made.\nThe reason of the status. Only required when the requested action cannot be performed cannot be made.\n\nPossible values:\n- SYSTEM_ERROR\n- SERVER_TIMEOUT\n- SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above.\n" + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "SERVER_ERROR", + "reason": "SYSTEM_ERROR", + "message": "string" + } + } + } + } + } + }, + "/vas/v1/currencyconversion/{id}": { + "get": { + "summary": "Retrieve an Offer", + "description": "Retrieves an offer record from the system.\n", + "tags": [ + "Offers" + ], + "operationId": "getOffer", + "x-devcenter-metaData": { + "categoryTag": "Currency_Conversion" + }, + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "x-requestid", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-merchant-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-correlation-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-organization-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "id", + "in": "path", + "description": "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id", + "required": true, + "type": "string", + "maxLength": 26 + } + ], + "responses": { + "200": { + "description": "Request OK.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + }, + "applicationName": { + "type": "string", + "maxLength": 50, + "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource." + }, + "applicationVersion": { + "type": "string", + "maxLength": 50, + "description": "Version of the CyberSource application or integration used for a transaction." + }, + "applicationUser": { + "type": "string", + "maxLength": 60, + "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method." + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "maxLength": 18, + "description": "Message describing the status of the currency conversion request.\n\nValues:\n- `PENDING`\n- `DECLINED`\n- `INVALID_REQUEST`\n- `SERVER_ERROR`\n- `OFFER_DECLINED`\n- `AUTHORIZED`\n- `AUTHORIZATION_DECLINED`\n- `AUTHORIZATION_FAILURE`\n- `REVERSED`\n- `CAPTURED`\n- `REFUNDED`\n- `CANCELLED`\n" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 30, + "description": "Only required when offer cannot be made. The reason of the status.\n\nPossible values:\n- 'INVALID_MERCHANT_CONFIGURATION'\n- 'NOT_ELIGIBLE'\n- 'CURRENCY_NOT_CONFIGURED'\n- 'BIN_UNKNOWN'\n- 'CURRENCY_MATCH'\n- 'CURRENCY_NOT_ALLOWED'\n- 'LOOKUP_FAILED'\n- 'EXCHANGE_RATE_NOT_FOUND'\n- 'CARD_TYPE_NOT_ACCEPTED'\n- 'INVALID_AMOUNT'\n- 'INVALID_CARD'\n- 'INVALID_CURRENCY'\n- 'INVALID_TERMINAL'\n- 'INVALID_ACQUIRER'\n- 'SERVICE_DISABLED'\n- 'DUPLICATE_REQUEST'\n- 'UNKNOWN'\n- 'PROCESSOR_ERROR'\n" + }, + "message": { + "type": "string", + "maxLength": 256, + "description": "Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "currencyConversion": { + "type": "object", + "required": [ + "reconciliationId" + ], + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\nThis should be echo'd from the request\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Unique identifier generated by the DCC provider." + }, + "offer": { + "type": "array", + "description": "When type is DCC this is a single item.\nWhen type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant.\n", + "items": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "description": "The amount of the sale in the merchant's currency. \nFor DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the transaction in the merchant's currency. \nFor DCC this should be the same value as the request. \nFor MCP will be the merchant's base currency as configured on the currency conversion provider's system.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "amount": { + "type": "string", + "maxLength": 15, + "description": "The offer amount, calculated using the originalAmount and the exchangeRate.\nFor DCC this is the amount in the card issuer's currency.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the offer. For DCC this is the card's issuers currency.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "The exchange rate of the offer from 1 major unit of the sale currency including margin.\nThis will be printed on the receipt.\nFor example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up.\nThe receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field.\n" + }, + "exchangeRateInverted": { + "type": "boolean", + "example": true, + "description": "An inverted exchange rate is the base currency amount divided by the converted currency amount.\nEx. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR.\n" + }, + "marginRate": { + "type": "string", + "maxLength": 8, + "description": "The margin between the offer exchange rate and wholesale rates, i.e. the mark up.\nExpressed as a percentage of 100, e.g. 3.75\n" + }, + "rateSource": { + "type": "string", + "maxLength": 50, + "description": "The source of the rate (excluding mark up). Optional field.\n" + }, + "exchangeRateTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "exchangeRateExpirationTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n" + }, + "rateId": { + "type": "string", + "maxLength": 36, + "description": "A unique MCP rate identifier.\n" + } + } + } + }, + "disclaimer": { + "type": "string", + "maxLength": 1024, + "description": "This text is intended to inform customers about their opt-in choices. It should include details such \nas the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as \nthe mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency \nConversion) and optional otherwise. This information will be displayed on the screen and printed on \nthe receipt without modification.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909", + "partner": { + "developerId": "123456", + "solutionId": "123456" + }, + "applicationName": "REST API", + "applicationVersion": "1.23.44", + "applicationUser": "Bob" + }, + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "OFFER_PENDING", + "errorInformation": { + "reason": "INVALID_MERCHANT_CONFIGURATION", + "message": "Only required when valid request cannot be fulfilled" + }, + "orderInformation": { + "currencyConversion": { + "type": "DCC", + "reconciliationId": "ABC123" + }, + "offer": [ + { + "originalAmount": "100.00", + "originalCurrency": "GBP", + "amount": "123.21", + "currency": "EUR", + "exchangeRate": "0.8116", + "marginRate": "3.75", + "rateSource": "European Central Bank", + "disclaimer": "I accept I have been offered a choice of currencies for payment. I accept the conversion rate and sale amount and that the selected currency is EUR. I acknowledge I had a choice to pay in GBP. Currency Conversion for this transaction is offered by the Merchant and is based on the reference rate of the currency conversion provider. Mark up on reference rate: 3.7500.", + "exchangeRateTimeUtc": "2023-05-17T23:47:57Z", + "exchangeRateExpirationTimeUtc": "2024-05-18T22:47:57Z", + "exchangeRateInverted": true, + "rateId": "009F303309AF07234520190628143445" + } + ] + } + } + } + }, + "404": { + "description": "Offer not found.", + "schema": { + "description": "Currency conversion offer not found" + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- SERVER_ERROR" + }, + "reason": { + "type": "string", + "description": "Only required when offer cannot be made.\nThe reason of the status. Only required when the requested action cannot be performed cannot be made.\n\nPossible values:\n- SYSTEM_ERROR\n- SERVER_TIMEOUT\n- SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above.\n" + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "SERVER_ERROR", + "reason": "SYSTEM_ERROR", + "message": "string" + } + } + } + } + } } } } \ No newline at end of file diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 09749251d..77d450b9b 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -293,6 +293,10 @@ { "name": "bankAccountValidation", "description": "The Visa Bank Account Validation Service is a new standalone product designed to validate customer's routing and bank account number combination for ACH transactions. Merchant's can use this standalone product to validate their customer's account prior to processing an ACH transaction against the customer's account to comply with Nacha's account validation mandate for Web-debit transactions.\n" + }, + { + "name": "Offers", + "description": "Operations related to creating, retrieving, and updating offers.\n" } ], "x-devcenter-metaData": { @@ -393,6 +397,9 @@ { "name": "Visa_Bank_Account_Validation", "description": "The Visa Bank Account Validation Service is a new standalone product designed to validate customer's routing and bank account number combination for ACH transactions. Merchant's can use this standalone product to validate their customer's account prior to processing an ACH transaction against the customer's account to comply with Nacha's account validation mandate for Web-debit transactions.\n" + }, + { + "name": "Currency Conversion" } ] }, @@ -4976,6 +4983,11 @@ "description": "Indicates the economically related transaction id" } } + }, + "responseSourceCode": { + "type": "string", + "maxLength": 1, + "description": "Field contains the response source code that identifies the source.\n" } } }, @@ -5676,12 +5688,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" }, "nameMatch": { "type": "string", @@ -7936,6 +7948,33 @@ "example0": { "summary": "Simple Authorization(Internet)", "sample-name": "Process Payment", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -7969,6 +8008,33 @@ "example1": { "summary": "Authorization with Capture(Sale)", "sample-name": "Process Payment Simple Authorization with Capture(Sale)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8005,6 +8071,33 @@ "example2": { "summary": "Payment with Flex Token", "sample-name": "Payment with Flex Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8036,6 +8129,33 @@ "example3": { "summary": "Payment with Flex Token(Create Permanent TMS token)", "sample-name": "Payment with Flex Token(Create Permanent TMS token)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8084,6 +8204,33 @@ "example4": { "summary": "Authorization with Customer Token Creation", "sample-name": "Authorization with Customer Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8138,6 +8285,33 @@ "example5": { "summary": "Authorization with Customer Token Id", "sample-name": "Authorization with Customer Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8159,6 +8333,33 @@ "example6": { "summary": "Authorization & Create Default Payment Instrument, Shipping Address for existing Customer", "sample-name": "Authorization & Create Default Payment Instrument, Shipping Address for existing Customer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8223,6 +8424,33 @@ "example7": { "summary": "Authorization with Instrument Identifier Token Id bypassing Network Token", "sample-name": "Authorization with Instrument Identifier Token Id bypassing Network Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8247,6 +8475,33 @@ "example8": { "summary": "Authorization with Customer, Payment Instrument and Shipping Address Token Id", "sample-name": "Authorization with Customer, Payment Instrument and Shipping Address Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8274,6 +8529,33 @@ "example9": { "summary": "Authorization with Instrument Identifier Token Creation", "sample-name": "Authorization with Instrument Identifier Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8327,6 +8609,33 @@ "example10": { "summary": "Authorization with Decision Manager", "sample-name": "Authorization with Decision Manager", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TSYS_Eh_FE_01" @@ -8361,6 +8670,33 @@ "example11": { "summary": "Authorization - Skip DecisionManager for single transaction", "sample-name": "Authorization - Skip DecisionManager for single transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "processingInformation": { "actionList": [ @@ -8399,6 +8735,33 @@ }, "example12": { "summary": "Authorization with Decision Manager (Device Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8439,6 +8802,33 @@ }, "example13": { "summary": "Authorization with Decision Manager (Merchant Defined Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8482,6 +8872,33 @@ }, "example14": { "summary": "Authorization with Decision Manager (Travel Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8530,6 +8947,33 @@ }, "example15": { "summary": "Authorization with Decision Manager (Buyer Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8573,6 +9017,33 @@ }, "example16": { "summary": "Authorization with Decision Manager (Shipping Information)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "54323007" @@ -8617,6 +9088,33 @@ "example17": { "summary": "Authorization with Decision Manager (custom setup)", "sample-name": "Authorization with Decision Manager (custom setup)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "processingInformation": { "actionList": [ @@ -8656,6 +9154,33 @@ "example18": { "summary": "Authorization with PA Enroll (Authentication Needed)", "sample-name": "Authorization with PA Enroll (Authentication Needed)", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8701,6 +9226,33 @@ "example19": { "summary": "Authorization with Payer Auth Validation", "sample-name": "Authorization with Payer Auth Validation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8745,6 +9297,33 @@ "example20": { "summary": "Authorization with DM(Accept) + PA Enroll", "sample-name": "Authorization with DM(Accept) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "cbys_test" @@ -8785,6 +9364,33 @@ "example21": { "summary": "Authorization with DM(Review) + PA Enroll", "sample-name": "Authorization with DM(Review) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8825,6 +9431,33 @@ "example22": { "summary": "Authorization with DM(Reject) + PA Enroll", "sample-name": "Authorization with DM(Reject) + PA Enroll", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -8865,6 +9498,33 @@ "example23": { "summary": "Payment Network Tokenization", "sample-name": "Process Payment with Network Tokenization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_123122" @@ -8908,6 +9568,33 @@ "example24": { "summary": "Digital Payment - GooglePay", "sample-name": "Process Payment with GooglePay", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_1231223" @@ -8952,6 +9639,33 @@ "example25": { "summary": "Digital Payments - ApplePay", "sample-name": "Process Payment with ApplePay", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC_1231223" @@ -8996,6 +9710,33 @@ "example26": { "summary": "Zero Dollar Authorization", "sample-name": "Process Payment for Zero Dollar Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "1234567890" @@ -9030,6 +9771,33 @@ "example27": { "summary": "Level II Data", "sample-name": "Process Payment with Level II Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_12" @@ -9068,6 +9836,33 @@ "example28": { "summary": "Level III Data", "sample-name": "Process Payment with Level III Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_14" @@ -9119,6 +9914,33 @@ "example29": { "summary": "Partial Authorization", "sample-name": "Process Payment with Partial Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "1234567890" @@ -9162,6 +9984,33 @@ "example30": { "summary": "Account Funding Transaction", "sample-name": "Process Account Funding Transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "RTS-AFT3-8" @@ -9229,6 +10078,33 @@ "example31": { "summary": "Electronic Check Debits", "sample-name": "Process Payment ECheck Debits", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9267,6 +10143,33 @@ "example32": { "summary": "Electronic Check Debits with Legacy Token", "sample-name": "Process Payment ECheck Debits with Legacy Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9301,6 +10204,33 @@ "example33": { "summary": "Service Fees with Credit Card transaction", "sample-name": "Process Payment Service Fees with Credit Card transaction", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -9344,6 +10274,29 @@ "example34": { "summary": "Authorization Using Swiped Track Data", "sample-name": "Authorization Using Swiped Track Data", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "ABC123", @@ -9375,6 +10328,29 @@ "example35": { "summary": "Sale Using Swiped Track Data with Visa Platform Connect", "sample-name": "Sale Using Swiped Track Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "123456" @@ -9404,6 +10380,29 @@ "example36": { "summary": "Sale Using Keyed Data with Visa Platform Connect", "sample-name": "Sale Using Keyed Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9445,6 +10444,29 @@ "example37": { "summary": "Sale Using Keyed Data with Balance Inquiry", "sample-name": "Sale Using Keyed Data with Balance Inquiry", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9489,6 +10511,29 @@ "example38": { "summary": "Sale Using EMV Technology with Contact Read with Visa Platform Connect", "sample-name": "Sale Using EMV Technology with Contact Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9522,6 +10567,29 @@ "example39": { "summary": "Sale Using EMV Technology with Contactless Read with Visa Platform Connect", "sample-name": "Sale Using EMV Technology with Contactless Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9555,6 +10623,29 @@ "example40": { "summary": "Authorization Using Bluefin PCI P2PE with Visa Platform Connect", "sample-name": "Authorization Using Bluefin PCI P2PE with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant" @@ -9607,6 +10698,29 @@ "example41": { "summary": "Restaurant Authorization", "sample-name": "Restaurant Authorization", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant", @@ -9638,6 +10752,29 @@ "example42": { "summary": "Sale Using EMV Technology with a Contactless", "sample-name": "Sale Using EMV Technology with a Contactless", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9667,6 +10804,29 @@ "example43": { "summary": "Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9697,6 +10857,29 @@ "example44": { "summary": "Swiped", "sample-name": "Swiped", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9722,6 +10905,29 @@ "example45": { "summary": "Sale Using Swiped Track Data for Card Present Enabled Acquirer", "sample-name": "Sale Using Swiped Track Data for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9748,6 +10954,29 @@ "example46": { "summary": "Sale Using Keyed Data for Card Present Enabled Acquirer", "sample-name": "Sale Using Keyed Data for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456 @@ -9781,6 +11010,29 @@ "example47": { "summary": "American Express Direct - EMV with Contact Read", "sample-name": "American Express Direct - EMV with Contact Read", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9828,6 +11080,29 @@ "example48": { "summary": "Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9876,6 +11151,29 @@ "example49": { "summary": "Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer", "sample-name": "Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": 123456, @@ -9924,6 +11222,29 @@ "example50": { "summary": "Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer", "sample-name": "Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "demomerchant" @@ -9971,6 +11292,33 @@ "example51": { "summary": "Authorization with Instrument Identifier Token Id", "sample-name": "Authorization with Instrument Identifier Token Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10011,6 +11359,33 @@ "example52": { "summary": "Authorization with Legacy Token", "sample-name": "Authorization with Legacy Token", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10043,6 +11418,33 @@ "example53": { "summary": "Authorization with PA Enroll (Authentication Needed) & Customer Token Creation", "sample-name": "Authorization with PA Enroll (Authentication Needed) & Customer Token Creation", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10104,6 +11506,33 @@ "example54": { "summary": "Authorization with Transit Tap Id", "sample-name": "Authorization with Transit Tap Id", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10137,6 +11566,29 @@ "example55": { "summary": "Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using Swiped Track Data", @@ -10178,6 +11630,29 @@ "example56": { "summary": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using EMV Contact", @@ -10223,6 +11698,29 @@ "example57": { "summary": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase Using EMV Contactless", @@ -10265,6 +11763,29 @@ "example58": { "summary": "Pin Debit Purchase with Cashback Request with Visa Platform Connect", "sample-name": "Pin Debit Purchase with Cashback Request with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase With Cashback", @@ -10308,6 +11829,29 @@ "example59": { "summary": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect", "sample-name": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "Pin Debit Purchase - Balance Inquiry", @@ -10353,6 +11897,29 @@ "example60": { "summary": "EBT - Purchase from SNAP Account with Visa Platform Connect", "sample-name": "EBT - Purchase from SNAP Account with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase From SNAP Account", @@ -10402,6 +11969,29 @@ "example61": { "summary": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect", "sample-name": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase From SNAP Account (Available Balance)", @@ -10451,6 +12041,29 @@ "example62": { "summary": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect", "sample-name": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Voucher Purchase From SNAP Account", @@ -10503,6 +12116,29 @@ "example63": { "summary": "EBT - Purchase from Cash Benefits Account with Cashback", "sample-name": "EBT - Purchase from Cash Benefits Account with Cashback", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "EBT - Purchase from Cash Benefits Account with CB", @@ -10556,6 +12192,33 @@ "example64": { "summary": "SI Completion Amount>0", "sample-name": "SI Completion", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "deviceInformation": { "httpAcceptBrowserValue": "http", @@ -10619,6 +12282,33 @@ "example65": { "summary": "Redirectional SI Completion Amount > 0", "sample-name": "S2S SI Completion", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "deviceInformation": { "httpAcceptBrowserValue": "http", @@ -10685,6 +12375,29 @@ "example66": { "summary": "PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50", "sample-name": "PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "PIN-less Debit Purchase Using EMV Contactless", @@ -10728,6 +12441,33 @@ "example67": { "summary": "CIT Initiating Recurring Subscription", "sample-name": "CIT Initiating Recurring Subscription", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10777,6 +12517,33 @@ "example68": { "summary": "MIT Recurring", "sample-name": "MIT Recurring", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10824,6 +12591,33 @@ "example69": { "summary": "CIT Initiating Instalment Subscription - UK", "sample-name": "CIT Initiating Instalment Subscription - UK", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10873,6 +12667,33 @@ "example70": { "summary": "MIT Instalment", "sample-name": "MIT Instalment", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10920,6 +12741,33 @@ "example71": { "summary": "CIT Placing Credential on File", "sample-name": "CIT Placing Credential on File", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -10966,6 +12814,33 @@ "example72": { "summary": "MIT Unscheduled Credential on File", "sample-name": "MIT Unscheduled Credential on File", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -11013,6 +12888,33 @@ "example73": { "summary": "MIT Industry Practice - Resubmission", "sample-name": "MIT Industry Practice - Resubmission", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -11061,6 +12963,33 @@ "example74": { "summary": "MIT Industry Practice - Delayed Charge - 3RI Visa", "sample-name": "MIT Industry Practice - Delayed Charge - 3RI Visa", + "processor-type": [ + "Chase Paymentech (Default)", + "FDI Global", + "Visa Platform Connect", + "American Express Direct", + "Barclays", + "Barclays Merchant Services", + "AMEX Direct", + "Bank of America ACH", + "Credit Mutuel-CIC", + "China UnionPay", + "Elavon Americas", + "FDC Compass", + "eCheck", + "GPX", + "Prosa", + "Rupay", + "SIX", + "FDMS Nashville", + "Software Express", + "Streamline", + "ValueLink", + "Worldpay VAP", + "Vero", + "TSYS Acquiring Solutions", + "Wells Fargo ACH" + ], "value": { "clientReferenceInformation": { "code": "TC50171_3" @@ -20959,12 +22888,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" }, "nameMatch": { "type": "string", @@ -22616,6 +24545,51 @@ "items": { "type": "string" } + }, + "japanPaymentOptions": { + "type": "object", + "properties": { + "paymentMethod": { + "type": "string", + "maxLength": 2, + "description": "This value is a 2-digit code indicating the payment method.\nUse Payment Method Code value that applies to the tranasction.\n- 10 (One-time payment)\n- 21, 22, 23, 24 (Bonus(one-time)payment)\n- 61 (Installment payment)\n- 31, 32, 33, 34 (Integrated (Bonus + Installment)payment)\n- 80 (Revolving payment)\n" + }, + "bonuses": { + "type": "string", + "maxLength": 2, + "description": "Field contains the number of bonuses.\n" + }, + "installments": { + "type": "string", + "maximum": 99, + "description": "Number of Installments.\n" + }, + "firstBillingMonth": { + "type": "string", + "maxLength": 2, + "description": "Billing month in MM format.\n" + }, + "bonusAmount": { + "type": "string", + "maxLength": 12, + "description": "This field contains the bonus amount.\n" + }, + "bonusMonth": { + "type": "string", + "maxLength": 2, + "description": "This field contains the Japan specific first bonus month.\n" + }, + "secondBonusAmount": { + "type": "string", + "maxLength": 12, + "description": "Field contains the second bonus amount.\n" + }, + "secondBonusMonth": { + "type": "string", + "maxLength": 2, + "description": "Field contains the Japan specific second bonus month.\n" + } + } } } }, @@ -24789,6 +26763,11 @@ "description": "Indicates the economically related transaction id" } } + }, + "responseSourceCode": { + "type": "string", + "maxLength": 1, + "description": "Field contains the response source code that identifies the source.\n" } } } @@ -27832,6 +29811,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -30545,6 +32539,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -33603,6 +35612,21 @@ "description": "Indicates the economically related transaction id" } } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -45993,6 +48017,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -46033,6 +48061,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -46094,7 +48167,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -46193,6 +48266,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -46342,19 +48452,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -47332,6 +49457,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -47372,6 +49501,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -47433,7 +49607,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -47532,6 +49706,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -47681,19 +49892,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -48229,7 +50455,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -48989,6 +51215,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -49029,6 +51259,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -49090,7 +51365,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -49189,6 +51464,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -49338,19 +51650,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -49886,7 +52213,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -50643,6 +52970,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -50683,6 +53014,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -50744,7 +53120,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -50843,6 +53219,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -50992,19 +53405,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -51991,6 +54419,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -52031,6 +54463,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -52092,7 +54569,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -52191,6 +54668,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -52340,19 +54854,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -52888,7 +55417,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -53352,7 +55881,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -53981,7 +56510,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -54601,7 +57130,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -55111,7 +57640,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -55777,7 +58306,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -56214,7 +58743,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -56869,6 +59398,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -56909,6 +59442,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -56970,7 +59548,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -57069,6 +59647,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -57218,19 +59833,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -57956,6 +60586,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -57996,6 +60630,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -58057,7 +60736,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -58156,6 +60835,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -58305,19 +61021,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -58732,7 +61463,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -59576,6 +62307,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -59616,6 +62351,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -59677,7 +62457,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -59776,6 +62556,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -59925,19 +62742,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -60357,7 +63189,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -61011,6 +63843,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -61051,6 +63887,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -61112,7 +63993,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -61211,6 +64092,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -61360,19 +64278,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -61787,7 +64720,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -62409,6 +65342,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -62449,6 +65386,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -62510,7 +65492,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -62609,6 +65591,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -62758,19 +65777,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -63492,6 +66526,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -63532,6 +66570,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -63593,7 +66676,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -63692,6 +66775,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -63841,19 +66961,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -64268,7 +67403,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -64780,7 +67915,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -65433,6 +68568,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -65473,6 +68612,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -65534,7 +68718,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -65633,6 +68817,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -65782,19 +69003,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -66502,6 +69738,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -66542,6 +69782,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -66603,7 +69888,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -66702,6 +69987,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -66851,19 +70173,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -67278,7 +70615,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -67979,6 +71316,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -68019,6 +71360,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -68080,7 +71466,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -68179,6 +71565,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -68328,19 +71751,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -68755,7 +72193,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -69375,6 +72813,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -69415,6 +72857,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -69476,7 +72963,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -69575,6 +73062,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -69724,19 +73248,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -70458,6 +73997,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -70498,6 +74041,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -70559,7 +74147,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -70658,6 +74246,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -70807,19 +74432,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -71234,7 +74874,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -71662,7 +75302,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -71964,6 +75604,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -72004,6 +75648,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -72065,7 +75754,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -72164,6 +75853,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -72313,19 +76039,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -72726,6 +76467,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -72766,6 +76511,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -72827,7 +76617,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -72926,6 +76716,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -73075,19 +76902,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -73476,6 +77318,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -73516,6 +77362,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -73577,7 +77468,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -73676,6 +77567,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -73825,19 +77753,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -74248,7 +78191,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -74458,6 +78401,26 @@ "expirationYear": "2031" } } + }, + "example4": { + "summary": "Create Instrument Identifier using EMV Tags and Create Network Token", + "value": { + "type": "enrollable card", + "source": "CONTACTLESS_TAP", + "card": { + "number": "4622943123116478", + "securityCode": "123" + }, + "pointOfSaleInformation": { + "emvTags": [ + { + "tag": "5F24", + "value": "261215", + "source": "CARD" + } + ] + } + } } } } @@ -74589,6 +78552,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -74629,6 +78596,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -74690,7 +78702,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -74789,6 +78801,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -74938,19 +78987,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -75361,7 +79425,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -75679,6 +79743,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -75719,6 +79787,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -75780,7 +79893,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -75879,6 +79992,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -76028,19 +80178,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -76455,6 +80620,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -76495,6 +80664,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -76556,7 +80770,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -76655,6 +80869,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -76804,19 +81055,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -77227,7 +81493,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -77603,7 +81869,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -78429,6 +82695,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -78469,6 +82739,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -78530,7 +82845,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -78629,6 +82944,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -78778,19 +83130,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -79210,7 +83577,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -79514,6 +83881,10 @@ "type": "string", "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, "tokenProvisioningInformation": { "type": "object", "properties": { @@ -79554,6 +83925,51 @@ } } }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, "bankAccount": { "type": "object", "properties": { @@ -79615,7 +84031,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -79714,6 +84130,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -79863,19 +84316,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -80342,7 +84810,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -80651,7 +85119,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -80750,352 +85218,46 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" - } - } - }, - "passcode": { - "type": "object", - "description": "Passcode by issuer for ID&V.\n", - "properties": { - "value": { + }, + "issueDate": { "type": "string", - "description": "OTP generated at issuer.\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "description": "Metadata associated with the tokenized card.\n", - "properties": { - "cardArt": { - "title": "TmsCardArt", - "description": "Card art associated with the tokenized card.\n", - "type": "object", "readOnly": true, - "properties": { - "foregroundColor": { - "description": "Card foreground color.\n", - "type": "string", - "readOnly": true - }, - "combinedAsset": { - "description": "Combined card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" - } - } - } - } - } - } - }, - "brandLogoAsset": { - "description": "Brand logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" - } - } - } - } - } - } - }, - "issuerLogoAsset": { - "description": "Issuer logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" - } - } - } - } - } - } - }, - "iconAsset": { - "description": "Icon card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" - } - } - } - } - } - } - } - } + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" }, - "issuer": { - "description": "Issuer associated with the tokenized card.\n", - "type": "object", + "activationDate": { + "type": "string", "readOnly": true, - "properties": { - "name": { - "description": "issuer name.\n", - "type": "string", - "readOnly": true - }, - "shortDescription": { - "description": "issuer short description.\n", - "type": "string", - "readOnly": true - }, - "longDescription": { - "description": "issuer long description.\n", - "type": "string", - "readOnly": true - } - } - } - } - } - } - } - } - ], - "tags": [ - "Tokenized Card" - ], - "operationId": "postTokenizedCard", - "x-devcenter-metaData": { - "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-create-cof-intro.html" - }, - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "responses": { - "200": { - "description": "Returns an existing tokenized card associated with the supplied Id.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally-unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { "type": "object", "readOnly": true, "properties": { - "href": { + "url": { "type": "string", "readOnly": true, - "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + "description": "Issuer Card Terms and Conditions url." } } } } }, - "id": { - "type": "string", - "readOnly": true, - "description": "The Id of the Tokenized Card.\n" - }, - "object": { - "type": "string", - "readOnly": true, - "example": "tokenizedCard", - "description": "The type.\nPossible Values:\n- tokenizedCard\n" - }, - "accountReferenceId": { - "type": "string", - "description": "An identifier provided by the issuer for the account.\n" - }, - "consumerId": { - "type": "string", - "maxLength": 36, - "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." - }, - "createInstrumentIdentifier": { - "type": "boolean", - "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" - }, - "source": { - "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" - }, - "reason": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" - }, - "number": { - "type": "string", - "readOnly": true, - "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" - }, - "expirationMonth": { - "type": "string", - "readOnly": true, - "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "readOnly": true, - "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" - }, - "cryptogram": { - "type": "string", - "readOnly": true, - "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", - "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" - }, - "securityCode": { - "type": "string", - "readOnly": true, - "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", - "example": "4523" - }, - "eci": { - "type": "string", - "readOnly": true, - "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" - }, - "requestorId": { - "type": "string", - "readOnly": true, - "maxLength": 11, - "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" - }, - "enrollmentId": { - "type": "string", - "readOnly": true, - "description": "Unique id to identify this PAN/ enrollment.\n" - }, - "tokenReferenceId": { - "type": "string", - "readOnly": true, - "description": "Unique ID for netwrok token.\n" - }, - "paymentAccountReference": { - "type": "string", - "readOnly": true, - "description": "Payment account reference.\n" - }, - "card": { - "type": "object", - "description": "Card object used to create a network token\n", - "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" - }, - "suffix": { - "type": "string", - "readOnly": true, - "description": "The customer's latest payment card number suffix.\n" - } - } - }, "passcode": { "type": "object", "description": "Passcode by issuer for ID&V.\n", @@ -81242,19 +85404,429 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenized Card" + ], + "operationId": "postTokenizedCard", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "Returns an existing tokenized card associated with the supplied Id.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally-unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -81325,7 +85897,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -81424,6 +85996,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -81573,19 +86182,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -81689,7 +86313,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -81862,21 +86486,23 @@ }, "x-example": { "example0": { - "summary": "Create Network Token using an Issuer Account Reference Id", + "summary": "Create Network Token using a Card", "value": { "createInstrumentIdentifier": true, - "source": "ISSUER", - "accountReferenceId": "c0e9dde7a241ec5e9e50cfd823a51c01", + "source": "ONFILE", "card": { - "type": "001" + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" } } }, "example1": { - "summary": "Create Network Token using a Card", + "summary": "Create Network Token using a Card and a Consumer Id", "value": { "createInstrumentIdentifier": true, "source": "ONFILE", + "consumerId": "consumerId-1234", "card": { "number": "4622943123116478", "expirationMonth": "12", @@ -81885,27 +86511,25 @@ } }, "example2": { - "summary": "Create Network Token using a Network Token (e.g digital PAN)", + "summary": "Create Network Token using an Issuer Account Reference Id", "value": { "createInstrumentIdentifier": true, - "source": "TOKEN", + "source": "ISSUER", + "accountReferenceId": "", "card": { - "number": "4895370017256311", - "expirationMonth": "12", - "expirationYear": "2031" + "type": "001" } } }, "example3": { - "summary": "Create Network Token using a Card and a Consumer Id", + "summary": "Create Network Token using a Network Token (e.g digital PAN)", "value": { "createInstrumentIdentifier": true, - "source": "ONFILE", - "consumerId": "consumerId-1234", + "source": "TOKEN", "card": { - "number": "4622943123116478", + "number": "4895370017256311", "expirationMonth": "12", - "expirationYear": "2026" + "expirationYear": "2031" } } } @@ -81915,7 +86539,7 @@ "/tms/v2/tokenized-cards/{tokenizedCardId}": { "get": { "summary": "Retrieve a Tokenized Card", - "description": "| | | |\n| --- | --- | --- |\n|**Tokenized Cards**
A Tokenized Card represents a network token.\nNetwork tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.\t\n", + "description": "| | | |\n| --- | --- | --- |\n|**Tokenized Cards**
A Tokenized Card represents a network token.\nNetwork tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.\n", "parameters": [ { "name": "profile-id", @@ -81943,7 +86567,7 @@ "operationId": "getTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-retrieve-tkn-consumer-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-retrieve-tkn-consumer-intro.html" }, "produces": [ "application/json;charset=utf-8" @@ -82021,7 +86645,7 @@ }, "source": { "type": "string", - "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" }, "state": { "type": "string", @@ -82120,6 +86744,43 @@ "type": "string", "readOnly": true, "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } } } }, @@ -82269,19 +86930,34 @@ "readOnly": true, "properties": { "name": { - "description": "issuer name.\n", + "description": "Issuer name.\n", "type": "string", "readOnly": true }, "shortDescription": { - "description": "issuer short description.\n", + "description": "Short description of the card.\n", "type": "string", "readOnly": true }, "longDescription": { - "description": "issuer long description.\n", + "description": "Long description of the card.\n", "type": "string", "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." } } } @@ -82385,7 +87061,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -82587,7 +87263,7 @@ "operationId": "deleteTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-delete-tkn-consumer-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-delete-tkn-consumer-intro.html" }, "produces": [ "application/json;charset=utf-8" @@ -82645,7 +87321,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -82916,101 +87592,295 @@ } } }, - "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations": { + "/tms/v2/tokens/{tokenId}/payment-credentials": { "post": { - "summary": "Simulate Issuer Life Cycle Management Events", - "description": "**Lifecycle Management Events**
Simulates an issuer life cycle manegement event for updates on the tokenized card.\nThe events that can be simulated are:\n- Token status changes (e.g. active, suspended, deleted)\n- Updates to the underlying card, including card art changes, expiration date changes, and card number suffix.\n**Note:** This is only available in CAS environment.\n", + "summary": "Generate Payment Credentials for a TMS Token", + "description": "| | | | \n| --- | --- | --- | \n|**Token**
A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.
Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.\n", "parameters": [ { "name": "profile-id", "in": "header", - "required": true, - "type": "string", "description": "The Id of a profile containing user specific TMS configuration.", + "required": false, + "type": "string", "minLength": 36, - "maxLength": 36 + "maxLength": 36, + "x-hide-field": true }, { - "name": "tokenizedCardId", + "name": "tokenId", "in": "path", - "description": "The Id of a tokenized card.", + "description": "The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.", "required": true, "type": "string", - "minLength": 12, + "minLength": 1, "maxLength": 32 }, { - "name": "postIssuerLifeCycleSimulationRequest", + "name": "postPaymentCredentialsRequest", "in": "body", "required": true, "schema": { "type": "object", - "description": "Represents the Issuer LifeCycle Event Simulation for a Tokenized Card.\n", "properties": { - "state": { + "paymentCredentialType": { "type": "string", - "description": "The new state of the Tokenized Card.\nPossible Values:\n- ACTIVE\n- SUSPENDED\n- DELETED\n" + "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested.\nIf \"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.\nIf \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.\n\nPossible Values:\n - NETWORK_TOKEN\n - SECURITY_CODE\n - CRYPTOGRAM\n", + "example": "CRYPTOGRAM" }, - "card": { + "transactionType": { + "type": "string", + "description": "Specifies the type of transaction for which the network token credentials are required.\nPossible Values:\n - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default.\n - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.\n", + "example": "ECOM" + }, + "clientCorrelationId": { + "type": "string", + "maxLength": 36, + "pattern": "[A-Za-z0-9]+", + "description": "Used to correlate authentication and payment credential requests.\n", + "example": "ad30cf0c-b825-42ca-806c-bf06094b0b15" + }, + "orderInformation": { "type": "object", "properties": { - "last4": { - "type": "string", - "maxLength": 4, - "description": "The new last 4 digits of the card number associated to the Tokenized Card.\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "The new two-digit month of the card associated to the Tokenized Card.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "description": "Total amount for the order", + "example": "102.21" + }, + "currency": { + "type": "string", + "description": "Currency used for the order. Use an ISO 4217 numeric format currency code.\n", + "example": "978" + } + } }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "The new four-digit year of the card associated to the Tokenized Card.\nFormat: `YYYY`.\n" + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n", + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n", + "example": "Doe" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n", + "example": "1 Market St" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n", + "example": "San Francisco" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n", + "example": "CA" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n", + "example": "94105" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n", + "example": "US" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n", + "example": "test@cybs.com" + } + } } } }, - "metadata": { + "merchantInformation": { "type": "object", "properties": { - "cardArt": { + "merchantDescriptor": { "type": "object", "properties": { - "combinedAsset": { - "type": "object", - "properties": { - "update": { - "type": "string", - "description": "Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card.\n" - } - } + "name": { + "type": "string", + "description": "Merchant's name", + "example": "TWVyY2hhbnQgVlphRjVYQmo" + }, + "url": { + "type": "string", + "description": "Address of company's website provided by merchant", + "example": "aHR0cHM6Ly93d3cuTWVyY2hhbnQtVlphRjVYQmouY29t" } } } } + }, + "deviceInformation": { + "type": "object", + "properties": { + "platformType": { + "type": "string", + "description": "Platform type.\n\nPossible Values:\n - iOS: iOS app\n - ANDROID: Android app\n - WINDOWS: Windows app\n - WEB: Browser-based app\n", + "example": "WEB" + }, + "ipAddress": { + "type": "string", + "maxLength": 45, + "pattern": "[0-9A-Fa-f.]", + "description": "IP address of the customer.\n", + "example": "127.0.0.1" + }, + "httpAcceptContent": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 2048, + "description": "The exact content of the HTTP accept header.\n", + "example": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7" + }, + "httpBrowserLanguage": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 8, + "description": "Value represents the browser language as defined in IETF BCP47.\nExample:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details.\n", + "example": "en-US" + }, + "httpBrowserJavaEnabled": { + "type": "boolean", + "description": "A Boolean value that represents the ability of the cardholder browser to execute Java.\nValue is returned from the navigator.javaEnabled property. Possible Values:True/False\n", + "example": false + }, + "httpBrowserJavaScriptEnabled": { + "type": "boolean", + "description": "A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False.\n**Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser.\n", + "example": true + }, + "httpBrowserColorDepth": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 2, + "description": "Value represents the bit depth of the color palette for displaying images, in bits per pixel.\nExample : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details\n", + "example": "24" + }, + "httpBrowserScreenHeight": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 6, + "description": "Total height of the Cardholder's screen in pixels.\n", + "example": "1080" + }, + "httpBrowserScreenWidth": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 6, + "description": "Total width of the cardholder's screen in pixels.\n", + "example": "1920" + }, + "httpBrowserTimeDifference": { + "type": "string", + "pattern": "[0-9]+", + "maxLength": 5, + "description": "Time difference between UTC time and the cardholder browser local time, in minutes.\n", + "example": "420" + }, + "userAgentBrowserValue": { + "type": "string", + "pattern": "[A-Za-z0-9]+", + "maxLength": 2048, + "description": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n", + "example": "Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/134.0.0.0Safari/537.36Edg/134.0.0.0" + } + } + }, + "authenticatedIdentities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 50, + "description": "The id from the authenticated identity.\n Base64URL encoded string (RFC4648). \n The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "88662a11a11fa88627e217ab9cb00001" + }, + "provider": { + "type": "string", + "description": "The provider of the authenticated identity.\n\nPossible Values:\n - VISA_PAYMENT_PASSKEY\n", + "example": "VISA_PAYMENT_PASSKEY" + }, + "data": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 17000, + "description": "The data from the authenticated identity, for FIDO this could be the Attestation.\nBase64URL encoded string (RFC4648). \nThe encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "dj0xJmM9ezAwMX06QUFSTk" + }, + "relyingPartyId": { + "type": "string", + "pattern": "[A-Za-z0-9=-_]+", + "maxLength": 2000, + "description": "The id of the Relying Party.\n Base64URL encoded string (RFC4648). \n The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.\n", + "example": "dnRzLmF1dGgudmlzYS5jb20=" + } + } + } } } } } ], "tags": [ - "Tokenized Card" + "Token" ], - "operationId": "postIssuerLifeCycleSimulation", + "operationId": "postTokenPaymentCredentials", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-simulate-issuer-life-cycle-event-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html" }, "consumes": [ "application/json;charset=utf-8" ], "produces": [ - "application/json;charset=utf-8" + "application/jose;charset=utf-8" ], "responses": { - "204": { - "description": "The request is fulfilled but does not need to return a body", + "201": { + "description": "A base64 encoded JSON Web Encryption (JWE) response containing encrypted Payment Credentials.\n\nExample:\n{\n\"kid\":\"a0eb65d572e556fddb68eb3a4078555605f7b283\",\n\"cty\":\"json\",\n\"typ\":\"JWT\",\n\"enc\":\"A256GCM\",\n\"alg\":\"RSA-OAEP-256\"\n}\n[Encrypted Instrument Identifier Payment Credentials]\n\nThe encrypted Payment Credentials will contain the network token and cryptogram or dynamic CVV.\n", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + }, + "v-c-correlation-id": { + "description": "The mandatory correlation id passed by upstream (calling) system.", + "type": "string" + } + }, + "schema": { + "type": "string", + "example": "eyJraWQiOiJhMGViNjVkNTcyZTU1NmZkZGI2OGViM2E0MDc4NTU1NjA1ZjdiMjgzIiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.o3V2waZn8TQgFXVJItH3EFv9IidsMQ45mskDJyAc6HVvIsT2Pw2blK1BpXv9l6JIU4pqKXzeKPTZTOLUOUoUf7Vr8bliMqCwJuHqq9Nx_qDJrL1MIGV9db8Ssog70-Cz5S6kPzWEWvLB-X8WvUsRfk9EY5Ge8r3BhcLyd-NVsIUKUBADS4-Ovrp2USlLehwVuiqbJzjblfwFCbOwAcDUBP3DGi6oZt8odrBCMV_W-1RH8KAZnS7NzkDgIRzzJoTvPLM4tMF2aSvrQG_GmZndLKeleZNa1voAdk35a2PGAyTc85vb_Eju79vV4C2nlCbxC2yImjumlJ_BZaKhj8q2xA.pWQZef3L3O0SFQtU.tfp2L0Jqqw-c4s9m7e0e8Y7eWAHVOEryLQlL3rLYPmo8OdEUaz-ftm_wpdtsycA5-iRZozDyyas6v6zqbXCMIG_Tg6cBS6cESrnBlgnkELtItv9Zw3UPSNVzoA97T0GxJVPmMkaHUkf0IAd7SXH4Zj5zCCTTDbpIwq4-TaGIxvXd_PJ4L6E1wcqEVaI6sU_PoTWvLJOFLDY_H4pjgVENVuPKVPJZodQxvpLo9L9B0zzOs4YMiv-1ACS_91vYUygBbwZuRnOD6jrW6V0J_nRQik2rCOTwV0B-Mt8nEV0xJpUByScrj91I5HBG1SEVDQPc6RJdNPM7SrPWfEc42Vc9F0oSehCpaIk7QXBCYZez629Li0KhUfqhPa5IJUygH8NB_UgfR5AcyzDr76Kq9Dht8PHPmkJVbPRdyVgkZsMmp_6GQ7Q7r2c3WrHESgbjGgsv4cz8Xui3cqw0Ni0Atozh46Kkd6yOPHC6y6IgdR32020Fs0cwTJnsAAkXy_wX4ScI9ElfpqxF9EshA9l5sHNfCPFbA2eHJUSA0x3vaRCoGCdF4GWq-2zgUEANPwkMNvHsB3E5_4gefqJi8K_nMMfekNGxFabqgkLxpqxXuyJ4cADatuE.kxPM1qm305qmJ6KuIU-9-A" + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83020,10 +87890,66 @@ "description": "A globally unique Id associated with your request.", "type": "string" } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } + } + } + } + } + } + }, + "examples": { + "Invalid Customer request body": { + "errors": [ + { + "type": "invalidRequest", + "message": "Invalid HTTP Body" + } + ] + } } }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83048,76 +87974,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - }, - "details": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the field that caused the error." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "The location of the field that caused the error." - } - } - } - } - } - } - } - } - }, - "examples": { - "Invalid Customer request body": { - "errors": [ - { - "type": "invalidRequest", - "message": "Invalid HTTP Body" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -83189,234 +88046,8 @@ } } }, - "500": { - "description": "Unexpected error.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - internalError\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - } - } - } - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Simulate Network Token Status Update", - "value": { - "state": "SUSPENDED" - } - }, - "example1": { - "summary": "Simulate Network Token Card Metadata Update", - "value": { - "card": { - "last4": "9876", - "expirationMonth": "11", - "expirationYear": "2040" - } - } - }, - "example2": { - "summary": "Simulate Network Token Card Art Update", - "value": { - "metadata": { - "cardArt": { - "combinedAsset": { - "update": "true" - } - } - } - } - } - } - } - }, - "/tms/v2/tokens/{tokenId}/payment-credentials": { - "post": { - "summary": "Generate Payment Credentials for a TMS Token", - "description": "| | | | \n| --- | --- | --- | \n|**Token**
A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.\n", - "parameters": [ - { - "name": "profile-id", - "in": "header", - "description": "The Id of a profile containing user specific TMS configuration.", - "required": false, - "type": "string", - "minLength": 36, - "maxLength": 36, - "x-hide-field": true - }, - { - "name": "tokenId", - "in": "path", - "description": "The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, - { - "name": "postPaymentCredentialsRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "paymentCredentialType": { - "type": "string", - "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested.\nIf \"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.\nIf \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.\n\nPossible Values:\n - NETWORK_TOKEN\n - SECURITY_CODE\n - CRYPTOGRAM\n" - }, - "transactionType": { - "type": "string", - "description": "Specifies the type of transaction for which the network token credentials are required.\nPossible Values:\n - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default.\n - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.\n" - } - } - } - } - ], - "tags": [ - "Token" - ], - "operationId": "postTokenPaymentCredentials", - "x-devcenter-metaData": { - "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-retrieve-pay-cred-intro.html" - }, - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/jose;charset=utf-8" - ], - "responses": { - "201": { - "description": "A base64 encoded JSON Web Encryption (JWE) response containing encrypted Payment Credentials.\n\nExample:\n{\n\"kid\":\"a0eb65d572e556fddb68eb3a4078555605f7b283\",\n\"cty\":\"json\",\n\"typ\":\"JWT\",\n\"enc\":\"A256GCM\",\n\"alg\":\"RSA-OAEP-256\"\n}\n[Encrypted Instrument Identifier Payment Credentials]\n\nThe encrypted Payment Credentials will contain the network token and cryptogram or dynamic CVV.\n", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - }, - "v-c-correlation-id": { - "description": "The mandatory correlation id passed by upstream (calling) system.", - "type": "string" - } - }, - "schema": { - "type": "string", - "example": "eyJraWQiOiJhMGViNjVkNTcyZTU1NmZkZGI2OGViM2E0MDc4NTU1NjA1ZjdiMjgzIiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.o3V2waZn8TQgFXVJItH3EFv9IidsMQ45mskDJyAc6HVvIsT2Pw2blK1BpXv9l6JIU4pqKXzeKPTZTOLUOUoUf7Vr8bliMqCwJuHqq9Nx_qDJrL1MIGV9db8Ssog70-Cz5S6kPzWEWvLB-X8WvUsRfk9EY5Ge8r3BhcLyd-NVsIUKUBADS4-Ovrp2USlLehwVuiqbJzjblfwFCbOwAcDUBP3DGi6oZt8odrBCMV_W-1RH8KAZnS7NzkDgIRzzJoTvPLM4tMF2aSvrQG_GmZndLKeleZNa1voAdk35a2PGAyTc85vb_Eju79vV4C2nlCbxC2yImjumlJ_BZaKhj8q2xA.pWQZef3L3O0SFQtU.tfp2L0Jqqw-c4s9m7e0e8Y7eWAHVOEryLQlL3rLYPmo8OdEUaz-ftm_wpdtsycA5-iRZozDyyas6v6zqbXCMIG_Tg6cBS6cESrnBlgnkELtItv9Zw3UPSNVzoA97T0GxJVPmMkaHUkf0IAd7SXH4Zj5zCCTTDbpIwq4-TaGIxvXd_PJ4L6E1wcqEVaI6sU_PoTWvLJOFLDY_H4pjgVENVuPKVPJZodQxvpLo9L9B0zzOs4YMiv-1ACS_91vYUygBbwZuRnOD6jrW6V0J_nRQik2rCOTwV0B-Mt8nEV0xJpUByScrj91I5HBG1SEVDQPc6RJdNPM7SrPWfEc42Vc9F0oSehCpaIk7QXBCYZez629Li0KhUfqhPa5IJUygH8NB_UgfR5AcyzDr76Kq9Dht8PHPmkJVbPRdyVgkZsMmp_6GQ7Q7r2c3WrHESgbjGgsv4cz8Xui3cqw0Ni0Atozh46Kkd6yOPHC6y6IgdR32020Fs0cwTJnsAAkXy_wX4ScI9ElfpqxF9EshA9l5sHNfCPFbA2eHJUSA0x3vaRCoGCdF4GWq-2zgUEANPwkMNvHsB3E5_4gefqJi8K_nMMfekNGxFabqgkLxpqxXuyJ4cADatuE.kxPM1qm305qmJ6KuIU-9-A" - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - }, - "details": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the field that caused the error." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "The location of the field that caused the error." - } - } - } - } - } - } - } - } - }, - "examples": { - "Invalid Customer request body": { - "errors": [ - { - "type": "invalidRequest", - "message": "Invalid HTTP Body" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", + "410": { + "description": "Token Not Available. The token has been deleted.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83441,7 +88072,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n" + "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" }, "message": { "type": "string", @@ -83457,15 +88088,15 @@ "application/json": { "errors": [ { - "type": "forbidden", - "message": "Request not permitted" + "type": "notAvailable", + "message": "Token not available." } ] } } }, - "404": { - "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "500": { + "description": "Unexpected error.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -83476,54 +88107,15 @@ "type": "string" } }, - "schema": { - "type": "object", - "readOnly": true, - "properties": { - "errors": { - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notFound\n" - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The detailed message related to the type." - } - } - } - } - } - }, "examples": { "application/json": { "errors": [ { - "type": "notFound", - "message": "Token not found" + "type": "serverError", + "message": "Internal server error" } ] } - } - }, - "410": { - "description": "Token Not Available. The token has been deleted.", - "headers": { - "v-c-correlation-id": { - "description": "The mandatory correlation Id passed by upstream (calling) system.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique Id associated with your request.", - "type": "string" - } }, "schema": { "type": "object", @@ -83539,7 +88131,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" + "description": "The type of error.\n\nPossible Values:\n - internalError\n" }, "message": { "type": "string", @@ -83550,19 +88142,9 @@ } } } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notAvailable", - "message": "Token not available." - } - ] - } } }, - "500": { + "502": { "description": "Unexpected error.", "headers": { "v-c-correlation-id": { @@ -83578,8 +88160,8 @@ "application/json": { "errors": [ { - "type": "serverError", - "message": "Internal server error" + "type": "badGateway", + "message": "An unexpected error occurred with network token service, check configuration" } ] } @@ -83622,6 +88204,56 @@ "paymentCredentialType": "CRYPTOGRAM", "transactionType": "AFT" } + }, + "example2": { + "summary": "Generate Network Token Credentials using Visa Payment Passkey (VPP) Authentication", + "value": { + "clientCorrelationId": "", + "transactionType": "ECOM", + "orderInformation": { + "amountDetails": { + "totalAmount": "1765.95", + "currency": "978" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "email": "test@cybs.com", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US" + } + }, + "merchantInformation": { + "merchantDescriptor": { + "name": "TWVyY2hhbnQgVlphRjVYQmo", + "url": "aHR0cHM6Ly93d3cuTWVyY2hhbnQtVlphRjVYQmouY29t" + } + }, + "deviceInformation": { + "platformType": "WEB", + "ipAddress": "127.0.0.1", + "httpAcceptContent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/41.0.2228.0 Safari/537.36", + "httpBrowserLanguage": "en-US", + "httpBrowserJavaEnabled": true, + "httpBrowserJavaScriptEnabled": true, + "httpBrowserColorDepth": "24", + "httpBrowserScreenHeight": "1080", + "httpBrowserScreenWidth": "1920", + "httpBrowserTimeDifference": "-480", + "userAgentBrowserValue": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/41.0.2228.0 Safari/537.36" + }, + "authenticatedIdentities": [ + { + "id": "", + "provider": "VISA_PAYMENT_PASSKEY", + "data": "", + "relyingPartyId": "dnRzLmF1dGgudmlzYS5jb20=" + } + ] + } } } } @@ -83786,7 +88418,7 @@ "items": { "type": "string" }, - "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n- VISA\n- MASTERCARD\n- AMEX\n- CARNET\n- CARTESBANCAIRES\n- CUP\n- DINERSCLUB\n- DISCOVER\n- EFTPOS\n- ELO\n- JCB\n- JCREW\n- MADA\n- MAESTRO\n- MEEZA\n- PAYPAK\n\n**Important:** \n - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request.\n - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n" + "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JAYWAN\n - JCB\n - JCREW\n - KCP\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n - UATP\n\n**Important:** \n - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request.\n - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n" }, "allowedPaymentTypes": { "type": "array", @@ -83844,12 +88476,15 @@ "DISCOVER", "EFTPOS", "ELO", + "JAYWAN", "JCB", "JCREW", + "KCP", "MADA", "MAESTRO", "MEEZA", - "PAYPAK" + "PAYPAK", + "UATP" ], "allowedPaymentTypes": [ "CARD" @@ -85240,6 +89875,10 @@ "type": "string", "description": "Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint\ninformation. The string can contain uppercase and lowercase letters, digits, hyphen (-), and\nunderscore (_). However, do not use the same uppercase and lowercase letters to indicate\ndifferent session IDs.\n\nThe session ID must be unique for each merchant ID. You can use any string that you are already\ngenerating, such as an order number or web session ID.\n\nThe session ID must be unique for each page load, regardless of an individual's web session ID.\nIf a user navigates to a profiled page and is assigned a web session, navigates away from the\nprofiled page, then navigates back to the profiled page, the generated session ID should be different\nand unique. You may use a web session ID, but it is preferable to use an application GUID (Globally\nUnique Identifier). This measure ensures that a unique ID is generated every time the page is\nloaded, even if it is the same user reloading the page.\n" }, + "useRawFingerprintSessionId": { + "type": "boolean", + "description": "Boolean that indicates whether request contains the device fingerprint information.\nValues:\n- `true`: Use raw fingerprintSessionId when looking up device details.\n- `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection.\n" + }, "httpBrowserEmail": { "type": "string", "description": "Email address set in the customer's browser, which may differ from customer email.\n" @@ -95348,6 +99987,21 @@ "type": "string", "maxLength": 1, "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 4, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n#### Possbile values for Barclays processor:\n- 01: Updated/additional information needed\n- 02: Cannot approve at this time; try again later\n- 04: Do not try again\n- 08: Payment blocked by card scheme\n" + } + } } } }, @@ -119801,7 +124455,7 @@ "summary": "Get all merchant defined fields for a given reference type", "operationId": "getMerchantDefinedFieldsDefinitions", "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields", + "categoryTag": "Invoicing", "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/invoicing/developer/all/rest/invoicing/Introduction.html" }, "consumes": [ @@ -119980,10 +124634,10 @@ }, "post": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Create merchant defined field for a given reference type", "operationId": "createMerchantDefinedFieldDefinition", @@ -120406,14 +125060,17 @@ }, "x-example": { "example0": { - "fieldType": "Text", - "label": "Cup", - "customerVisible": "true", - "readOnly": "false", - "textMinLength": 1, - "textMaxLength": 100, - "textDefaultValue": "default text", - "merchantDefinedDataIndex": 15 + "summary": "Create merchant defined field", + "value": { + "fieldType": "Text", + "label": "Cup", + "customerVisible": "true", + "readOnly": "false", + "textMinLength": 1, + "textMaxLength": 100, + "textDefaultValue": "default text", + "merchantDefinedDataIndex": 15 + } } } } @@ -120421,12 +125078,13 @@ "/invoicing/v2/{referenceType}/merchantDefinedFields/{id}": { "put": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Update a MerchantDefinedField by ID", + "operationId": "putMerchantDefinedFieldsDefinitions", "parameters": [ { "in": "path", @@ -120756,25 +125414,29 @@ }, "x-example": { "example0": { - "fieldType": "Text", - "label": "Cup", - "customerVisible": "true", - "readOnly": "false", - "textMinLength": 1, - "textMaxLength": 100, - "textDefaultValue": "default text", - "merchantDefinedDataIndex": 15 + "summary": "Create merchant defined field", + "value": { + "fieldType": "Text", + "label": "Cup", + "customerVisible": "true", + "readOnly": "false", + "textMinLength": 1, + "textMaxLength": 100, + "textDefaultValue": "default text", + "merchantDefinedDataIndex": 15 + } } } }, "delete": { "tags": [ - "merchantDefinedFields" + "Merchant Defined Fields" ], "x-devcenter-metaData": { - "categoryTag": "Merchant_Defined_Fields" + "categoryTag": "Invoicing" }, "summary": "Delete a MerchantDefinedField by ID", + "operationId": "deleteMerchantDefinedFieldsDefinitions", "parameters": [ { "in": "path", @@ -146867,14 +151529,14 @@ "MASTERCARD" ] }, - "description": "The list of card networks you want to use for this Unified Checkout transaction.\n\nUnified Checkout currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JCB\n - JCREW\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n" + "description": "The list of card networks you want to use for this Unified Checkout transaction.\n\nUnified Checkout currently supports the following card networks:\n - VISA\n - MASTERCARD\n - AMEX\n - CARNET\n - CARTESBANCAIRES\n - CUP\n - DINERSCLUB\n - DISCOVER\n - EFTPOS\n - ELO\n - JAYWAN\n - JCB\n - JCREW\n - KCP\n - MADA\n - MAESTRO\n - MEEZA\n - PAYPAK\n - UATP\n" }, "allowedPaymentTypes": { "type": "array", "items": { "type": "string" }, - "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout also supports the following Alternative Payments:\n - AFTERPAY

\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - 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.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" + "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - 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.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" }, "country": { "type": "string", @@ -146954,6 +151616,28 @@ "maxLength": 25, "description": "This field is used to indicate how a payment should be processed.\n\nPossible values:\n- AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.

\n- CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.

\n- PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable.\n" }, + "tms": { + "type": "object", + "description": "Configure Unified Checkout to create a TMS token at the end of the payment journey\n", + "properties": { + "tokenCreate": { + "type": "boolean", + "example": true, + "description": "Use this when you want to create a token from the card/bank data in your payment request. \n\nPossible values:\n - True\n - False

\n" + }, + "tokenTypes": { + "type": "array", + "items": { + "type": "string", + "maxLength": 30, + "example": [ + "CUSTOMER" + ] + }, + "description": "Cybersource tokens types you are performing a create on.\nIf not supplied the default token type for the merchants token vault will be used.\n\nPossible values:\n- Customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n" + } + } + }, "decisionManager": { "type": "boolean", "description": "Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration.\n\nPossible values:\n - True\n - False

\n\nSetting this value to True indicates that device fingerprinting will be executed to add additional information for risk service\nSetting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services.\n" @@ -146964,6 +151648,747 @@ } } }, + "transientTokenResponseOptions": { + "type": "object", + "properties": { + "includeCardPrefix": { + "type": "boolean", + "description": "Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.\n\nPossible values:\n- True\n- False

\n\nTo select the type of card number prefix:\n- No field included: A 6-digit prefix is returned (default)\n- True: An 8-digit prefix is returned\n- False: No prefix is returned

\n\nThe following conditions apply:\n- 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more.\n- Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.

\n\n**Important:** \nIf your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure.\n" + } + } + }, + "data": { + "type": "object", + "properties": { + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "example": 21, + "description": "This field defines the total order amount.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "description": "This field defines the currency applicable to the order.\n" + }, + "surcharge": { + "type": "object", + "properties": { + "amount": { + "type": "string", + "example": 2.5, + "description": "This field defines the surcharge amount applicable to the order.\n" + } + } + }, + "discountAmount": { + "type": "string", + "example": 2, + "description": "This field defines the discount amount applicable to the order.\n" + }, + "subTotalAmount": { + "type": "string", + "example": 5, + "description": "This field defines the sub total amount applicable to the order.\n" + }, + "serviceFeeAmount": { + "type": "string", + "example": 5, + "description": "This field defines the service fee amount applicable to the order.\n" + }, + "taxAmount": { + "type": "string", + "example": 10, + "description": "This field defines the tax amount applicable to the order.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "example": "277 Park Avenue", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "example": "50th Floor", + "maxLength": 60, + "description": "Used for additional address information. For example: _Attention: Accounts Payable_\nOptional field.\n" + }, + "address3": { + "type": "string", + "example": "Desk NY-50110", + "maxLength": 60, + "description": "Additional address information (third line of the billing address)" + }, + "address4": { + "type": "string", + "example": "address4", + "maxLength": 60, + "description": "Additional address information (fourth line of the billing address)\n" + }, + "administrativeArea": { + "type": "string", + "example": "NY", + "maxLength": 20, + "description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n" + }, + "buildingNumber": { + "type": "string", + "example": "buildingNumber", + "maxLength": 256, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "US", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n" + }, + "district": { + "type": "string", + "example": "district", + "maxLength": 50, + "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n" + }, + "locality": { + "type": "string", + "example": "New York", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "postalCode": { + "type": "string", + "example": 10172, + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Visa Inc", + "maxLength": 60, + "description": "Name of the customer's company." + }, + "address1": { + "type": "string", + "example": "277 Park Avenue", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "example": "50th Floor", + "maxLength": 60, + "description": "Used for additional address information. For example: _Attention: Accounts Payable_\nOptional field.\n" + }, + "address3": { + "type": "string", + "example": "Desk NY-50110", + "maxLength": 60, + "description": "Additional address information (third line of the billing address)" + }, + "address4": { + "type": "string", + "example": "address4", + "maxLength": 60, + "description": "Additional address information (fourth line of the billing address)\n" + }, + "administrativeArea": { + "type": "string", + "example": "NY", + "maxLength": 20, + "description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n" + }, + "buildingNumber": { + "type": "string", + "example": "buildingNumber", + "maxLength": 256, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "US", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n" + }, + "district": { + "type": "string", + "example": "district", + "maxLength": 50, + "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n" + }, + "locality": { + "type": "string", + "example": "New York", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "postalCode": { + "type": "string", + "example": 10172, + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n" + } + } + }, + "email": { + "type": "string", + "example": "john.doe@visa.com", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card" + }, + "lastName": { + "type": "string", + "example": "Doe", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "middleName": { + "type": "string", + "example": "F", + "maxLength": 60, + "description": "Customer's middle name.\n" + }, + "nameSuffix": { + "type": "string", + "example": "Jr", + "maxLength": 60, + "description": "Customer's name suffix.\n" + }, + "title": { + "type": "string", + "example": "Mr", + "maxLength": 60, + "description": "Title.\n" + }, + "phoneNumber": { + "type": "string", + "example": 1234567890, + "description": "Customer's phone number.\n" + }, + "phoneType": { + "type": "string", + "example": "phoneType", + "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "example": "Victoria House", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "address3": { + "type": "string", + "example": "15-17 Gloucester Street", + "description": "Third line of the shipping address.\n" + }, + "address4": { + "type": "string", + "example": "string", + "maxLength": 60, + "description": "Fourth line of the shipping address." + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 2, + "description": "State or province of the shipping address.\n\nUse the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf)\n" + }, + "buildingNumber": { + "type": "string", + "example": "string", + "maxLength": 15, + "description": "Building number in the street address.\n" + }, + "country": { + "type": "string", + "example": "GB", + "description": "Country of the shipping address.\n\nUse the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n" + }, + "district": { + "type": "string", + "example": "string", + "maxLength": 50, + "description": "Neighborhood, community, or region within a city or municipality." + }, + "locality": { + "type": "string", + "example": "Belfast", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "postalCode": { + "type": "string", + "example": "BT1 4LS", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n" + }, + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "First name of the recipient" + }, + "lastName": { + "type": "string", + "example": "Doe", + "maxLength": 60, + "description": "Last name of the recipient." + } + } + }, + "lineItems": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "example": "electronics" + }, + "productName": { + "type": "string", + "maxLength": 255, + "example": "smartphone" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "example": "SKU12345" + }, + "quantity": { + "type": "integer", + "minimum": 1, + "maximum": 999999999, + "default": 1, + "example": 2 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "example": "399.99" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "example": "EA" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "example": "799.98" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "example": "64.00" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "example": "0.88" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "example": "Y" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "example": "N" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "example": "VAT" + }, + "amountIncludesTax": { + "type": "boolean", + "example": false + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "example": "GS" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "example": "123456" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "example": "10.00" + }, + "discountApplied": { + "type": "boolean", + "example": true + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "example": "0.05" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "example": "INV-001" + }, + "taxDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "VAT" + }, + "amount": { + "type": "string", + "maxLength": 13, + "example": 5.99 + }, + "rate": { + "type": "string", + "maxLength": 6, + "example": 20 + }, + "code": { + "type": "string", + "maxLength": 4, + "example": "VAT" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "example": "TAXID12345" + }, + "applied": { + "type": "boolean", + "example": true + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "example": "E" + } + } + }, + "fulfillmentType": { + "type": "string", + "example": "Delivery" + }, + "weight": { + "type": "string", + "maxLength": 9, + "example": "1.5" + }, + "weightIdentifier": { + "type": "string", + "maxLength": 1, + "example": "N" + }, + "weightUnit": { + "type": "string", + "maxLength": 2, + "example": "KG" + }, + "referenceDataCode": { + "type": "string", + "maxLength": 150, + "example": "REFCODE" + }, + "referenceDataNumber": { + "type": "string", + "maxLength": 30, + "example": "REF123" + }, + "unitTaxAmount": { + "type": "string", + "maxLength": 15, + "example": "3.20" + }, + "productDescription": { + "type": "string", + "maxLength": 30, + "example": "Latest model smartphone" + }, + "giftCardCurrency": { + "type": "string", + "maxLength": 3, + "example": "USD" + }, + "shippingDestinationTypes": { + "type": "string", + "maxLength": 50, + "example": "Residential" + }, + "gift": { + "type": "boolean", + "example": false + }, + "passenger": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 50, + "example": "Residential" + }, + "status": { + "type": "string", + "maxLength": 32, + "example": "Gold" + }, + "phone": { + "type": "string", + "maxLength": 15, + "example": "123456789" + }, + "firstName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "example": "Doe" + }, + "id": { + "type": "string", + "maxLength": 40, + "example": "AIR1234567" + }, + "email": { + "type": "string", + "maxLength": 50, + "example": "john.doe@example.com" + }, + "nationality": { + "type": "string", + "maxLength": 2, + "example": "US" + } + } + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "personalIdentification": { + "type": "object", + "properties": { + "cpf": { + "type": "string", + "minLength": 11, + "maxLength": 11, + "example": "12345678900" + } + } + }, + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "example": "M123456767" + }, + "companyTaxId": { + "type": "string", + "maxLength": 9, + "example": "" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "example": "TC50171_3" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "example": "DEV12345" + }, + "SolutionId": { + "type": "string", + "maxLength": 8, + "example": "SOL1234" + } + } + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "challengeCode": { + "type": "string", + "maxLength": 2, + "example": "01" + }, + "messageCategory": { + "type": "string", + "maxLength": 2, + "example": "01" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 22, + "example": "Euro Electronics", + "description": "The name of the merchant" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "reconciliationId": { + "type": "string", + "maxLength": 60, + "example": "01234567" + }, + "authorizationOptions": { + "type": "object", + "properties": { + "aftIndicator": { + "type": "boolean", + "example": true + }, + "initiator": { + "type": "object", + "properties": { + "credentialStoredOnFile": { + "type": "boolean", + "example": true + }, + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 1, + "example": 1 + } + } + } + } + }, + "businessApplicationId": { + "type": "string", + "maxLength": 2, + "example": "AA" + } + } + } + } + }, + "recipientInformation": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "middleName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "example": "John" + }, + "country": { + "type": "string", + "maxLength": 2, + "example": "GB", + "description": "The country code of the recipient's country" + }, + "accountId": { + "type": "string", + "maxLength": 10, + "example": "2342312", + "description": "The account ID of the recipient" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "example": "Devon", + "description": "The administrative area of the recipient" + }, + "accountType": { + "type": "string", + "maxLength": 2, + "example": "Checking", + "description": "The account type of the recipient" + } + } + }, + "merchantDefinedInformation": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The key or identifier for the merchant-defined data field" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value associated with the merchant-defined data field" + } + } + } + } + }, "orderInformation": { "type": "object", "properties": { @@ -147240,15 +152665,6 @@ } } } - }, - "transientTokenResponseOptions": { - "type": "object", - "properties": { - "includeCardPrefix": { - "type": "boolean", - "description": "Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix.\n\nPossible values:\n- True\n- False

\n\nTo select the type of card number prefix:\n- No field included: A 6-digit prefix is returned (default)\n- True: An 8-digit prefix is returned\n- False: No prefix is returned

\n\nThe following conditions apply:\n- 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more.\n- Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true.\n- If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.

\n\n**Important:** \nIf your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure.\n" - } - } } } } @@ -147258,7 +152674,7 @@ "example0": { "summary": "Generate Unified Checkout Capture Context", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147304,7 +152720,7 @@ "example1": { "summary": "Generate Unified Checkout Capture Context With Full List of Card Networks", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147312,19 +152728,22 @@ "VISA", "MASTERCARD", "AMEX", - "CARTESBANCAIRES", "CARNET", + "CARTESBANCAIRES", "CUP", "DINERSCLUB", "DISCOVER", "EFTPOS", "ELO", + "JAYWAN", "JCB", "JCREW", + "KCP", "MADA", "MAESTRO", "MEEZA", - "PAYPAK" + "PAYPAK", + "UATP" ], "allowedPaymentTypes": [ "APPLEPAY", @@ -147352,10 +152771,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147363,7 +152784,7 @@ "example2": { "summary": "Generate Unified Checkout Capture Context With Custom Google Payment Options", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147406,10 +152827,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147417,7 +152840,7 @@ "example3": { "summary": "Generate Unified Checkout Capture Context With Autocheck Enrollment", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147454,10 +152877,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147465,7 +152890,7 @@ "example4": { "summary": "Generate Unified Checkout Capture Context (Opt-out of receiving card number prefix)", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147500,10 +152925,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } }, "transientTokenResponseOptions": { @@ -147514,7 +152941,7 @@ "example5": { "summary": "Generate Unified Checkout Capture Context passing Billing & Shipping", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147549,57 +152976,59 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" - }, - "billTo": { - "address1": "277 Park Avenue", - "address2": "50th Floor", - "address3": "Desk NY-50110", - "address4": "address4", - "administrativeArea": "NY", - "buildingNumber": "buildingNumber", - "country": "US", - "district": "district", - "locality": "New York", - "postalCode": "10172", - "company": { - "name": "Visa Inc", - "address1": "900 Metro Center Blvd", - "address2": "address2", - "address3": "address3", + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + }, + "billTo": { + "address1": "277 Park Avenue", + "address2": "50th Floor", + "address3": "Desk NY-50110", "address4": "address4", - "administrativeArea": "CA", - "buildingNumber": "1", + "administrativeArea": "NY", + "buildingNumber": "buildingNumber", "country": "US", "district": "district", - "locality": "Foster City", - "postalCode": "94404" + "locality": "New York", + "postalCode": "10172", + "company": { + "name": "Visa Inc", + "address1": "900 Metro Center Blvd", + "address2": "address2", + "address3": "address3", + "address4": "address4", + "administrativeArea": "CA", + "buildingNumber": "1", + "country": "US", + "district": "district", + "locality": "Foster City", + "postalCode": "94404" + }, + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "middleName": "F", + "nameSuffix": "Jr", + "title": "Mr", + "phoneNumber": "1234567890", + "phoneType": "phoneType" }, - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "middleName": "F", - "nameSuffix": "Jr", - "title": "Mr", - "phoneNumber": "1234567890", - "phoneType": "phoneType" - }, - "shipTo": { - "address1": "CyberSource", - "address2": "Victoria House", - "address3": "15-17 Gloucester Street", - "address4": "string", - "administrativeArea": "CA", - "buildingNumber": "string", - "country": "GB", - "district": "string", - "locality": "Belfast", - "postalCode": "BT1 4LS", - "firstName": "Joe", - "lastName": "Soap" + "shipTo": { + "address1": "CyberSource", + "address2": "Victoria House", + "address3": "15-17 Gloucester Street", + "address4": "string", + "administrativeArea": "CA", + "buildingNumber": "string", + "country": "GB", + "district": "string", + "locality": "Belfast", + "postalCode": "BT1 4LS", + "firstName": "Joe", + "lastName": "Soap" + } } } } @@ -147607,7 +153036,7 @@ "example6": { "summary": "Generate Unified Checkout Capture Context For Click To Pay Drop-In UI", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147632,10 +153061,12 @@ ], "showAcceptedNetworkIcons": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -147643,7 +153074,7 @@ "example7": { "summary": "Generate Unified Checkout Capture Context ($ Afterpay (US))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147679,31 +153110,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Galleria Road", - "administrativeArea": "TX", - "buildingNumber": 2, - "country": "US", - "locality": "Houston", - "postalCode": "22096" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 4N3" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Galleria Road", + "administrativeArea": "TX", + "buildingNumber": 2, + "country": "US", + "locality": "Houston", + "postalCode": "22096" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 4N3" + } } } }, @@ -147712,7 +153145,7 @@ "example8": { "summary": "Generate Unified Checkout Capture Context (Afterpay (CAN))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147748,31 +153181,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "CAD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Galleria Road", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 4N3" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "AL", - "buildingNumber": 2, - "country": "CA", - "locality": "Calgary", - "postalCode": "T2B 543" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "CAD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Galleria Road", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 4N3" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "AL", + "buildingNumber": 2, + "country": "CA", + "locality": "Calgary", + "postalCode": "T2B 543" + } } } }, @@ -147781,7 +153216,7 @@ "example9": { "summary": "Generate Unified Checkout Capture Context (Clearpay (GB))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147819,31 +153254,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "GBP" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Square Street", - "administrativeArea": "Devon", - "buildingNumber": 2, - "country": "GB", - "locality": "Plymouth", - "postalCode": "PL1 1AS" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "GBP" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Square Street", + "administrativeArea": "Devon", + "buildingNumber": 2, + "country": "GB", + "locality": "Plymouth", + "postalCode": "PL1 1AS" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -147852,7 +153289,7 @@ "example10": { "summary": "Generate Unified Checkout Capture Context (Afterpay (AU))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147888,31 +153325,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "AUD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Ocean Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Springtown Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "AUD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Ocean Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Springtown Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + } } } }, @@ -147921,7 +153360,7 @@ "example11": { "summary": "Generate Unified Checkout Capture Context (Afterpay (NZ))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -147957,31 +153396,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "NZD" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "277 Maranui Avenue", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "NZ", - "locality": "Auckland", - "postalCode": "1022" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Springtown Road", - "administrativeArea": "NSW", - "buildingNumber": 2, - "country": "AU", - "locality": "Sydney", - "postalCode": "2000" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "NZD" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Maranui Avenue", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "NZ", + "locality": "Auckland", + "postalCode": "1022" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Springtown Road", + "administrativeArea": "NSW", + "buildingNumber": 2, + "country": "AU", + "locality": "Sydney", + "postalCode": "2000" + } } } }, @@ -147990,7 +153431,7 @@ "example12": { "summary": "Generate Unified Checkout Capture Context (iDEAL (NL))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148026,31 +153467,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Stationsstraat 12", - "administrativeArea": "NL-NH", - "buildingNumber": 2, - "country": "NL", - "locality": "Amsterdam", - "postalCode": "1071 JA" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Stationsstraat 12", + "administrativeArea": "NL-NH", + "buildingNumber": 2, + "country": "NL", + "locality": "Amsterdam", + "postalCode": "1071 JA" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -148059,7 +153502,7 @@ "example13": { "summary": "Generate Unified Checkout Capture Context (Multibanco (PT))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148096,31 +153539,33 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Rua da Liberdade 10", - "administrativeArea": "Mafra", - "buildingNumber": 2, - "country": "PT", - "locality": "Lisboa", - "postalCode": "1234-567" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Rua da Liberdade 10", + "administrativeArea": "Mafra", + "buildingNumber": 2, + "country": "PT", + "locality": "Lisboa", + "postalCode": "1234-567" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -148129,7 +153574,7 @@ "example14": { "summary": "Generate Unified Checkout Capture Context (Przelewy24|P24 (PL))", "value": { - "clientVersion": "0.30", + "clientVersion": "0.31", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -148166,31 +153611,103 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "EUR" - }, - "billTo": { - "email": "john.doe@visa.com", - "firstName": "John", - "lastName": "Doe", - "address1": "Ulica Podhalanska 2", - "administrativeArea": "Wroclaw", - "buildingNumber": 2, - "country": "PL", - "locality": "Gdansk", - "postalCode": "80-322" - }, - "shipTo": { - "firstName": "Joe", - "lastName": "Sims", - "address1": "15-17 Gloucester Street", - "administrativeArea": "NIR", - "buildingNumber": 2, - "country": "GB", - "locality": "Belfast", - "postalCode": "BT6 8JW" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "Ulica Podhalanska 2", + "administrativeArea": "Wroclaw", + "buildingNumber": 2, + "country": "PL", + "locality": "Gdansk", + "postalCode": "80-322" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example15": { + "summary": "Generate Unified Checkout Capture Context (Tink Pay By Bank (GB))", + "value": { + "clientVersion": "0.31", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "TINKPAYBYBANK" + ], + "country": "GB", + "locale": "en-GB", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "GB" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "GBP" + }, + "billTo": { + "email": "john.doe@visa.com", + "firstName": "John", + "lastName": "Doe", + "address1": "277 Square Street", + "administrativeArea": "Devon", + "buildingNumber": 2, + "country": "GB", + "locality": "Plymouth", + "postalCode": "PL1 1AS" + }, + "shipTo": { + "firstName": "Joe", + "lastName": "Sims", + "address1": "15-17 Gloucester Street", + "administrativeArea": "NIR", + "buildingNumber": 2, + "country": "GB", + "locality": "Belfast", + "postalCode": "BT6 8JW" + } } } }, @@ -150118,6 +155635,816 @@ } } } + }, + "/vas/v1/currencyconversion": { + "post": { + "summary": "Create an Offer", + "description": "Creates an offer record on the provider system.\n", + "tags": [ + "Offers" + ], + "operationId": "createOffer", + "x-devcenter-metaData": { + "categoryTag": "Currency_Conversion" + }, + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "x-requestid", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-merchant-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-correlation-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-organization-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "offerRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + }, + "applicationName": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource." + }, + "applicationVersion": { + "type": "string", + "maxLength": 50, + "x-nullable": true, + "description": "Version of the CyberSource application or integration used for a transaction." + }, + "applicationUser": { + "type": "string", + "maxLength": 60, + "x-nullable": true, + "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method." + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "x-nullable": true, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "x-nullable": true, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 11, + "x-nullable": true, + "description": "First 11 digits of the card number for which an offer is being sought. Mandatory when type=DCC." + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "x-nullable": true, + "description": "The amount of the sale in the merchant's currency. Mandatory when type=DCC, optional otherwise. This value cannot be negative. You can include a decimal point (.), but no other special characters." + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "x-nullable": true, + "description": "Original currency of the transaction in the merchant's currency. Mandatory when type=DCC, optional otherwise.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + } + } + }, + "currencyConversion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "default": "DCC", + "x-nullable": true, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "terminalId": { + "type": "string", + "maxLength": 16, + "x-nullable": true, + "description": "Identifier for the terminal used by the merchant's to process the transaction." + }, + "entryMode": { + "type": "string", + "maxLength": 30, + "x-nullable": true, + "description": "Valid Values:\n- 'KEYED'\n- 'SWIPED'\n- 'CONTACT'\n- 'CONTACTLESS'\n\nHow the transaction information was captured. Optional. `KEYED` can refer to MOTO on a terminal, MOTO on a virtual terminal, or eCommerce. All other options refer to card holder present transactions. Optional.\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909", + "partner": { + "developerId": "123456", + "solutionId": "123456" + }, + "applicationName": "REST API", + "applicationVersion": "1.23.44", + "applicationUser": "Bob" + }, + "paymentInformation": { + "card": { + "number": "41111111111" + } + }, + "orderInformation": { + "amountDetails": { + "originalAmount": "100.00", + "originalCurrency": "GBP" + }, + "currencyConversion": { + "type": "DCC" + } + }, + "pointOfSaleInformation": { + "terminalId": "12345678", + "entryMode": "CONTACT" + } + } + } + } + ], + "responses": { + "201": { + "description": "Request OK.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "maxLength": 18, + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- PENDING\n- DECLINED\n- SERVER_ERROR" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 30, + "description": "Only required when offer cannot be made. The reason of the status.\n\nPossible values:\n- 'INVALID_MERCHANT_CONFIGURATION'\n- 'NOT_ELIGIBLE'\n- 'CURRENCY_NOT_CONFIGURED'\n- 'BIN_UNKNOWN'\n- 'CURRENCY_MATCH'\n- 'CURRENCY_NOT_ALLOWED'\n- 'LOOKUP_FAILED'\n- 'EXCHANGE_RATE_NOT_FOUND'\n- 'CARD_TYPE_NOT_ACCEPTED'\n- 'INVALID_AMOUNT'\n- 'INVALID_CARD'\n- 'INVALID_CURRENCY'\n- 'INVALID_TERMINAL'\n- 'INVALID_ACQUIRER'\n- 'SERVICE_DISABLED'\n- 'DUPLICATE_REQUEST'\n- 'UNKNOWN'\n- 'PROCESSOR_ERROR'\n" + }, + "message": { + "type": "string", + "maxLength": 256, + "description": "Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "currencyConversion": { + "type": "object", + "required": [ + "reconciliationId" + ], + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\nThis should be echo'd from the request\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Unique identifier generated by the DCC provider." + }, + "offer": { + "type": "array", + "description": "When type is DCC this is a single item.\nWhen type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant.\n", + "items": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "description": "The amount of the sale in the merchant's currency. \nFor DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the transaction in the merchant's currency. \nFor DCC this should be the same value as the request. \nFor MCP will be the merchant's base currency as configured on the currency conversion provider's system.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "amount": { + "type": "string", + "maxLength": 15, + "description": "The offer amount, calculated using the originalAmount and the exchangeRate.\nFor DCC this is the amount in the card issuer's currency.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the offer. For DCC this is the card's issuers currency.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "The exchange rate of the offer from 1 major unit of the sale currency including margin.\nThis will be printed on the receipt.\nFor example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up.\nThe receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field.\n" + }, + "exchangeRateInverted": { + "type": "boolean", + "example": true, + "description": "An inverted exchange rate is the base currency amount divided by the converted currency amount.\nEx. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR.\n" + }, + "marginRate": { + "type": "string", + "maxLength": 8, + "description": "The margin between the offer exchange rate and wholesale rates, i.e. the mark up.\nExpressed as a percentage of 100, e.g. 3.75\n" + }, + "rateSource": { + "type": "string", + "maxLength": 50, + "description": "The source of the rate (excluding mark up). Optional field.\n" + }, + "exchangeRateTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "exchangeRateExpirationTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n" + }, + "rateId": { + "type": "string", + "maxLength": 36, + "description": "A unique MCP rate identifier.\n" + } + } + } + }, + "disclaimer": { + "type": "string", + "maxLength": 1024, + "description": "This text is intended to inform customers about their opt-in choices. It should include details such \nas the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as \nthe mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency \nConversion) and optional otherwise. This information will be displayed on the screen and printed on \nthe receipt without modification.\n" + } + } + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "The error message sent directly from the currency conversion provider. Returned only when the provider returns this value.\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909" + }, + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "DECLINED", + "errorInformation": { + "reason": "INVALID_MERCHANT_CONFIGURATION", + "message": "Only required when valid request cannot be fulfilled" + }, + "orderInformation": { + "currencyConversion": { + "type": "DCC", + "reconciliationId": "ABC123", + "offer": [ + { + "originalAmount": "100.00", + "originalCurrency": "GBP", + "amount": "123.21", + "currency": "EUR", + "exchangeRate": "0.8116", + "marginRate": "3.75", + "rateSource": "European Central Bank", + "exchangeRateTimeUtc": "2023-05-17T23:47:57Z", + "exchangeRateExpirationTimeUtc": "2024-05-18T22:47:57Z", + "exchangeRateInverted": true, + "rateId": "009F303309AF07234520190628143445" + } + ], + "disclaimer": "I accept I have been offered a choice of currencies for payment. I accept the conversion rate and sale amount and that the selected currency is EUR. I acknowledge I had a choice to pay in GBP. Currency Conversion for this transaction is offered by the Merchant and is based on the reference rate of the currency conversion provider. Mark up on reference rate: 3.7500." + } + } + } + } + }, + "400": { + "description": "Bad Request Data, e.g. missing field, field containing invalid data.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- INVALID_REQUEST" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n \nPossible values:\n- MISSING_FIELD\n- INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Descriptive message to add more detail to the status\n" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n- MISSING_FIELD\n- INVALID_DATA\n" + } + } + } + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "INVALID_REQUEST", + "reason": "MISSING_FIELD", + "message": "string", + "details": [ + { + "field": "paymentInformation.card.number", + "reason": "MISSING_FIELD" + } + ] + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- SERVER_ERROR" + }, + "reason": { + "type": "string", + "description": "Only required when offer cannot be made.\nThe reason of the status. Only required when the requested action cannot be performed cannot be made.\n\nPossible values:\n- SYSTEM_ERROR\n- SERVER_TIMEOUT\n- SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above.\n" + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "SERVER_ERROR", + "reason": "SYSTEM_ERROR", + "message": "string" + } + } + } + } + } + }, + "/vas/v1/currencyconversion/{id}": { + "get": { + "summary": "Retrieve an Offer", + "description": "Retrieves an offer record from the system.\n", + "tags": [ + "Offers" + ], + "operationId": "getOffer", + "x-devcenter-metaData": { + "categoryTag": "Currency_Conversion" + }, + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "x-requestid", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-merchant-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-correlation-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "v-c-organization-id", + "in": "header", + "type": "string", + "required": true + }, + { + "name": "id", + "in": "path", + "description": "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id", + "required": true, + "type": "string", + "maxLength": 26 + } + ], + "responses": { + "200": { + "description": "Request OK.", + "schema": { + "type": "object", + "required": [ + "id", + "submitTimeUtc", + "status" + ], + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Merchant-generated order reference or tracking number. \nIt is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" + }, + "applicationName": { + "type": "string", + "maxLength": 50, + "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource." + }, + "applicationVersion": { + "type": "string", + "maxLength": 50, + "description": "Version of the CyberSource application or integration used for a transaction." + }, + "applicationUser": { + "type": "string", + "maxLength": 60, + "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method." + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "maxLength": 18, + "description": "Message describing the status of the currency conversion request.\n\nValues:\n- `PENDING`\n- `DECLINED`\n- `INVALID_REQUEST`\n- `SERVER_ERROR`\n- `OFFER_DECLINED`\n- `AUTHORIZED`\n- `AUTHORIZATION_DECLINED`\n- `AUTHORIZATION_FAILURE`\n- `REVERSED`\n- `CAPTURED`\n- `REFUNDED`\n- `CANCELLED`\n" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 30, + "description": "Only required when offer cannot be made. The reason of the status.\n\nPossible values:\n- 'INVALID_MERCHANT_CONFIGURATION'\n- 'NOT_ELIGIBLE'\n- 'CURRENCY_NOT_CONFIGURED'\n- 'BIN_UNKNOWN'\n- 'CURRENCY_MATCH'\n- 'CURRENCY_NOT_ALLOWED'\n- 'LOOKUP_FAILED'\n- 'EXCHANGE_RATE_NOT_FOUND'\n- 'CARD_TYPE_NOT_ACCEPTED'\n- 'INVALID_AMOUNT'\n- 'INVALID_CARD'\n- 'INVALID_CURRENCY'\n- 'INVALID_TERMINAL'\n- 'INVALID_ACQUIRER'\n- 'SERVICE_DISABLED'\n- 'DUPLICATE_REQUEST'\n- 'UNKNOWN'\n- 'PROCESSOR_ERROR'\n" + }, + "message": { + "type": "string", + "maxLength": 256, + "description": "Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "currencyConversion": { + "type": "object", + "required": [ + "reconciliationId" + ], + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "Valid Values:\n- `DCC`: Dynamic Currency Conversion\n- `MCP`: Multi-Currency Pricing\nThis should be echo'd from the request\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Unique identifier generated by the DCC provider." + }, + "offer": { + "type": "array", + "description": "When type is DCC this is a single item.\nWhen type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant.\n", + "items": { + "type": "object", + "properties": { + "originalAmount": { + "type": "string", + "maxLength": 15, + "description": "The amount of the sale in the merchant's currency. \nFor DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the transaction in the merchant's currency. \nFor DCC this should be the same value as the request. \nFor MCP will be the merchant's base currency as configured on the currency conversion provider's system.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "amount": { + "type": "string", + "maxLength": 15, + "description": "The offer amount, calculated using the originalAmount and the exchangeRate.\nFor DCC this is the amount in the card issuer's currency.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency of the offer. For DCC this is the card's issuers currency.\nUse three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "The exchange rate of the offer from 1 major unit of the sale currency including margin.\nThis will be printed on the receipt.\nFor example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up.\nThe receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field.\n" + }, + "exchangeRateInverted": { + "type": "boolean", + "example": true, + "description": "An inverted exchange rate is the base currency amount divided by the converted currency amount.\nEx. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR.\n" + }, + "marginRate": { + "type": "string", + "maxLength": 8, + "description": "The margin between the offer exchange rate and wholesale rates, i.e. the mark up.\nExpressed as a percentage of 100, e.g. 3.75\n" + }, + "rateSource": { + "type": "string", + "maxLength": 50, + "description": "The source of the rate (excluding mark up). Optional field.\n" + }, + "exchangeRateTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "exchangeRateExpirationTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n" + }, + "rateId": { + "type": "string", + "maxLength": 36, + "description": "A unique MCP rate identifier.\n" + } + } + } + }, + "disclaimer": { + "type": "string", + "maxLength": 1024, + "description": "This text is intended to inform customers about their opt-in choices. It should include details such \nas the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as \nthe mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency \nConversion) and optional otherwise. This information will be displayed on the screen and printed on \nthe receipt without modification.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "REF-101-GBP-909", + "partner": { + "developerId": "123456", + "solutionId": "123456" + }, + "applicationName": "REST API", + "applicationVersion": "1.23.44", + "applicationUser": "Bob" + }, + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "OFFER_PENDING", + "errorInformation": { + "reason": "INVALID_MERCHANT_CONFIGURATION", + "message": "Only required when valid request cannot be fulfilled" + }, + "orderInformation": { + "currencyConversion": { + "type": "DCC", + "reconciliationId": "ABC123" + }, + "offer": [ + { + "originalAmount": "100.00", + "originalCurrency": "GBP", + "amount": "123.21", + "currency": "EUR", + "exchangeRate": "0.8116", + "marginRate": "3.75", + "rateSource": "European Central Bank", + "disclaimer": "I accept I have been offered a choice of currencies for payment. I accept the conversion rate and sale amount and that the selected currency is EUR. I acknowledge I had a choice to pay in GBP. Currency Conversion for this transaction is offered by the Merchant and is based on the reference rate of the currency conversion provider. Mark up on reference rate: 3.7500.", + "exchangeRateTimeUtc": "2023-05-17T23:47:57Z", + "exchangeRateExpirationTimeUtc": "2024-05-18T22:47:57Z", + "exchangeRateInverted": true, + "rateId": "009F303309AF07234520190628143445" + } + ] + } + } + } + }, + "404": { + "description": "Offer not found.", + "schema": { + "description": "Currency conversion offer not found" + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "Request ID generated by Cybersource. This was sent in the header on the request.\nEcho value from x-requestid\n" + }, + "submitTimeUtc": { + "type": "string", + "maxLength": 20, + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n\n**Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Message describing the status of the currency conversion request.\n \nPossible values:\n- SERVER_ERROR" + }, + "reason": { + "type": "string", + "description": "Only required when offer cannot be made.\nThe reason of the status. Only required when the requested action cannot be performed cannot be made.\n\nPossible values:\n- SYSTEM_ERROR\n- SERVER_TIMEOUT\n- SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above.\n" + } + }, + "example": { + "id": "6843379070056369304008", + "submitTimeUtc": "2023-05-17T22:47:57Z", + "status": "SERVER_ERROR", + "reason": "SYSTEM_ERROR", + "message": "string" + } + } + } + } + } } } } \ No newline at end of file diff --git a/src/main/java/Api/MerchantDefinedFieldsApi.java b/src/main/java/Api/MerchantDefinedFieldsApi.java index 955d7db72..17d36a5a9 100644 --- a/src/main/java/Api/MerchantDefinedFieldsApi.java +++ b/src/main/java/Api/MerchantDefinedFieldsApi.java @@ -225,24 +225,25 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don return call; } /** - * Build call for getMerchantDefinedFieldsDefinitions - * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) + * Build call for deleteMerchantDefinedFieldsDefinitions + * @param referenceType (required) + * @param id (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call getMerchantDefinedFieldsDefinitionsCall(String referenceType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + public okhttp3.Call deleteMerchantDefinedFieldsDefinitionsCall(String referenceType, Long id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { SdkTracker sdkTracker = new SdkTracker(); Object localVarPostBody = null; - if ("GET".equalsIgnoreCase("POST")) { + if ("DELETE".equalsIgnoreCase("POST")) { localVarPostBody = "{}"; } String inboundMLEStatus = "false"; - if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "getMerchantDefinedFieldsDefinitions,getMerchantDefinedFieldsDefinitionsAsync,getMerchantDefinedFieldsDefinitionsWithHttpInfo,getMerchantDefinedFieldsDefinitionsCall")) { + if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "deleteMerchantDefinedFieldsDefinitions,deleteMerchantDefinedFieldsDefinitionsAsync,deleteMerchantDefinedFieldsDefinitionsWithHttpInfo,deleteMerchantDefinedFieldsDefinitionsCall")) { try { localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); } catch (MLEException e) { @@ -252,8 +253,9 @@ public okhttp3.Call getMerchantDefinedFieldsDefinitionsCall(String referenceType } // create path and map variables - String localVarPath = "/invoicing/v2/{referenceType}/merchantDefinedFields" - .replaceAll("\\{" + "referenceType" + "\\}", apiClient.escapeString(referenceType.toString())); + String localVarPath = "/invoicing/v2/{referenceType}/merchantDefinedFields/{id}" + .replaceAll("\\{" + "referenceType" + "\\}", apiClient.escapeString(referenceType.toString())) + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); List localVarQueryParams = new ArrayList(); @@ -262,13 +264,13 @@ public okhttp3.Call getMerchantDefinedFieldsDefinitionsCall(String referenceType Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" + "application/hal+json;charset=utf-8" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); final String[] localVarContentTypes = { - "application/json" + "application/json;charset=utf-8" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); @@ -286,20 +288,26 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private okhttp3.Call getMerchantDefinedFieldsDefinitionsValidateBeforeCall(String referenceType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + private okhttp3.Call deleteMerchantDefinedFieldsDefinitionsValidateBeforeCall(String referenceType, Long id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { // verify the required parameter 'referenceType' is set if (referenceType == null) { - logger.error("Missing the required parameter 'referenceType' when calling getMerchantDefinedFieldsDefinitions(Async)"); - throw new ApiException("Missing the required parameter 'referenceType' when calling getMerchantDefinedFieldsDefinitions(Async)"); + logger.error("Missing the required parameter 'referenceType' when calling deleteMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'referenceType' when calling deleteMerchantDefinedFieldsDefinitions(Async)"); } + // verify the required parameter 'id' is set + if (id == null) { + logger.error("Missing the required parameter 'id' when calling deleteMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'id' when calling deleteMerchantDefinedFieldsDefinitions(Async)"); + } - okhttp3.Call call = getMerchantDefinedFieldsDefinitionsCall(referenceType, progressListener, progressRequestListener); + + okhttp3.Call call = deleteMerchantDefinedFieldsDefinitionsCall(referenceType, id, progressListener, progressRequestListener); return call; @@ -309,45 +317,45 @@ private okhttp3.Call getMerchantDefinedFieldsDefinitionsValidateBeforeCall(Strin } /** - * Get all merchant defined fields for a given reference type + * Delete a MerchantDefinedField by ID * - * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) - * @return List<InlineResponse2002> + * @param referenceType (required) + * @param id (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public List getMerchantDefinedFieldsDefinitions(String referenceType) throws ApiException, ConfigException { - logger.info("CALL TO METHOD 'getMerchantDefinedFieldsDefinitions' STARTED"); - ApiResponse> resp = getMerchantDefinedFieldsDefinitionsWithHttpInfo(referenceType); - logger.info("CALL TO METHOD 'getMerchantDefinedFieldsDefinitions' ENDED"); - return resp.getData(); + public void deleteMerchantDefinedFieldsDefinitions(String referenceType, Long id) throws ApiException, ConfigException { + logger.info("CALL TO METHOD 'deleteMerchantDefinedFieldsDefinitions' STARTED"); + deleteMerchantDefinedFieldsDefinitionsWithHttpInfo(referenceType, id); + } /** - * Get all merchant defined fields for a given reference type + * Delete a MerchantDefinedField by ID * - * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) - * @return ApiResponse<List<InlineResponse2002>> + * @param referenceType (required) + * @param id (required) + * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public ApiResponse> getMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType) throws ApiException, ConfigException { + public ApiResponse deleteMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType, Long id) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); - okhttp3.Call call = getMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, null, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return apiClient.execute(call, localVarReturnType); + okhttp3.Call call = deleteMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, id, null, null); + return apiClient.execute(call); } /** - * Get all merchant defined fields for a given reference type (asynchronously) + * Delete a MerchantDefinedField by ID (asynchronously) * - * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) + * @param referenceType (required) + * @param id (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call getMerchantDefinedFieldsDefinitionsAsync(String referenceType, final ApiCallback> callback) throws ApiException, ConfigException { + public okhttp3.Call deleteMerchantDefinedFieldsDefinitionsAsync(String referenceType, Long id, final ApiCallback callback) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); ProgressResponseBody.ProgressListener progressListener = null; @@ -369,31 +377,29 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - okhttp3.Call call = getMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken>(){}.getType(); - apiClient.executeAsync(call, localVarReturnType, callback); + okhttp3.Call call = deleteMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, id, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); return call; } /** - * Build call for invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete - * @param referenceType (required) - * @param id (required) + * Build call for getMerchantDefinedFieldsDefinitions + * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteCall(String referenceType, Long id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + public okhttp3.Call getMerchantDefinedFieldsDefinitionsCall(String referenceType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { SdkTracker sdkTracker = new SdkTracker(); Object localVarPostBody = null; - if ("DELETE".equalsIgnoreCase("POST")) { + if ("GET".equalsIgnoreCase("POST")) { localVarPostBody = "{}"; } String inboundMLEStatus = "false"; - if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete,invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteAsync,invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteWithHttpInfo,invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteCall")) { + if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "getMerchantDefinedFieldsDefinitions,getMerchantDefinedFieldsDefinitionsAsync,getMerchantDefinedFieldsDefinitionsWithHttpInfo,getMerchantDefinedFieldsDefinitionsCall")) { try { localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); } catch (MLEException e) { @@ -403,9 +409,8 @@ public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteCall(St } // create path and map variables - String localVarPath = "/invoicing/v2/{referenceType}/merchantDefinedFields/{id}" - .replaceAll("\\{" + "referenceType" + "\\}", apiClient.escapeString(referenceType.toString())) - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + String localVarPath = "/invoicing/v2/{referenceType}/merchantDefinedFields" + .replaceAll("\\{" + "referenceType" + "\\}", apiClient.escapeString(referenceType.toString())); List localVarQueryParams = new ArrayList(); @@ -414,13 +419,13 @@ public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteCall(St Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/hal+json;charset=utf-8" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); final String[] localVarContentTypes = { - "application/json;charset=utf-8" + "application/json" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); @@ -438,26 +443,20 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteValidateBeforeCall(String referenceType, Long id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + private okhttp3.Call getMerchantDefinedFieldsDefinitionsValidateBeforeCall(String referenceType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { // verify the required parameter 'referenceType' is set if (referenceType == null) { - logger.error("Missing the required parameter 'referenceType' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(Async)"); - throw new ApiException("Missing the required parameter 'referenceType' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(Async)"); - } - - // verify the required parameter 'id' is set - if (id == null) { - logger.error("Missing the required parameter 'id' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(Async)"); - throw new ApiException("Missing the required parameter 'id' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(Async)"); + logger.error("Missing the required parameter 'referenceType' when calling getMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'referenceType' when calling getMerchantDefinedFieldsDefinitions(Async)"); } - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteCall(referenceType, id, progressListener, progressRequestListener); + okhttp3.Call call = getMerchantDefinedFieldsDefinitionsCall(referenceType, progressListener, progressRequestListener); return call; @@ -467,45 +466,45 @@ private okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteValida } /** - * Delete a MerchantDefinedField by ID + * Get all merchant defined fields for a given reference type * - * @param referenceType (required) - * @param id (required) + * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) + * @return List<InlineResponse2002> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public void invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(String referenceType, Long id) throws ApiException, ConfigException { - logger.info("CALL TO METHOD 'invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete' STARTED"); - invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteWithHttpInfo(referenceType, id); - + public List getMerchantDefinedFieldsDefinitions(String referenceType) throws ApiException, ConfigException { + logger.info("CALL TO METHOD 'getMerchantDefinedFieldsDefinitions' STARTED"); + ApiResponse> resp = getMerchantDefinedFieldsDefinitionsWithHttpInfo(referenceType); + logger.info("CALL TO METHOD 'getMerchantDefinedFieldsDefinitions' ENDED"); + return resp.getData(); } /** - * Delete a MerchantDefinedField by ID + * Get all merchant defined fields for a given reference type * - * @param referenceType (required) - * @param id (required) - * @return ApiResponse<Void> + * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) + * @return ApiResponse<List<InlineResponse2002>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public ApiResponse invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteWithHttpInfo(String referenceType, Long id) throws ApiException, ConfigException { + public ApiResponse> getMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteValidateBeforeCall(referenceType, id, null, null); - return apiClient.execute(call); + okhttp3.Call call = getMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, null, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return apiClient.execute(call, localVarReturnType); } /** - * Delete a MerchantDefinedField by ID (asynchronously) + * Get all merchant defined fields for a given reference type (asynchronously) * - * @param referenceType (required) - * @param id (required) + * @param referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteAsync(String referenceType, Long id, final ApiCallback callback) throws ApiException, ConfigException { + public okhttp3.Call getMerchantDefinedFieldsDefinitionsAsync(String referenceType, final ApiCallback> callback) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); ProgressResponseBody.ProgressListener progressListener = null; @@ -527,12 +526,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteValidateBeforeCall(referenceType, id, progressListener, progressRequestListener); - apiClient.executeAsync(call, callback); + okhttp3.Call call = getMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken>(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut + * Build call for putMerchantDefinedFieldsDefinitions * @param referenceType (required) * @param id (required) * @param merchantDefinedFieldCore (required) @@ -542,13 +542,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @throws ApiException If fail to serialize the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutCall(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + public okhttp3.Call putMerchantDefinedFieldsDefinitionsCall(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { SdkTracker sdkTracker = new SdkTracker(); Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(merchantDefinedFieldCore, MerchantDefinedFieldCore.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment(), apiClient.merchantConfig.getDefaultDeveloperId()); String inboundMLEStatus = "false"; - if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut,invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutAsync,invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutWithHttpInfo,invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutCall")) { + if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "putMerchantDefinedFieldsDefinitions,putMerchantDefinedFieldsDefinitionsAsync,putMerchantDefinedFieldsDefinitionsWithHttpInfo,putMerchantDefinedFieldsDefinitionsCall")) { try { localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); } catch (MLEException e) { @@ -597,28 +597,28 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce } @SuppressWarnings("rawtypes") - private okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutValidateBeforeCall(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + private okhttp3.Call putMerchantDefinedFieldsDefinitionsValidateBeforeCall(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { // verify the required parameter 'referenceType' is set if (referenceType == null) { - logger.error("Missing the required parameter 'referenceType' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); - throw new ApiException("Missing the required parameter 'referenceType' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); + logger.error("Missing the required parameter 'referenceType' when calling putMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'referenceType' when calling putMerchantDefinedFieldsDefinitions(Async)"); } // verify the required parameter 'id' is set if (id == null) { - logger.error("Missing the required parameter 'id' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); - throw new ApiException("Missing the required parameter 'id' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); + logger.error("Missing the required parameter 'id' when calling putMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'id' when calling putMerchantDefinedFieldsDefinitions(Async)"); } // verify the required parameter 'merchantDefinedFieldCore' is set if (merchantDefinedFieldCore == null) { - logger.error("Missing the required parameter 'merchantDefinedFieldCore' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); - throw new ApiException("Missing the required parameter 'merchantDefinedFieldCore' when calling invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(Async)"); + logger.error("Missing the required parameter 'merchantDefinedFieldCore' when calling putMerchantDefinedFieldsDefinitions(Async)"); + throw new ApiException("Missing the required parameter 'merchantDefinedFieldCore' when calling putMerchantDefinedFieldsDefinitions(Async)"); } - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutCall(referenceType, id, merchantDefinedFieldCore, progressListener, progressRequestListener); + okhttp3.Call call = putMerchantDefinedFieldsDefinitionsCall(referenceType, id, merchantDefinedFieldCore, progressListener, progressRequestListener); return call; @@ -637,10 +637,10 @@ private okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutValidateB * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public List invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore) throws ApiException, ConfigException { - logger.info("CALL TO METHOD 'invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut' STARTED"); - ApiResponse> resp = invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutWithHttpInfo(referenceType, id, merchantDefinedFieldCore); - logger.info("CALL TO METHOD 'invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut' ENDED"); + public List putMerchantDefinedFieldsDefinitions(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore) throws ApiException, ConfigException { + logger.info("CALL TO METHOD 'putMerchantDefinedFieldsDefinitions' STARTED"); + ApiResponse> resp = putMerchantDefinedFieldsDefinitionsWithHttpInfo(referenceType, id, merchantDefinedFieldCore); + logger.info("CALL TO METHOD 'putMerchantDefinedFieldsDefinitions' ENDED"); return resp.getData(); } @@ -654,9 +654,9 @@ public List invoicingV2ReferenceTypeMerchantDefinedFieldsIdP * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public ApiResponse> invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutWithHttpInfo(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore) throws ApiException, ConfigException { + public ApiResponse> putMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutValidateBeforeCall(referenceType, id, merchantDefinedFieldCore, null, null); + okhttp3.Call call = putMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, id, merchantDefinedFieldCore, null, null); Type localVarReturnType = new TypeToken>(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -672,7 +672,7 @@ public ApiResponse> invoicingV2ReferenceTypeMerchantDef * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @throws ConfigException If creation of merchant configuration fails in ApiClient */ - public okhttp3.Call invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutAsync(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ApiCallback> callback) throws ApiException, ConfigException { + public okhttp3.Call putMerchantDefinedFieldsDefinitionsAsync(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, final ApiCallback> callback) throws ApiException, ConfigException { this.apiClient.setComputationStartTime(System.nanoTime()); ProgressResponseBody.ProgressListener progressListener = null; @@ -694,7 +694,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - okhttp3.Call call = invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutValidateBeforeCall(referenceType, id, merchantDefinedFieldCore, progressListener, progressRequestListener); + okhttp3.Call call = putMerchantDefinedFieldsDefinitionsValidateBeforeCall(referenceType, id, merchantDefinedFieldCore, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken>(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; diff --git a/src/main/java/Api/OffersApi.java b/src/main/java/Api/OffersApi.java new file mode 100644 index 000000000..575a8cb1e --- /dev/null +++ b/src/main/java/Api/OffersApi.java @@ -0,0 +1,487 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Invokers.ApiCallback; +import Invokers.ApiClient; +import Invokers.ApiException; +import Invokers.ApiResponse; +import Invokers.Configuration; +import Invokers.Pair; +import Invokers.ProgressRequestBody; +import Invokers.ProgressResponseBody; + +import com.cybersource.authsdk.core.ConfigException; +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; +import java.io.InputStream; + + +import Model.InlineResponse20014; +import Model.InlineResponse2018; +import Model.InlineResponse40010; +import Model.InlineResponse5022; +import Model.OfferRequest; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import utilities.tracking.SdkTracker; +import com.cybersource.authsdk.util.mle.MLEUtility; +import com.cybersource.authsdk.util.mle.MLEException; + +public class OffersApi { + private static Logger logger = LogManager.getLogger(OffersApi.class); + + private ApiClient apiClient; + + public OffersApi() { + this(Configuration.getDefaultApiClient()); + } + + public OffersApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for createOffer + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param offerRequest (required) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public okhttp3.Call createOfferCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + SdkTracker sdkTracker = new SdkTracker(); + Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(offerRequest, OfferRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment(), apiClient.merchantConfig.getDefaultDeveloperId()); + + String inboundMLEStatus = "false"; + + if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "createOffer,createOfferAsync,createOfferWithHttpInfo,createOfferCall")) { + try { + localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); + } catch (MLEException e) { + logger.error("Failed to encrypt request body {}", e.getMessage(), e); + throw new ApiException("Failed to encrypt request body : " + e.getMessage()); + } + } + + // create path and map variables + String localVarPath = "/vas/v1/currencyconversion"; + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (contentType != null) + localVarHeaderParams.put("Content-Type", apiClient.parameterToString(contentType)); + if (xRequestid != null) + localVarHeaderParams.put("x-requestid", apiClient.parameterToString(xRequestid)); + if (vCMerchantId != null) + localVarHeaderParams.put("v-c-merchant-id", apiClient.parameterToString(vCMerchantId)); + if (vCCorrelationId != null) + localVarHeaderParams.put("v-c-correlation-id", apiClient.parameterToString(vCCorrelationId)); + if (vCOrganizationId != null) + localVarHeaderParams.put("v-c-organization-id", apiClient.parameterToString(vCOrganizationId)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/hal+json;charset=utf-8" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().newBuilder().addNetworkInterceptor(new okhttp3.Interceptor() { + @Override + public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOException { + okhttp3.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call createOfferValidateBeforeCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + + // verify the required parameter 'contentType' is set + if (contentType == null) { + logger.error("Missing the required parameter 'contentType' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'contentType' when calling createOffer(Async)"); + } + + // verify the required parameter 'xRequestid' is set + if (xRequestid == null) { + logger.error("Missing the required parameter 'xRequestid' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'xRequestid' when calling createOffer(Async)"); + } + + // verify the required parameter 'vCMerchantId' is set + if (vCMerchantId == null) { + logger.error("Missing the required parameter 'vCMerchantId' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCMerchantId' when calling createOffer(Async)"); + } + + // verify the required parameter 'vCCorrelationId' is set + if (vCCorrelationId == null) { + logger.error("Missing the required parameter 'vCCorrelationId' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCCorrelationId' when calling createOffer(Async)"); + } + + // verify the required parameter 'vCOrganizationId' is set + if (vCOrganizationId == null) { + logger.error("Missing the required parameter 'vCOrganizationId' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCOrganizationId' when calling createOffer(Async)"); + } + + // verify the required parameter 'offerRequest' is set + if (offerRequest == null) { + logger.error("Missing the required parameter 'offerRequest' when calling createOffer(Async)"); + throw new ApiException("Missing the required parameter 'offerRequest' when calling createOffer(Async)"); + } + + + okhttp3.Call call = createOfferCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Create an Offer + * Creates an offer record on the provider system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param offerRequest (required) + * @return InlineResponse2018 + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public InlineResponse2018 createOffer(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest) throws ApiException, ConfigException { + logger.info("CALL TO METHOD 'createOffer' STARTED"); + ApiResponse resp = createOfferWithHttpInfo(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest); + logger.info("CALL TO METHOD 'createOffer' ENDED"); + return resp.getData(); + } + + /** + * Create an Offer + * Creates an offer record on the provider system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param offerRequest (required) + * @return ApiResponse<InlineResponse2018> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public ApiResponse createOfferWithHttpInfo(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest) throws ApiException, ConfigException { + this.apiClient.setComputationStartTime(System.nanoTime()); + okhttp3.Call call = createOfferValidateBeforeCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Create an Offer (asynchronously) + * Creates an offer record on the provider system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param offerRequest (required) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public okhttp3.Call createOfferAsync(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest, final ApiCallback callback) throws ApiException, ConfigException { + + this.apiClient.setComputationStartTime(System.nanoTime()); + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + okhttp3.Call call = createOfferValidateBeforeCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getOffer + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public okhttp3.Call getOfferCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + SdkTracker sdkTracker = new SdkTracker(); + Object localVarPostBody = null; + if ("GET".equalsIgnoreCase("POST")) { + localVarPostBody = "{}"; + } + + String inboundMLEStatus = "false"; + + if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "getOffer,getOfferAsync,getOfferWithHttpInfo,getOfferCall")) { + try { + localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); + } catch (MLEException e) { + logger.error("Failed to encrypt request body {}", e.getMessage(), e); + throw new ApiException("Failed to encrypt request body : " + e.getMessage()); + } + } + + // create path and map variables + String localVarPath = "/vas/v1/currencyconversion/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (contentType != null) + localVarHeaderParams.put("Content-Type", apiClient.parameterToString(contentType)); + if (xRequestid != null) + localVarHeaderParams.put("x-requestid", apiClient.parameterToString(xRequestid)); + if (vCMerchantId != null) + localVarHeaderParams.put("v-c-merchant-id", apiClient.parameterToString(vCMerchantId)); + if (vCCorrelationId != null) + localVarHeaderParams.put("v-c-correlation-id", apiClient.parameterToString(vCCorrelationId)); + if (vCOrganizationId != null) + localVarHeaderParams.put("v-c-organization-id", apiClient.parameterToString(vCOrganizationId)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/hal+json;charset=utf-8" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().newBuilder().addNetworkInterceptor(new okhttp3.Interceptor() { + @Override + public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOException { + okhttp3.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getOfferValidateBeforeCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { + + // verify the required parameter 'contentType' is set + if (contentType == null) { + logger.error("Missing the required parameter 'contentType' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'contentType' when calling getOffer(Async)"); + } + + // verify the required parameter 'xRequestid' is set + if (xRequestid == null) { + logger.error("Missing the required parameter 'xRequestid' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'xRequestid' when calling getOffer(Async)"); + } + + // verify the required parameter 'vCMerchantId' is set + if (vCMerchantId == null) { + logger.error("Missing the required parameter 'vCMerchantId' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCMerchantId' when calling getOffer(Async)"); + } + + // verify the required parameter 'vCCorrelationId' is set + if (vCCorrelationId == null) { + logger.error("Missing the required parameter 'vCCorrelationId' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCCorrelationId' when calling getOffer(Async)"); + } + + // verify the required parameter 'vCOrganizationId' is set + if (vCOrganizationId == null) { + logger.error("Missing the required parameter 'vCOrganizationId' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'vCOrganizationId' when calling getOffer(Async)"); + } + + // verify the required parameter 'id' is set + if (id == null) { + logger.error("Missing the required parameter 'id' when calling getOffer(Async)"); + throw new ApiException("Missing the required parameter 'id' when calling getOffer(Async)"); + } + + + okhttp3.Call call = getOfferCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Retrieve an Offer + * Retrieves an offer record from the system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) + * @return InlineResponse20014 + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public InlineResponse20014 getOffer(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id) throws ApiException, ConfigException { + logger.info("CALL TO METHOD 'getOffer' STARTED"); + ApiResponse resp = getOfferWithHttpInfo(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id); + logger.info("CALL TO METHOD 'getOffer' ENDED"); + return resp.getData(); + } + + /** + * Retrieve an Offer + * Retrieves an offer record from the system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) + * @return ApiResponse<InlineResponse20014> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public ApiResponse getOfferWithHttpInfo(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id) throws ApiException, ConfigException { + this.apiClient.setComputationStartTime(System.nanoTime()); + okhttp3.Call call = getOfferValidateBeforeCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieve an Offer (asynchronously) + * Retrieves an offer record from the system. + * @param contentType (required) + * @param xRequestid (required) + * @param vCMerchantId (required) + * @param vCCorrelationId (required) + * @param vCOrganizationId (required) + * @param id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @throws ConfigException If creation of merchant configuration fails in ApiClient + */ + public okhttp3.Call getOfferAsync(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id, final ApiCallback callback) throws ApiException, ConfigException { + + this.apiClient.setComputationStartTime(System.nanoTime()); + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + okhttp3.Call call = getOfferValidateBeforeCall(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } +} diff --git a/src/main/java/Api/TokenApi.java b/src/main/java/Api/TokenApi.java index 21a4877e0..7ca369444 100644 --- a/src/main/java/Api/TokenApi.java +++ b/src/main/java/Api/TokenApi.java @@ -335,7 +335,7 @@ private okhttp3.Call postTokenPaymentCredentialsValidateBeforeCall(String tokenI /** * Generate Payment Credentials for a TMS Token - * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. + * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. * @param tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required) * @param postPaymentCredentialsRequest (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) @@ -352,7 +352,7 @@ public String postTokenPaymentCredentials(String tokenId, PostPaymentCredentials /** * Generate Payment Credentials for a TMS Token - * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. + * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. * @param tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required) * @param postPaymentCredentialsRequest (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) @@ -369,7 +369,7 @@ public ApiResponse postTokenPaymentCredentialsWithHttpInfo(String tokenI /** * Generate Payment Credentials for a TMS Token (asynchronously) - * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. + * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. * @param tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. (required) * @param postPaymentCredentialsRequest (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) diff --git a/src/main/java/Api/TokenizedCardApi.java b/src/main/java/Api/TokenizedCardApi.java index cc099c00b..eda178108 100644 --- a/src/main/java/Api/TokenizedCardApi.java +++ b/src/main/java/Api/TokenizedCardApi.java @@ -35,7 +35,6 @@ import Model.InlineResponse410; import Model.InlineResponse424; import Model.InlineResponse500; -import Model.PostIssuerLifeCycleSimulationRequest; import Model.TokenizedcardRequest; import java.lang.reflect.Type; @@ -312,7 +311,7 @@ private okhttp3.Call getTokenizedCardValidateBeforeCall(String tokenizedCardId, /** * Retrieve a Tokenized Card - * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. * @param tokenizedCardId The Id of a tokenized card. (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) * @return TokenizedcardRequest @@ -328,7 +327,7 @@ public TokenizedcardRequest getTokenizedCard(String tokenizedCardId, String prof /** * Retrieve a Tokenized Card - * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. * @param tokenizedCardId The Id of a tokenized card. (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) * @return ApiResponse<TokenizedcardRequest> @@ -344,7 +343,7 @@ public ApiResponse getTokenizedCardWithHttpInfo(String tok /** * Retrieve a Tokenized Card (asynchronously) - * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. * @param tokenizedCardId The Id of a tokenized card. (required) * @param profileId The Id of a profile containing user specific TMS configuration. (optional) * @param callback The callback to be executed when the API call finishes @@ -379,171 +378,6 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } - /** - * Build call for postIssuerLifeCycleSimulation - * @param profileId The Id of a profile containing user specific TMS configuration. (required) - * @param tokenizedCardId The Id of a tokenized card. (required) - * @param postIssuerLifeCycleSimulationRequest (required) - * @param progressListener Progress listener - * @param progressRequestListener Progress request listener - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @throws ConfigException If creation of merchant configuration fails in ApiClient - */ - public okhttp3.Call postIssuerLifeCycleSimulationCall(String profileId, String tokenizedCardId, PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { - SdkTracker sdkTracker = new SdkTracker(); - Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(postIssuerLifeCycleSimulationRequest, PostIssuerLifeCycleSimulationRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment(), apiClient.merchantConfig.getDefaultDeveloperId()); - - String inboundMLEStatus = "false"; - - if (MLEUtility.checkIsMLEForAPI(apiClient.merchantConfig, inboundMLEStatus, "postIssuerLifeCycleSimulation,postIssuerLifeCycleSimulationAsync,postIssuerLifeCycleSimulationWithHttpInfo,postIssuerLifeCycleSimulationCall")) { - try { - localVarPostBody = MLEUtility.encryptRequestPayload(apiClient.merchantConfig, localVarPostBody); - } catch (MLEException e) { - logger.error("Failed to encrypt request body {}", e.getMessage(), e); - throw new ApiException("Failed to encrypt request body : " + e.getMessage()); - } - } - - // create path and map variables - String localVarPath = "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations" - .replaceAll("\\{" + "tokenizedCardId" + "\\}", apiClient.escapeString(tokenizedCardId.toString())); - - List localVarQueryParams = new ArrayList(); - - Map localVarHeaderParams = new HashMap(); - if (profileId != null) - localVarHeaderParams.put("profile-id", apiClient.parameterToString(profileId)); - - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json;charset=utf-8" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); - - final String[] localVarContentTypes = { - "application/json;charset=utf-8" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - if(progressListener != null) { - apiClient.getHttpClient().newBuilder().addNetworkInterceptor(new okhttp3.Interceptor() { - @Override - public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOException { - okhttp3.Response originalResponse = chain.proceed(chain.request()); - return originalResponse.newBuilder() - .body(new ProgressResponseBody(originalResponse.body(), progressListener)) - .build(); - } - }); - } - - String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call postIssuerLifeCycleSimulationValidateBeforeCall(String profileId, String tokenizedCardId, PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException, ConfigException { - - // verify the required parameter 'profileId' is set - if (profileId == null) { - logger.error("Missing the required parameter 'profileId' when calling postIssuerLifeCycleSimulation(Async)"); - throw new ApiException("Missing the required parameter 'profileId' when calling postIssuerLifeCycleSimulation(Async)"); - } - - // verify the required parameter 'tokenizedCardId' is set - if (tokenizedCardId == null) { - logger.error("Missing the required parameter 'tokenizedCardId' when calling postIssuerLifeCycleSimulation(Async)"); - throw new ApiException("Missing the required parameter 'tokenizedCardId' when calling postIssuerLifeCycleSimulation(Async)"); - } - - // verify the required parameter 'postIssuerLifeCycleSimulationRequest' is set - if (postIssuerLifeCycleSimulationRequest == null) { - logger.error("Missing the required parameter 'postIssuerLifeCycleSimulationRequest' when calling postIssuerLifeCycleSimulation(Async)"); - throw new ApiException("Missing the required parameter 'postIssuerLifeCycleSimulationRequest' when calling postIssuerLifeCycleSimulation(Async)"); - } - - - okhttp3.Call call = postIssuerLifeCycleSimulationCall(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest, progressListener, progressRequestListener); - return call; - - - - - - } - - /** - * Simulate Issuer Life Cycle Management Events - * **Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment. - * @param profileId The Id of a profile containing user specific TMS configuration. (required) - * @param tokenizedCardId The Id of a tokenized card. (required) - * @param postIssuerLifeCycleSimulationRequest (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @throws ConfigException If creation of merchant configuration fails in ApiClient - */ - public void postIssuerLifeCycleSimulation(String profileId, String tokenizedCardId, PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest) throws ApiException, ConfigException { - logger.info("CALL TO METHOD 'postIssuerLifeCycleSimulation' STARTED"); - postIssuerLifeCycleSimulationWithHttpInfo(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest); - - } - - /** - * Simulate Issuer Life Cycle Management Events - * **Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment. - * @param profileId The Id of a profile containing user specific TMS configuration. (required) - * @param tokenizedCardId The Id of a tokenized card. (required) - * @param postIssuerLifeCycleSimulationRequest (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @throws ConfigException If creation of merchant configuration fails in ApiClient - */ - public ApiResponse postIssuerLifeCycleSimulationWithHttpInfo(String profileId, String tokenizedCardId, PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest) throws ApiException, ConfigException { - this.apiClient.setComputationStartTime(System.nanoTime()); - okhttp3.Call call = postIssuerLifeCycleSimulationValidateBeforeCall(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest, null, null); - return apiClient.execute(call); - } - - /** - * Simulate Issuer Life Cycle Management Events (asynchronously) - * **Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment. - * @param profileId The Id of a profile containing user specific TMS configuration. (required) - * @param tokenizedCardId The Id of a tokenized card. (required) - * @param postIssuerLifeCycleSimulationRequest (required) - * @param callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @throws ConfigException If creation of merchant configuration fails in ApiClient - */ - public okhttp3.Call postIssuerLifeCycleSimulationAsync(String profileId, String tokenizedCardId, PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest, final ApiCallback callback) throws ApiException, ConfigException { - - this.apiClient.setComputationStartTime(System.nanoTime()); - ProgressResponseBody.ProgressListener progressListener = null; - ProgressRequestBody.ProgressRequestListener progressRequestListener = null; - - if (callback != null) { - progressListener = new ProgressResponseBody.ProgressListener() { - @Override - public void update(long bytesRead, long contentLength, boolean done) { - callback.onDownloadProgress(bytesRead, contentLength, done); - } - }; - - progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { - @Override - public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { - callback.onUploadProgress(bytesWritten, contentLength, done); - } - }; - } - - okhttp3.Call call = postIssuerLifeCycleSimulationValidateBeforeCall(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest, progressListener, progressRequestListener); - apiClient.executeAsync(call, callback); - return call; - } /** * Build call for postTokenizedCard * @param tokenizedcardRequest (required) diff --git a/src/main/java/Invokers/ApiClient.java b/src/main/java/Invokers/ApiClient.java index fde9b20c0..7d040a667 100644 --- a/src/main/java/Invokers/ApiClient.java +++ b/src/main/java/Invokers/ApiClient.java @@ -1202,7 +1202,7 @@ public T handleResponse(Response response, Type returnType) throws ApiExcept * @param progressRequestListener Progress request listener * @return The HTTP call * @throws ApiException If fail to serialize the request body object - * @throws ConfigException If creation of merchant configuration fails + * @throws ConfigException If creation of merchant configuration fails */ public Call buildCall(String path, String method, List queryParams, Object body, Map headerParams, Map formParams, String[] authNames, diff --git a/src/main/java/Model/CapturePaymentRequest.java b/src/main/java/Model/CapturePaymentRequest.java index 268dd42de..50dddb745 100644 --- a/src/main/java/Model/CapturePaymentRequest.java +++ b/src/main/java/Model/CapturePaymentRequest.java @@ -29,7 +29,7 @@ import Model.Ptsv2paymentsidcapturesPaymentInformation; import Model.Ptsv2paymentsidcapturesPointOfSaleInformation; import Model.Ptsv2paymentsidcapturesProcessingInformation; -import Model.Ptsv2reversalsProcessorInformation; +import Model.Ptsv2paymentsidcapturesProcessorInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -89,7 +89,7 @@ public class CapturePaymentRequest { private Ptsv2paymentsPromotionInformation promotionInformation = null; @SerializedName("processorInformation") - private Ptsv2reversalsProcessorInformation processorInformation = null; + private Ptsv2paymentsidcapturesProcessorInformation processorInformation = null; public CapturePaymentRequest clientReferenceInformation(Ptsv2paymentsClientReferenceInformation clientReferenceInformation) { this.clientReferenceInformation = clientReferenceInformation; @@ -351,7 +351,7 @@ public void setPromotionInformation(Ptsv2paymentsPromotionInformation promotionI this.promotionInformation = promotionInformation; } - public CapturePaymentRequest processorInformation(Ptsv2reversalsProcessorInformation processorInformation) { + public CapturePaymentRequest processorInformation(Ptsv2paymentsidcapturesProcessorInformation processorInformation) { this.processorInformation = processorInformation; return this; } @@ -361,11 +361,11 @@ public CapturePaymentRequest processorInformation(Ptsv2reversalsProcessorInforma * @return processorInformation **/ @ApiModelProperty(value = "") - public Ptsv2reversalsProcessorInformation getProcessorInformation() { + public Ptsv2paymentsidcapturesProcessorInformation getProcessorInformation() { return processorInformation; } - public void setProcessorInformation(Ptsv2reversalsProcessorInformation processorInformation) { + public void setProcessorInformation(Ptsv2paymentsidcapturesProcessorInformation processorInformation) { this.processorInformation = processorInformation; } diff --git a/src/main/java/Model/GenerateCaptureContextRequest.java b/src/main/java/Model/GenerateCaptureContextRequest.java index b2e60e3c3..fdacbccc6 100644 --- a/src/main/java/Model/GenerateCaptureContextRequest.java +++ b/src/main/java/Model/GenerateCaptureContextRequest.java @@ -106,10 +106,10 @@ public GenerateCaptureContextRequest addAllowedCardNetworksItem(String allowedCa } /** - * 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 - PAYPAK **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. + * 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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. * @return allowedCardNetworks **/ - @ApiModelProperty(value = "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 - PAYPAK **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. ") + @ApiModelProperty(value = "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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. ") public List getAllowedCardNetworks() { return allowedCardNetworks; } diff --git a/src/main/java/Model/GenerateUnifiedCheckoutCaptureContextRequest.java b/src/main/java/Model/GenerateUnifiedCheckoutCaptureContextRequest.java index b24aa5888..83410cca3 100644 --- a/src/main/java/Model/GenerateUnifiedCheckoutCaptureContextRequest.java +++ b/src/main/java/Model/GenerateUnifiedCheckoutCaptureContextRequest.java @@ -18,6 +18,7 @@ import Model.Microformv2sessionsTransientTokenResponseOptions; import Model.Upv1capturecontextsCaptureMandate; import Model.Upv1capturecontextsCompleteMandate; +import Model.Upv1capturecontextsData; import Model.Upv1capturecontextsOrderInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -59,12 +60,15 @@ public class GenerateUnifiedCheckoutCaptureContextRequest { @SerializedName("completeMandate") private Upv1capturecontextsCompleteMandate completeMandate = null; - @SerializedName("orderInformation") - private Upv1capturecontextsOrderInformation orderInformation = null; - @SerializedName("transientTokenResponseOptions") private Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions = null; + @SerializedName("data") + private Upv1capturecontextsData data = null; + + @SerializedName("orderInformation") + private Upv1capturecontextsOrderInformation orderInformation = null; + public GenerateUnifiedCheckoutCaptureContextRequest clientVersion(String clientVersion) { this.clientVersion = clientVersion; return this; @@ -123,10 +127,10 @@ public GenerateUnifiedCheckoutCaptureContextRequest addAllowedCardNetworksItem(S } /** - * 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 - PAYPAK + * 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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP * @return allowedCardNetworks **/ - @ApiModelProperty(value = "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 - PAYPAK ") + @ApiModelProperty(value = "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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP ") public List getAllowedCardNetworks() { return allowedCardNetworks; } @@ -149,10 +153,10 @@ public GenerateUnifiedCheckoutCaptureContextRequest addAllowedPaymentTypesItem(S } /** - * The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout also supports the following Alternative Payments: - AFTERPAY<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.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. + * The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY<br><br> Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) 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.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. * @return allowedPaymentTypes **/ - @ApiModelProperty(value = "The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE

Unified Checkout also supports the following Alternative Payments: - AFTERPAY

Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY

**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.

**Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

**Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa

If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. ") + @ApiModelProperty(value = "The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE

Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY

Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY

**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.

**Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

**Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa

If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. ") public List getAllowedPaymentTypes() { return allowedPaymentTypes; } @@ -233,40 +237,58 @@ public void setCompleteMandate(Upv1capturecontextsCompleteMandate completeMandat this.completeMandate = completeMandate; } - public GenerateUnifiedCheckoutCaptureContextRequest orderInformation(Upv1capturecontextsOrderInformation orderInformation) { - this.orderInformation = orderInformation; + public GenerateUnifiedCheckoutCaptureContextRequest transientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions) { + this.transientTokenResponseOptions = transientTokenResponseOptions; return this; } /** - * Get orderInformation - * @return orderInformation + * Get transientTokenResponseOptions + * @return transientTokenResponseOptions **/ @ApiModelProperty(value = "") - public Upv1capturecontextsOrderInformation getOrderInformation() { - return orderInformation; + public Microformv2sessionsTransientTokenResponseOptions getTransientTokenResponseOptions() { + return transientTokenResponseOptions; } - public void setOrderInformation(Upv1capturecontextsOrderInformation orderInformation) { - this.orderInformation = orderInformation; + public void setTransientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions) { + this.transientTokenResponseOptions = transientTokenResponseOptions; } - public GenerateUnifiedCheckoutCaptureContextRequest transientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions) { - this.transientTokenResponseOptions = transientTokenResponseOptions; + public GenerateUnifiedCheckoutCaptureContextRequest data(Upv1capturecontextsData data) { + this.data = data; return this; } /** - * Get transientTokenResponseOptions - * @return transientTokenResponseOptions + * Get data + * @return data **/ @ApiModelProperty(value = "") - public Microformv2sessionsTransientTokenResponseOptions getTransientTokenResponseOptions() { - return transientTokenResponseOptions; + public Upv1capturecontextsData getData() { + return data; } - public void setTransientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions) { - this.transientTokenResponseOptions = transientTokenResponseOptions; + public void setData(Upv1capturecontextsData data) { + this.data = data; + } + + public GenerateUnifiedCheckoutCaptureContextRequest orderInformation(Upv1capturecontextsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Upv1capturecontextsOrderInformation orderInformation) { + this.orderInformation = orderInformation; } @@ -287,13 +309,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.locale, generateUnifiedCheckoutCaptureContextRequest.locale) && Objects.equals(this.captureMandate, generateUnifiedCheckoutCaptureContextRequest.captureMandate) && Objects.equals(this.completeMandate, generateUnifiedCheckoutCaptureContextRequest.completeMandate) && - Objects.equals(this.orderInformation, generateUnifiedCheckoutCaptureContextRequest.orderInformation) && - Objects.equals(this.transientTokenResponseOptions, generateUnifiedCheckoutCaptureContextRequest.transientTokenResponseOptions); + Objects.equals(this.transientTokenResponseOptions, generateUnifiedCheckoutCaptureContextRequest.transientTokenResponseOptions) && + Objects.equals(this.data, generateUnifiedCheckoutCaptureContextRequest.data) && + Objects.equals(this.orderInformation, generateUnifiedCheckoutCaptureContextRequest.orderInformation); } @Override public int hashCode() { - return Objects.hash(clientVersion, targetOrigins, allowedCardNetworks, allowedPaymentTypes, country, locale, captureMandate, completeMandate, orderInformation, transientTokenResponseOptions); + return Objects.hash(clientVersion, targetOrigins, allowedCardNetworks, allowedPaymentTypes, country, locale, captureMandate, completeMandate, transientTokenResponseOptions, data, orderInformation); } @@ -310,8 +333,9 @@ public String toString() { if (locale != null) sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); if (captureMandate != null) sb.append(" captureMandate: ").append(toIndentedString(captureMandate)).append("\n"); if (completeMandate != null) sb.append(" completeMandate: ").append(toIndentedString(completeMandate)).append("\n"); - if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); if (transientTokenResponseOptions != null) sb.append(" transientTokenResponseOptions: ").append(toIndentedString(transientTokenResponseOptions)).append("\n"); + if (data != null) sb.append(" data: ").append(toIndentedString(data)).append("\n"); + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/InlineResponse20014.java b/src/main/java/Model/InlineResponse20014.java new file mode 100644 index 000000000..a8ebbb46e --- /dev/null +++ b/src/main/java/Model/InlineResponse20014.java @@ -0,0 +1,212 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.InlineResponse20014ClientReferenceInformation; +import Model.InlineResponse2018ErrorInformation; +import Model.InlineResponse2018OrderInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse20014 + */ + +public class InlineResponse20014 { + @SerializedName("clientReferenceInformation") + private InlineResponse20014ClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("submitTimeUtc") + private String submitTimeUtc = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("errorInformation") + private InlineResponse2018ErrorInformation errorInformation = null; + + @SerializedName("orderInformation") + private InlineResponse2018OrderInformation orderInformation = null; + + public InlineResponse20014 clientReferenceInformation(InlineResponse20014ClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse20014ClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(InlineResponse20014ClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public InlineResponse20014 id(String id) { + this.id = id; + return this; + } + + /** + * Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * @return id + **/ + @ApiModelProperty(required = true, value = "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public InlineResponse20014 submitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + return this; + } + + /** + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUtc + **/ + @ApiModelProperty(required = true, value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUtc() { + return submitTimeUtc; + } + + public void setSubmitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + } + + public InlineResponse20014 status(String status) { + this.status = status; + return this; + } + + /** + * Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` + * @return status + **/ + @ApiModelProperty(required = true, value = "Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` ") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public InlineResponse20014 errorInformation(InlineResponse2018ErrorInformation errorInformation) { + this.errorInformation = errorInformation; + return this; + } + + /** + * Get errorInformation + * @return errorInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018ErrorInformation getErrorInformation() { + return errorInformation; + } + + public void setErrorInformation(InlineResponse2018ErrorInformation errorInformation) { + this.errorInformation = errorInformation; + } + + public InlineResponse20014 orderInformation(InlineResponse2018OrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018OrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(InlineResponse2018OrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse20014 inlineResponse20014 = (InlineResponse20014) o; + return Objects.equals(this.clientReferenceInformation, inlineResponse20014.clientReferenceInformation) && + Objects.equals(this.id, inlineResponse20014.id) && + Objects.equals(this.submitTimeUtc, inlineResponse20014.submitTimeUtc) && + Objects.equals(this.status, inlineResponse20014.status) && + Objects.equals(this.errorInformation, inlineResponse20014.errorInformation) && + Objects.equals(this.orderInformation, inlineResponse20014.orderInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation, id, submitTimeUtc, status, errorInformation, orderInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse20014 {\n"); + + if (clientReferenceInformation != null) sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (submitTimeUtc != null) sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + if (status != null) sb.append(" status: ").append(toIndentedString(status)).append("\n"); + if (errorInformation != null) sb.append(" errorInformation: ").append(toIndentedString(errorInformation)).append("\n"); + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse20014ClientReferenceInformation.java b/src/main/java/Model/InlineResponse20014ClientReferenceInformation.java new file mode 100644 index 000000000..aaabc6eae --- /dev/null +++ b/src/main/java/Model/InlineResponse20014ClientReferenceInformation.java @@ -0,0 +1,187 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Riskv1decisionsClientReferenceInformationPartner; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse20014ClientReferenceInformation + */ + +public class InlineResponse20014ClientReferenceInformation { + @SerializedName("code") + private String code = null; + + @SerializedName("applicationName") + private String applicationName = null; + + @SerializedName("applicationVersion") + private String applicationVersion = null; + + @SerializedName("applicationUser") + private String applicationUser = null; + + @SerializedName("partner") + private Riskv1decisionsClientReferenceInformationPartner partner = null; + + public InlineResponse20014ClientReferenceInformation code(String code) { + this.code = code; + return this; + } + + /** + * Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * @return code + **/ + @ApiModelProperty(value = "Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public InlineResponse20014ClientReferenceInformation applicationName(String applicationName) { + this.applicationName = applicationName; + return this; + } + + /** + * The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. + * @return applicationName + **/ + @ApiModelProperty(value = "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.") + public String getApplicationName() { + return applicationName; + } + + public void setApplicationName(String applicationName) { + this.applicationName = applicationName; + } + + public InlineResponse20014ClientReferenceInformation applicationVersion(String applicationVersion) { + this.applicationVersion = applicationVersion; + return this; + } + + /** + * Version of the CyberSource application or integration used for a transaction. + * @return applicationVersion + **/ + @ApiModelProperty(value = "Version of the CyberSource application or integration used for a transaction.") + public String getApplicationVersion() { + return applicationVersion; + } + + public void setApplicationVersion(String applicationVersion) { + this.applicationVersion = applicationVersion; + } + + public InlineResponse20014ClientReferenceInformation applicationUser(String applicationUser) { + this.applicationUser = applicationUser; + return this; + } + + /** + * The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. + * @return applicationUser + **/ + @ApiModelProperty(value = "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.") + public String getApplicationUser() { + return applicationUser; + } + + public void setApplicationUser(String applicationUser) { + this.applicationUser = applicationUser; + } + + public InlineResponse20014ClientReferenceInformation partner(Riskv1decisionsClientReferenceInformationPartner partner) { + this.partner = partner; + return this; + } + + /** + * Get partner + * @return partner + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsClientReferenceInformationPartner getPartner() { + return partner; + } + + public void setPartner(Riskv1decisionsClientReferenceInformationPartner partner) { + this.partner = partner; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse20014ClientReferenceInformation inlineResponse20014ClientReferenceInformation = (InlineResponse20014ClientReferenceInformation) o; + return Objects.equals(this.code, inlineResponse20014ClientReferenceInformation.code) && + Objects.equals(this.applicationName, inlineResponse20014ClientReferenceInformation.applicationName) && + Objects.equals(this.applicationVersion, inlineResponse20014ClientReferenceInformation.applicationVersion) && + Objects.equals(this.applicationUser, inlineResponse20014ClientReferenceInformation.applicationUser) && + Objects.equals(this.partner, inlineResponse20014ClientReferenceInformation.partner); + } + + @Override + public int hashCode() { + return Objects.hash(code, applicationName, applicationVersion, applicationUser, partner); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse20014ClientReferenceInformation {\n"); + + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + if (applicationName != null) sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + if (applicationVersion != null) sb.append(" applicationVersion: ").append(toIndentedString(applicationVersion)).append("\n"); + if (applicationUser != null) sb.append(" applicationUser: ").append(toIndentedString(applicationUser)).append("\n"); + if (partner != null) sb.append(" partner: ").append(toIndentedString(partner)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse2018.java b/src/main/java/Model/InlineResponse2018.java new file mode 100644 index 000000000..4be5c67f0 --- /dev/null +++ b/src/main/java/Model/InlineResponse2018.java @@ -0,0 +1,236 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.InlineResponse2018ClientReferenceInformation; +import Model.InlineResponse2018ErrorInformation; +import Model.InlineResponse2018OrderInformation; +import Model.InlineResponse2018ProcessorInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse2018 + */ + +public class InlineResponse2018 { + @SerializedName("clientReferenceInformation") + private InlineResponse2018ClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("submitTimeUtc") + private String submitTimeUtc = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("errorInformation") + private InlineResponse2018ErrorInformation errorInformation = null; + + @SerializedName("orderInformation") + private InlineResponse2018OrderInformation orderInformation = null; + + @SerializedName("processorInformation") + private InlineResponse2018ProcessorInformation processorInformation = null; + + public InlineResponse2018 clientReferenceInformation(InlineResponse2018ClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018ClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(InlineResponse2018ClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public InlineResponse2018 id(String id) { + this.id = id; + return this; + } + + /** + * Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * @return id + **/ + @ApiModelProperty(required = true, value = "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public InlineResponse2018 submitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + return this; + } + + /** + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUtc + **/ + @ApiModelProperty(required = true, value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUtc() { + return submitTimeUtc; + } + + public void setSubmitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + } + + public InlineResponse2018 status(String status) { + this.status = status; + return this; + } + + /** + * Message describing the status of the currency conversion request. Possible values: - PENDING - DECLINED - SERVER_ERROR + * @return status + **/ + @ApiModelProperty(required = true, value = "Message describing the status of the currency conversion request. Possible values: - PENDING - DECLINED - SERVER_ERROR") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public InlineResponse2018 errorInformation(InlineResponse2018ErrorInformation errorInformation) { + this.errorInformation = errorInformation; + return this; + } + + /** + * Get errorInformation + * @return errorInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018ErrorInformation getErrorInformation() { + return errorInformation; + } + + public void setErrorInformation(InlineResponse2018ErrorInformation errorInformation) { + this.errorInformation = errorInformation; + } + + public InlineResponse2018 orderInformation(InlineResponse2018OrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018OrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(InlineResponse2018OrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public InlineResponse2018 processorInformation(InlineResponse2018ProcessorInformation processorInformation) { + this.processorInformation = processorInformation; + return this; + } + + /** + * Get processorInformation + * @return processorInformation + **/ + @ApiModelProperty(value = "") + public InlineResponse2018ProcessorInformation getProcessorInformation() { + return processorInformation; + } + + public void setProcessorInformation(InlineResponse2018ProcessorInformation processorInformation) { + this.processorInformation = processorInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018 inlineResponse2018 = (InlineResponse2018) o; + return Objects.equals(this.clientReferenceInformation, inlineResponse2018.clientReferenceInformation) && + Objects.equals(this.id, inlineResponse2018.id) && + Objects.equals(this.submitTimeUtc, inlineResponse2018.submitTimeUtc) && + Objects.equals(this.status, inlineResponse2018.status) && + Objects.equals(this.errorInformation, inlineResponse2018.errorInformation) && + Objects.equals(this.orderInformation, inlineResponse2018.orderInformation) && + Objects.equals(this.processorInformation, inlineResponse2018.processorInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation, id, submitTimeUtc, status, errorInformation, orderInformation, processorInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018 {\n"); + + if (clientReferenceInformation != null) sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (submitTimeUtc != null) sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + if (status != null) sb.append(" status: ").append(toIndentedString(status)).append("\n"); + if (errorInformation != null) sb.append(" errorInformation: ").append(toIndentedString(errorInformation)).append("\n"); + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + if (processorInformation != null) sb.append(" processorInformation: ").append(toIndentedString(processorInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse2018ClientReferenceInformation.java b/src/main/java/Model/InlineResponse2018ClientReferenceInformation.java new file mode 100644 index 000000000..f1fd15a6b --- /dev/null +++ b/src/main/java/Model/InlineResponse2018ClientReferenceInformation.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse2018ClientReferenceInformation + */ + +public class InlineResponse2018ClientReferenceInformation { + @SerializedName("code") + private String code = null; + + public InlineResponse2018ClientReferenceInformation code(String code) { + this.code = code; + return this; + } + + /** + * Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * @return code + **/ + @ApiModelProperty(value = "Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018ClientReferenceInformation inlineResponse2018ClientReferenceInformation = (InlineResponse2018ClientReferenceInformation) o; + return Objects.equals(this.code, inlineResponse2018ClientReferenceInformation.code); + } + + @Override + public int hashCode() { + return Objects.hash(code); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018ClientReferenceInformation {\n"); + + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse2018ErrorInformation.java b/src/main/java/Model/InlineResponse2018ErrorInformation.java new file mode 100644 index 000000000..23a56a286 --- /dev/null +++ b/src/main/java/Model/InlineResponse2018ErrorInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse2018ErrorInformation + */ + +public class InlineResponse2018ErrorInformation { + @SerializedName("reason") + private String reason = null; + + @SerializedName("message") + private String message = null; + + public InlineResponse2018ErrorInformation reason(String reason) { + this.reason = reason; + return this; + } + + /** + * Only required when offer cannot be made. The reason of the status. Possible values: - 'INVALID_MERCHANT_CONFIGURATION' - 'NOT_ELIGIBLE' - 'CURRENCY_NOT_CONFIGURED' - 'BIN_UNKNOWN' - 'CURRENCY_MATCH' - 'CURRENCY_NOT_ALLOWED' - 'LOOKUP_FAILED' - 'EXCHANGE_RATE_NOT_FOUND' - 'CARD_TYPE_NOT_ACCEPTED' - 'INVALID_AMOUNT' - 'INVALID_CARD' - 'INVALID_CURRENCY' - 'INVALID_TERMINAL' - 'INVALID_ACQUIRER' - 'SERVICE_DISABLED' - 'DUPLICATE_REQUEST' - 'UNKNOWN' - 'PROCESSOR_ERROR' + * @return reason + **/ + @ApiModelProperty(value = "Only required when offer cannot be made. The reason of the status. Possible values: - 'INVALID_MERCHANT_CONFIGURATION' - 'NOT_ELIGIBLE' - 'CURRENCY_NOT_CONFIGURED' - 'BIN_UNKNOWN' - 'CURRENCY_MATCH' - 'CURRENCY_NOT_ALLOWED' - 'LOOKUP_FAILED' - 'EXCHANGE_RATE_NOT_FOUND' - 'CARD_TYPE_NOT_ACCEPTED' - 'INVALID_AMOUNT' - 'INVALID_CARD' - 'INVALID_CURRENCY' - 'INVALID_TERMINAL' - 'INVALID_ACQUIRER' - 'SERVICE_DISABLED' - 'DUPLICATE_REQUEST' - 'UNKNOWN' - 'PROCESSOR_ERROR' ") + public String getReason() { + return reason; + } + + public void setReason(String reason) { + this.reason = reason; + } + + public InlineResponse2018ErrorInformation message(String message) { + this.message = message; + return this; + } + + /** + * Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered. + * @return message + **/ + @ApiModelProperty(value = "Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered.") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018ErrorInformation inlineResponse2018ErrorInformation = (InlineResponse2018ErrorInformation) o; + return Objects.equals(this.reason, inlineResponse2018ErrorInformation.reason) && + Objects.equals(this.message, inlineResponse2018ErrorInformation.message); + } + + @Override + public int hashCode() { + return Objects.hash(reason, message); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018ErrorInformation {\n"); + + if (reason != null) sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + if (message != null) sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.java b/src/main/java/Model/InlineResponse2018OrderInformation.java similarity index 50% rename from src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.java rename to src/main/java/Model/InlineResponse2018OrderInformation.java index d3ec4b208..19455f3de 100644 --- a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.java +++ b/src/main/java/Model/InlineResponse2018OrderInformation.java @@ -15,7 +15,7 @@ import java.util.Objects; import java.util.Arrays; -import Model.Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt; +import Model.InlineResponse2018OrderInformationCurrencyConversion; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -26,29 +26,29 @@ import java.io.IOException; /** - * Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata + * InlineResponse2018OrderInformation */ -public class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata { - @SerializedName("cardArt") - private Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt cardArt = null; +public class InlineResponse2018OrderInformation { + @SerializedName("currencyConversion") + private InlineResponse2018OrderInformationCurrencyConversion currencyConversion = null; - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata cardArt(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt cardArt) { - this.cardArt = cardArt; + public InlineResponse2018OrderInformation currencyConversion(InlineResponse2018OrderInformationCurrencyConversion currencyConversion) { + this.currencyConversion = currencyConversion; return this; } /** - * Get cardArt - * @return cardArt + * Get currencyConversion + * @return currencyConversion **/ @ApiModelProperty(value = "") - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt getCardArt() { - return cardArt; + public InlineResponse2018OrderInformationCurrencyConversion getCurrencyConversion() { + return currencyConversion; } - public void setCardArt(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt cardArt) { - this.cardArt = cardArt; + public void setCurrencyConversion(InlineResponse2018OrderInformationCurrencyConversion currencyConversion) { + this.currencyConversion = currencyConversion; } @@ -60,22 +60,22 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata = (Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata) o; - return Objects.equals(this.cardArt, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.cardArt); + InlineResponse2018OrderInformation inlineResponse2018OrderInformation = (InlineResponse2018OrderInformation) o; + return Objects.equals(this.currencyConversion, inlineResponse2018OrderInformation.currencyConversion); } @Override public int hashCode() { - return Objects.hash(cardArt); + return Objects.hash(currencyConversion); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata {\n"); + sb.append("class InlineResponse2018OrderInformation {\n"); - if (cardArt != null) sb.append(" cardArt: ").append(toIndentedString(cardArt)).append("\n"); + if (currencyConversion != null) sb.append(" currencyConversion: ").append(toIndentedString(currencyConversion)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversion.java b/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversion.java new file mode 100644 index 000000000..052fc19fc --- /dev/null +++ b/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversion.java @@ -0,0 +1,174 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.InlineResponse2018OrderInformationCurrencyConversionOffer; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * InlineResponse2018OrderInformationCurrencyConversion + */ + +public class InlineResponse2018OrderInformationCurrencyConversion { + @SerializedName("type") + private String type = null; + + @SerializedName("reconciliationId") + private String reconciliationId = null; + + @SerializedName("offer") + private List offer = null; + + @SerializedName("disclaimer") + private String disclaimer = null; + + public InlineResponse2018OrderInformationCurrencyConversion type(String type) { + this.type = type; + return this; + } + + /** + * Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing This should be echo'd from the request + * @return type + **/ + @ApiModelProperty(value = "Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing This should be echo'd from the request ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public InlineResponse2018OrderInformationCurrencyConversion reconciliationId(String reconciliationId) { + this.reconciliationId = reconciliationId; + return this; + } + + /** + * Unique identifier generated by the DCC provider. + * @return reconciliationId + **/ + @ApiModelProperty(required = true, value = "Unique identifier generated by the DCC provider.") + public String getReconciliationId() { + return reconciliationId; + } + + public void setReconciliationId(String reconciliationId) { + this.reconciliationId = reconciliationId; + } + + public InlineResponse2018OrderInformationCurrencyConversion offer(List offer) { + this.offer = offer; + return this; + } + + public InlineResponse2018OrderInformationCurrencyConversion addOfferItem(InlineResponse2018OrderInformationCurrencyConversionOffer offerItem) { + if (this.offer == null) { + this.offer = new ArrayList(); + } + this.offer.add(offerItem); + return this; + } + + /** + * When type is DCC this is a single item. When type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant. + * @return offer + **/ + @ApiModelProperty(value = "When type is DCC this is a single item. When type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant. ") + public List getOffer() { + return offer; + } + + public void setOffer(List offer) { + this.offer = offer; + } + + public InlineResponse2018OrderInformationCurrencyConversion disclaimer(String disclaimer) { + this.disclaimer = disclaimer; + return this; + } + + /** + * This text is intended to inform customers about their opt-in choices. It should include details such as the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as the mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency Conversion) and optional otherwise. This information will be displayed on the screen and printed on the receipt without modification. + * @return disclaimer + **/ + @ApiModelProperty(value = "This text is intended to inform customers about their opt-in choices. It should include details such as the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as the mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency Conversion) and optional otherwise. This information will be displayed on the screen and printed on the receipt without modification. ") + public String getDisclaimer() { + return disclaimer; + } + + public void setDisclaimer(String disclaimer) { + this.disclaimer = disclaimer; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018OrderInformationCurrencyConversion inlineResponse2018OrderInformationCurrencyConversion = (InlineResponse2018OrderInformationCurrencyConversion) o; + return Objects.equals(this.type, inlineResponse2018OrderInformationCurrencyConversion.type) && + Objects.equals(this.reconciliationId, inlineResponse2018OrderInformationCurrencyConversion.reconciliationId) && + Objects.equals(this.offer, inlineResponse2018OrderInformationCurrencyConversion.offer) && + Objects.equals(this.disclaimer, inlineResponse2018OrderInformationCurrencyConversion.disclaimer); + } + + @Override + public int hashCode() { + return Objects.hash(type, reconciliationId, offer, disclaimer); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018OrderInformationCurrencyConversion {\n"); + + if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (reconciliationId != null) sb.append(" reconciliationId: ").append(toIndentedString(reconciliationId)).append("\n"); + if (offer != null) sb.append(" offer: ").append(toIndentedString(offer)).append("\n"); + if (disclaimer != null) sb.append(" disclaimer: ").append(toIndentedString(disclaimer)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversionOffer.java b/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversionOffer.java new file mode 100644 index 000000000..c331caa16 --- /dev/null +++ b/src/main/java/Model/InlineResponse2018OrderInformationCurrencyConversionOffer.java @@ -0,0 +1,324 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse2018OrderInformationCurrencyConversionOffer + */ + +public class InlineResponse2018OrderInformationCurrencyConversionOffer { + @SerializedName("originalAmount") + private String originalAmount = null; + + @SerializedName("originalCurrency") + private String originalCurrency = null; + + @SerializedName("amount") + private String amount = null; + + @SerializedName("currency") + private String currency = null; + + @SerializedName("exchangeRate") + private String exchangeRate = null; + + @SerializedName("exchangeRateInverted") + private Boolean exchangeRateInverted = null; + + @SerializedName("marginRate") + private String marginRate = null; + + @SerializedName("rateSource") + private String rateSource = null; + + @SerializedName("exchangeRateTimeUtc") + private String exchangeRateTimeUtc = null; + + @SerializedName("exchangeRateExpirationTimeUtc") + private String exchangeRateExpirationTimeUtc = null; + + @SerializedName("rateId") + private String rateId = null; + + public InlineResponse2018OrderInformationCurrencyConversionOffer originalAmount(String originalAmount) { + this.originalAmount = originalAmount; + return this; + } + + /** + * The amount of the sale in the merchant's currency. For DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency. + * @return originalAmount + **/ + @ApiModelProperty(value = "The amount of the sale in the merchant's currency. For DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant's base currency. ") + public String getOriginalAmount() { + return originalAmount; + } + + public void setOriginalAmount(String originalAmount) { + this.originalAmount = originalAmount; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer originalCurrency(String originalCurrency) { + this.originalCurrency = originalCurrency; + return this; + } + + /** + * Currency of the transaction in the merchant's currency. For DCC this should be the same value as the request. For MCP will be the merchant's base currency as configured on the currency conversion provider's system. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) + * @return originalCurrency + **/ + @ApiModelProperty(value = "Currency of the transaction in the merchant's currency. For DCC this should be the same value as the request. For MCP will be the merchant's base currency as configured on the currency conversion provider's system. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) ") + public String getOriginalCurrency() { + return originalCurrency; + } + + public void setOriginalCurrency(String originalCurrency) { + this.originalCurrency = originalCurrency; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer amount(String amount) { + this.amount = amount; + return this; + } + + /** + * The offer amount, calculated using the originalAmount and the exchangeRate. For DCC this is the amount in the card issuer's currency. + * @return amount + **/ + @ApiModelProperty(value = "The offer amount, calculated using the originalAmount and the exchangeRate. For DCC this is the amount in the card issuer's currency. ") + public String getAmount() { + return amount; + } + + public void setAmount(String amount) { + this.amount = amount; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Currency of the offer. For DCC this is the card's issuers currency. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) + * @return currency + **/ + @ApiModelProperty(value = "Currency of the offer. For DCC this is the card's issuers currency. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) ") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer exchangeRate(String exchangeRate) { + this.exchangeRate = exchangeRate; + return this; + } + + /** + * The exchange rate of the offer from 1 major unit of the sale currency including margin. This will be printed on the receipt. For example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up. The receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field. + * @return exchangeRate + **/ + @ApiModelProperty(value = "The exchange rate of the offer from 1 major unit of the sale currency including margin. This will be printed on the receipt. For example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up. The receipt will contain the following: `EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field. ") + public String getExchangeRate() { + return exchangeRate; + } + + public void setExchangeRate(String exchangeRate) { + this.exchangeRate = exchangeRate; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer exchangeRateInverted(Boolean exchangeRateInverted) { + this.exchangeRateInverted = exchangeRateInverted; + return this; + } + + /** + * An inverted exchange rate is the base currency amount divided by the converted currency amount. Ex. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR. + * @return exchangeRateInverted + **/ + @ApiModelProperty(example = "true", value = "An inverted exchange rate is the base currency amount divided by the converted currency amount. Ex. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR. ") + public Boolean ExchangeRateInverted() { + return exchangeRateInverted; + } + + public void setExchangeRateInverted(Boolean exchangeRateInverted) { + this.exchangeRateInverted = exchangeRateInverted; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer marginRate(String marginRate) { + this.marginRate = marginRate; + return this; + } + + /** + * The margin between the offer exchange rate and wholesale rates, i.e. the mark up. Expressed as a percentage of 100, e.g. 3.75 + * @return marginRate + **/ + @ApiModelProperty(value = "The margin between the offer exchange rate and wholesale rates, i.e. the mark up. Expressed as a percentage of 100, e.g. 3.75 ") + public String getMarginRate() { + return marginRate; + } + + public void setMarginRate(String marginRate) { + this.marginRate = marginRate; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer rateSource(String rateSource) { + this.rateSource = rateSource; + return this; + } + + /** + * The source of the rate (excluding mark up). Optional field. + * @return rateSource + **/ + @ApiModelProperty(value = "The source of the rate (excluding mark up). Optional field. ") + public String getRateSource() { + return rateSource; + } + + public void setRateSource(String rateSource) { + this.rateSource = rateSource; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer exchangeRateTimeUtc(String exchangeRateTimeUtc) { + this.exchangeRateTimeUtc = exchangeRateTimeUtc; + return this; + } + + /** + * The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return exchangeRateTimeUtc + **/ + @ApiModelProperty(value = "The date and time of exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getExchangeRateTimeUtc() { + return exchangeRateTimeUtc; + } + + public void setExchangeRateTimeUtc(String exchangeRateTimeUtc) { + this.exchangeRateTimeUtc = exchangeRateTimeUtc; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer exchangeRateExpirationTimeUtc(String exchangeRateExpirationTimeUtc) { + this.exchangeRateExpirationTimeUtc = exchangeRateExpirationTimeUtc; + return this; + } + + /** + * The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` + * @return exchangeRateExpirationTimeUtc + **/ + @ApiModelProperty(value = "The expiration time of the exchange rate in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` ") + public String getExchangeRateExpirationTimeUtc() { + return exchangeRateExpirationTimeUtc; + } + + public void setExchangeRateExpirationTimeUtc(String exchangeRateExpirationTimeUtc) { + this.exchangeRateExpirationTimeUtc = exchangeRateExpirationTimeUtc; + } + + public InlineResponse2018OrderInformationCurrencyConversionOffer rateId(String rateId) { + this.rateId = rateId; + return this; + } + + /** + * A unique MCP rate identifier. + * @return rateId + **/ + @ApiModelProperty(value = "A unique MCP rate identifier. ") + public String getRateId() { + return rateId; + } + + public void setRateId(String rateId) { + this.rateId = rateId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018OrderInformationCurrencyConversionOffer inlineResponse2018OrderInformationCurrencyConversionOffer = (InlineResponse2018OrderInformationCurrencyConversionOffer) o; + return Objects.equals(this.originalAmount, inlineResponse2018OrderInformationCurrencyConversionOffer.originalAmount) && + Objects.equals(this.originalCurrency, inlineResponse2018OrderInformationCurrencyConversionOffer.originalCurrency) && + Objects.equals(this.amount, inlineResponse2018OrderInformationCurrencyConversionOffer.amount) && + Objects.equals(this.currency, inlineResponse2018OrderInformationCurrencyConversionOffer.currency) && + Objects.equals(this.exchangeRate, inlineResponse2018OrderInformationCurrencyConversionOffer.exchangeRate) && + Objects.equals(this.exchangeRateInverted, inlineResponse2018OrderInformationCurrencyConversionOffer.exchangeRateInverted) && + Objects.equals(this.marginRate, inlineResponse2018OrderInformationCurrencyConversionOffer.marginRate) && + Objects.equals(this.rateSource, inlineResponse2018OrderInformationCurrencyConversionOffer.rateSource) && + Objects.equals(this.exchangeRateTimeUtc, inlineResponse2018OrderInformationCurrencyConversionOffer.exchangeRateTimeUtc) && + Objects.equals(this.exchangeRateExpirationTimeUtc, inlineResponse2018OrderInformationCurrencyConversionOffer.exchangeRateExpirationTimeUtc) && + Objects.equals(this.rateId, inlineResponse2018OrderInformationCurrencyConversionOffer.rateId); + } + + @Override + public int hashCode() { + return Objects.hash(originalAmount, originalCurrency, amount, currency, exchangeRate, exchangeRateInverted, marginRate, rateSource, exchangeRateTimeUtc, exchangeRateExpirationTimeUtc, rateId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018OrderInformationCurrencyConversionOffer {\n"); + + if (originalAmount != null) sb.append(" originalAmount: ").append(toIndentedString(originalAmount)).append("\n"); + if (originalCurrency != null) sb.append(" originalCurrency: ").append(toIndentedString(originalCurrency)).append("\n"); + if (amount != null) sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + if (currency != null) sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + if (exchangeRate != null) sb.append(" exchangeRate: ").append(toIndentedString(exchangeRate)).append("\n"); + if (exchangeRateInverted != null) sb.append(" exchangeRateInverted: ").append(toIndentedString(exchangeRateInverted)).append("\n"); + if (marginRate != null) sb.append(" marginRate: ").append(toIndentedString(marginRate)).append("\n"); + if (rateSource != null) sb.append(" rateSource: ").append(toIndentedString(rateSource)).append("\n"); + if (exchangeRateTimeUtc != null) sb.append(" exchangeRateTimeUtc: ").append(toIndentedString(exchangeRateTimeUtc)).append("\n"); + if (exchangeRateExpirationTimeUtc != null) sb.append(" exchangeRateExpirationTimeUtc: ").append(toIndentedString(exchangeRateExpirationTimeUtc)).append("\n"); + if (rateId != null) sb.append(" rateId: ").append(toIndentedString(rateId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse2018ProcessorInformation.java b/src/main/java/Model/InlineResponse2018ProcessorInformation.java new file mode 100644 index 000000000..53191c301 --- /dev/null +++ b/src/main/java/Model/InlineResponse2018ProcessorInformation.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse2018ProcessorInformation + */ + +public class InlineResponse2018ProcessorInformation { + @SerializedName("responseCode") + private String responseCode = null; + + public InlineResponse2018ProcessorInformation responseCode(String responseCode) { + this.responseCode = responseCode; + return this; + } + + /** + * The error message sent directly from the currency conversion provider. Returned only when the provider returns this value. + * @return responseCode + **/ + @ApiModelProperty(value = "The error message sent directly from the currency conversion provider. Returned only when the provider returns this value. ") + public String getResponseCode() { + return responseCode; + } + + public void setResponseCode(String responseCode) { + this.responseCode = responseCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse2018ProcessorInformation inlineResponse2018ProcessorInformation = (InlineResponse2018ProcessorInformation) o; + return Objects.equals(this.responseCode, inlineResponse2018ProcessorInformation.responseCode); + } + + @Override + public int hashCode() { + return Objects.hash(responseCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse2018ProcessorInformation {\n"); + + if (responseCode != null) sb.append(" responseCode: ").append(toIndentedString(responseCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse40010.java b/src/main/java/Model/InlineResponse40010.java new file mode 100644 index 000000000..bfb0dca1f --- /dev/null +++ b/src/main/java/Model/InlineResponse40010.java @@ -0,0 +1,220 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.PushFunds400ResponseDetails; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * InlineResponse40010 + */ + +public class InlineResponse40010 { + @SerializedName("id") + private String id = null; + + @SerializedName("submitTimeUtc") + private String submitTimeUtc = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("reason") + private String reason = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("details") + private List details = null; + + public InlineResponse40010 id(String id) { + this.id = id; + return this; + } + + /** + * Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * @return id + **/ + @ApiModelProperty(required = true, value = "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public InlineResponse40010 submitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + return this; + } + + /** + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUtc + **/ + @ApiModelProperty(required = true, value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUtc() { + return submitTimeUtc; + } + + public void setSubmitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + } + + public InlineResponse40010 status(String status) { + this.status = status; + return this; + } + + /** + * Message describing the status of the currency conversion request. Possible values: - INVALID_REQUEST + * @return status + **/ + @ApiModelProperty(required = true, value = "Message describing the status of the currency conversion request. Possible values: - INVALID_REQUEST") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public InlineResponse40010 reason(String reason) { + this.reason = reason; + return this; + } + + /** + * The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA + * @return reason + **/ + @ApiModelProperty(value = "The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA") + public String getReason() { + return reason; + } + + public void setReason(String reason) { + this.reason = reason; + } + + public InlineResponse40010 message(String message) { + this.message = message; + return this; + } + + /** + * Descriptive message to add more detail to the status + * @return message + **/ + @ApiModelProperty(value = "Descriptive message to add more detail to the status ") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public InlineResponse40010 details(List details) { + this.details = details; + return this; + } + + public InlineResponse40010 addDetailsItem(PushFunds400ResponseDetails detailsItem) { + if (this.details == null) { + this.details = new ArrayList(); + } + this.details.add(detailsItem); + return this; + } + + /** + * Get details + * @return details + **/ + @ApiModelProperty(value = "") + public List getDetails() { + return details; + } + + public void setDetails(List details) { + this.details = details; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse40010 inlineResponse40010 = (InlineResponse40010) o; + return Objects.equals(this.id, inlineResponse40010.id) && + Objects.equals(this.submitTimeUtc, inlineResponse40010.submitTimeUtc) && + Objects.equals(this.status, inlineResponse40010.status) && + Objects.equals(this.reason, inlineResponse40010.reason) && + Objects.equals(this.message, inlineResponse40010.message) && + Objects.equals(this.details, inlineResponse40010.details); + } + + @Override + public int hashCode() { + return Objects.hash(id, submitTimeUtc, status, reason, message, details); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse40010 {\n"); + + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (submitTimeUtc != null) sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + if (status != null) sb.append(" status: ").append(toIndentedString(status)).append("\n"); + if (reason != null) sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + if (message != null) sb.append(" message: ").append(toIndentedString(message)).append("\n"); + if (details != null) sb.append(" details: ").append(toIndentedString(details)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse403Errors.java b/src/main/java/Model/InlineResponse403Errors.java index 764862c0a..40da6bdc8 100644 --- a/src/main/java/Model/InlineResponse403Errors.java +++ b/src/main/java/Model/InlineResponse403Errors.java @@ -36,10 +36,10 @@ public class InlineResponse403Errors { private String message = null; /** - * The type of error. Possible Values: - forbidden + * The type of error. Possible Values: - forbidden - declined * @return type **/ - @ApiModelProperty(value = "The type of error. Possible Values: - forbidden ") + @ApiModelProperty(value = "The type of error. Possible Values: - forbidden - declined ") public String getType() { return type; } diff --git a/src/main/java/Model/InlineResponse5022.java b/src/main/java/Model/InlineResponse5022.java new file mode 100644 index 000000000..f5d2e7bca --- /dev/null +++ b/src/main/java/Model/InlineResponse5022.java @@ -0,0 +1,186 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * InlineResponse5022 + */ + +public class InlineResponse5022 { + @SerializedName("id") + private String id = null; + + @SerializedName("submitTimeUtc") + private String submitTimeUtc = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("reason") + private String reason = null; + + @SerializedName("message") + private String message = null; + + public InlineResponse5022 id(String id) { + this.id = id; + return this; + } + + /** + * Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * @return id + **/ + @ApiModelProperty(value = "Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public InlineResponse5022 submitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + return this; + } + + /** + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUtc + **/ + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUtc() { + return submitTimeUtc; + } + + public void setSubmitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + } + + public InlineResponse5022 status(String status) { + this.status = status; + return this; + } + + /** + * Message describing the status of the currency conversion request. Possible values: - SERVER_ERROR + * @return status + **/ + @ApiModelProperty(required = true, value = "Message describing the status of the currency conversion request. Possible values: - SERVER_ERROR") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public InlineResponse5022 reason(String reason) { + this.reason = reason; + return this; + } + + /** + * Only required when offer cannot be made. The reason of the status. Only required when the requested action cannot be performed cannot be made. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT + * @return reason + **/ + @ApiModelProperty(value = "Only required when offer cannot be made. The reason of the status. Only required when the requested action cannot be performed cannot be made. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT ") + public String getReason() { + return reason; + } + + public void setReason(String reason) { + this.reason = reason; + } + + public InlineResponse5022 message(String message) { + this.message = message; + return this; + } + + /** + * The detail message related to the status and reason listed above. + * @return message + **/ + @ApiModelProperty(value = "The detail message related to the status and reason listed above. ") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse5022 inlineResponse5022 = (InlineResponse5022) o; + return Objects.equals(this.id, inlineResponse5022.id) && + Objects.equals(this.submitTimeUtc, inlineResponse5022.submitTimeUtc) && + Objects.equals(this.status, inlineResponse5022.status) && + Objects.equals(this.reason, inlineResponse5022.reason) && + Objects.equals(this.message, inlineResponse5022.message); + } + + @Override + public int hashCode() { + return Objects.hash(id, submitTimeUtc, status, reason, message); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse5022 {\n"); + + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (submitTimeUtc != null) sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + if (status != null) sb.append(" status: ").append(toIndentedString(status)).append("\n"); + if (reason != null) sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + if (message != null) sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/OfferRequest.java b/src/main/java/Model/OfferRequest.java new file mode 100644 index 000000000..ddf42e184 --- /dev/null +++ b/src/main/java/Model/OfferRequest.java @@ -0,0 +1,167 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Vasv1currencyconversionClientReferenceInformation; +import Model.Vasv1currencyconversionOrderInformation; +import Model.Vasv1currencyconversionPaymentInformation; +import Model.Vasv1currencyconversionPointOfSaleInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * OfferRequest + */ + +public class OfferRequest { + @SerializedName("clientReferenceInformation") + private Vasv1currencyconversionClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("paymentInformation") + private Vasv1currencyconversionPaymentInformation paymentInformation = null; + + @SerializedName("orderInformation") + private Vasv1currencyconversionOrderInformation orderInformation = null; + + @SerializedName("pointOfSaleInformation") + private Vasv1currencyconversionPointOfSaleInformation pointOfSaleInformation = null; + + public OfferRequest clientReferenceInformation(Vasv1currencyconversionClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(Vasv1currencyconversionClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public OfferRequest paymentInformation(Vasv1currencyconversionPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + return this; + } + + /** + * Get paymentInformation + * @return paymentInformation + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionPaymentInformation getPaymentInformation() { + return paymentInformation; + } + + public void setPaymentInformation(Vasv1currencyconversionPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + } + + public OfferRequest orderInformation(Vasv1currencyconversionOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Vasv1currencyconversionOrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public OfferRequest pointOfSaleInformation(Vasv1currencyconversionPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(Vasv1currencyconversionPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + OfferRequest offerRequest = (OfferRequest) o; + return Objects.equals(this.clientReferenceInformation, offerRequest.clientReferenceInformation) && + Objects.equals(this.paymentInformation, offerRequest.paymentInformation) && + Objects.equals(this.orderInformation, offerRequest.orderInformation) && + Objects.equals(this.pointOfSaleInformation, offerRequest.pointOfSaleInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation, paymentInformation, orderInformation, pointOfSaleInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class OfferRequest {\n"); + + if (clientReferenceInformation != null) sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + if (paymentInformation != null) sb.append(" paymentInformation: ").append(toIndentedString(paymentInformation)).append("\n"); + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + if (pointOfSaleInformation != null) sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/PatchInstrumentIdentifierRequest.java b/src/main/java/Model/PatchInstrumentIdentifierRequest.java index ed794447f..55eb5cd67 100644 --- a/src/main/java/Model/PatchInstrumentIdentifierRequest.java +++ b/src/main/java/Model/PatchInstrumentIdentifierRequest.java @@ -23,6 +23,7 @@ import Model.TmsEmbeddedInstrumentIdentifierIssuer; import Model.TmsEmbeddedInstrumentIdentifierLinks; import Model.TmsEmbeddedInstrumentIdentifierMetadata; +import Model.TmsEmbeddedInstrumentIdentifierPointOfSaleInformation; import Model.TmsEmbeddedInstrumentIdentifierProcessingInformation; import Model.Tmsv2TokenizedCard; import com.google.gson.TypeAdapter; @@ -54,12 +55,18 @@ public class PatchInstrumentIdentifierRequest { @SerializedName("type") private String type = null; + @SerializedName("source") + private String source = null; + @SerializedName("tokenProvisioningInformation") private Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation = null; @SerializedName("card") private TmsEmbeddedInstrumentIdentifierCard card = null; + @SerializedName("pointOfSaleInformation") + private TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation = null; + @SerializedName("bankAccount") private TmsEmbeddedInstrumentIdentifierBankAccount bankAccount = null; @@ -153,6 +160,24 @@ public void setType(String type) { this.type = type; } + public PatchInstrumentIdentifierRequest source(String source) { + this.source = source; + return this; + } + + /** + * Source of the card details. Possible Values: - CONTACTLESS_TAP + * @return source + **/ + @ApiModelProperty(value = "Source of the card details. Possible Values: - CONTACTLESS_TAP ") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + public PatchInstrumentIdentifierRequest tokenProvisioningInformation(Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation) { this.tokenProvisioningInformation = tokenProvisioningInformation; return this; @@ -189,6 +214,24 @@ public void setCard(TmsEmbeddedInstrumentIdentifierCard card) { this.card = card; } + public PatchInstrumentIdentifierRequest pointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + public PatchInstrumentIdentifierRequest bankAccount(TmsEmbeddedInstrumentIdentifierBankAccount bankAccount) { this.bankAccount = bankAccount; return this; @@ -330,8 +373,10 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.object, patchInstrumentIdentifierRequest.object) && Objects.equals(this.state, patchInstrumentIdentifierRequest.state) && Objects.equals(this.type, patchInstrumentIdentifierRequest.type) && + Objects.equals(this.source, patchInstrumentIdentifierRequest.source) && Objects.equals(this.tokenProvisioningInformation, patchInstrumentIdentifierRequest.tokenProvisioningInformation) && Objects.equals(this.card, patchInstrumentIdentifierRequest.card) && + Objects.equals(this.pointOfSaleInformation, patchInstrumentIdentifierRequest.pointOfSaleInformation) && Objects.equals(this.bankAccount, patchInstrumentIdentifierRequest.bankAccount) && Objects.equals(this.tokenizedCard, patchInstrumentIdentifierRequest.tokenizedCard) && Objects.equals(this.issuer, patchInstrumentIdentifierRequest.issuer) && @@ -343,7 +388,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(links, id, object, state, type, tokenProvisioningInformation, card, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); + return Objects.hash(links, id, object, state, type, source, tokenProvisioningInformation, card, pointOfSaleInformation, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); } @@ -357,8 +402,10 @@ public String toString() { if (object != null) sb.append(" object: ").append(toIndentedString(object)).append("\n"); if (state != null) sb.append(" state: ").append(toIndentedString(state)).append("\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (source != null) sb.append(" source: ").append(toIndentedString(source)).append("\n"); if (tokenProvisioningInformation != null) sb.append(" tokenProvisioningInformation: ").append(toIndentedString(tokenProvisioningInformation)).append("\n"); if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); + if (pointOfSaleInformation != null) sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); if (bankAccount != null) sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); if (tokenizedCard != null) sb.append(" tokenizedCard: ").append(toIndentedString(tokenizedCard)).append("\n"); if (issuer != null) sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); diff --git a/src/main/java/Model/PostInstrumentIdentifierEnrollmentRequest.java b/src/main/java/Model/PostInstrumentIdentifierEnrollmentRequest.java index 9543a6c95..b3bc80b65 100644 --- a/src/main/java/Model/PostInstrumentIdentifierEnrollmentRequest.java +++ b/src/main/java/Model/PostInstrumentIdentifierEnrollmentRequest.java @@ -23,6 +23,7 @@ import Model.TmsEmbeddedInstrumentIdentifierIssuer; import Model.TmsEmbeddedInstrumentIdentifierLinks; import Model.TmsEmbeddedInstrumentIdentifierMetadata; +import Model.TmsEmbeddedInstrumentIdentifierPointOfSaleInformation; import Model.TmsEmbeddedInstrumentIdentifierProcessingInformation; import Model.Tmsv2TokenizedCard; import com.google.gson.TypeAdapter; @@ -54,12 +55,18 @@ public class PostInstrumentIdentifierEnrollmentRequest { @SerializedName("type") private String type = null; + @SerializedName("source") + private String source = null; + @SerializedName("tokenProvisioningInformation") private Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation = null; @SerializedName("card") private TmsEmbeddedInstrumentIdentifierCard card = null; + @SerializedName("pointOfSaleInformation") + private TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation = null; + @SerializedName("bankAccount") private TmsEmbeddedInstrumentIdentifierBankAccount bankAccount = null; @@ -153,6 +160,24 @@ public void setType(String type) { this.type = type; } + public PostInstrumentIdentifierEnrollmentRequest source(String source) { + this.source = source; + return this; + } + + /** + * Source of the card details. Possible Values: - CONTACTLESS_TAP + * @return source + **/ + @ApiModelProperty(value = "Source of the card details. Possible Values: - CONTACTLESS_TAP ") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + public PostInstrumentIdentifierEnrollmentRequest tokenProvisioningInformation(Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation) { this.tokenProvisioningInformation = tokenProvisioningInformation; return this; @@ -189,6 +214,24 @@ public void setCard(TmsEmbeddedInstrumentIdentifierCard card) { this.card = card; } + public PostInstrumentIdentifierEnrollmentRequest pointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + public PostInstrumentIdentifierEnrollmentRequest bankAccount(TmsEmbeddedInstrumentIdentifierBankAccount bankAccount) { this.bankAccount = bankAccount; return this; @@ -330,8 +373,10 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.object, postInstrumentIdentifierEnrollmentRequest.object) && Objects.equals(this.state, postInstrumentIdentifierEnrollmentRequest.state) && Objects.equals(this.type, postInstrumentIdentifierEnrollmentRequest.type) && + Objects.equals(this.source, postInstrumentIdentifierEnrollmentRequest.source) && Objects.equals(this.tokenProvisioningInformation, postInstrumentIdentifierEnrollmentRequest.tokenProvisioningInformation) && Objects.equals(this.card, postInstrumentIdentifierEnrollmentRequest.card) && + Objects.equals(this.pointOfSaleInformation, postInstrumentIdentifierEnrollmentRequest.pointOfSaleInformation) && Objects.equals(this.bankAccount, postInstrumentIdentifierEnrollmentRequest.bankAccount) && Objects.equals(this.tokenizedCard, postInstrumentIdentifierEnrollmentRequest.tokenizedCard) && Objects.equals(this.issuer, postInstrumentIdentifierEnrollmentRequest.issuer) && @@ -343,7 +388,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(links, id, object, state, type, tokenProvisioningInformation, card, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); + return Objects.hash(links, id, object, state, type, source, tokenProvisioningInformation, card, pointOfSaleInformation, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); } @@ -357,8 +402,10 @@ public String toString() { if (object != null) sb.append(" object: ").append(toIndentedString(object)).append("\n"); if (state != null) sb.append(" state: ").append(toIndentedString(state)).append("\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (source != null) sb.append(" source: ").append(toIndentedString(source)).append("\n"); if (tokenProvisioningInformation != null) sb.append(" tokenProvisioningInformation: ").append(toIndentedString(tokenProvisioningInformation)).append("\n"); if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); + if (pointOfSaleInformation != null) sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); if (bankAccount != null) sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); if (tokenizedCard != null) sb.append(" tokenizedCard: ").append(toIndentedString(tokenizedCard)).append("\n"); if (issuer != null) sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); diff --git a/src/main/java/Model/PostInstrumentIdentifierRequest.java b/src/main/java/Model/PostInstrumentIdentifierRequest.java index a10272b94..08d570ea4 100644 --- a/src/main/java/Model/PostInstrumentIdentifierRequest.java +++ b/src/main/java/Model/PostInstrumentIdentifierRequest.java @@ -23,6 +23,7 @@ import Model.TmsEmbeddedInstrumentIdentifierIssuer; import Model.TmsEmbeddedInstrumentIdentifierLinks; import Model.TmsEmbeddedInstrumentIdentifierMetadata; +import Model.TmsEmbeddedInstrumentIdentifierPointOfSaleInformation; import Model.TmsEmbeddedInstrumentIdentifierProcessingInformation; import Model.Tmsv2TokenizedCard; import com.google.gson.TypeAdapter; @@ -54,12 +55,18 @@ public class PostInstrumentIdentifierRequest { @SerializedName("type") private String type = null; + @SerializedName("source") + private String source = null; + @SerializedName("tokenProvisioningInformation") private Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation = null; @SerializedName("card") private TmsEmbeddedInstrumentIdentifierCard card = null; + @SerializedName("pointOfSaleInformation") + private TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation = null; + @SerializedName("bankAccount") private TmsEmbeddedInstrumentIdentifierBankAccount bankAccount = null; @@ -153,6 +160,24 @@ public void setType(String type) { this.type = type; } + public PostInstrumentIdentifierRequest source(String source) { + this.source = source; + return this; + } + + /** + * Source of the card details. Possible Values: - CONTACTLESS_TAP + * @return source + **/ + @ApiModelProperty(value = "Source of the card details. Possible Values: - CONTACTLESS_TAP ") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + public PostInstrumentIdentifierRequest tokenProvisioningInformation(Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation) { this.tokenProvisioningInformation = tokenProvisioningInformation; return this; @@ -189,6 +214,24 @@ public void setCard(TmsEmbeddedInstrumentIdentifierCard card) { this.card = card; } + public PostInstrumentIdentifierRequest pointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + public PostInstrumentIdentifierRequest bankAccount(TmsEmbeddedInstrumentIdentifierBankAccount bankAccount) { this.bankAccount = bankAccount; return this; @@ -330,8 +373,10 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.object, postInstrumentIdentifierRequest.object) && Objects.equals(this.state, postInstrumentIdentifierRequest.state) && Objects.equals(this.type, postInstrumentIdentifierRequest.type) && + Objects.equals(this.source, postInstrumentIdentifierRequest.source) && Objects.equals(this.tokenProvisioningInformation, postInstrumentIdentifierRequest.tokenProvisioningInformation) && Objects.equals(this.card, postInstrumentIdentifierRequest.card) && + Objects.equals(this.pointOfSaleInformation, postInstrumentIdentifierRequest.pointOfSaleInformation) && Objects.equals(this.bankAccount, postInstrumentIdentifierRequest.bankAccount) && Objects.equals(this.tokenizedCard, postInstrumentIdentifierRequest.tokenizedCard) && Objects.equals(this.issuer, postInstrumentIdentifierRequest.issuer) && @@ -343,7 +388,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(links, id, object, state, type, tokenProvisioningInformation, card, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); + return Objects.hash(links, id, object, state, type, source, tokenProvisioningInformation, card, pointOfSaleInformation, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); } @@ -357,8 +402,10 @@ public String toString() { if (object != null) sb.append(" object: ").append(toIndentedString(object)).append("\n"); if (state != null) sb.append(" state: ").append(toIndentedString(state)).append("\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (source != null) sb.append(" source: ").append(toIndentedString(source)).append("\n"); if (tokenProvisioningInformation != null) sb.append(" tokenProvisioningInformation: ").append(toIndentedString(tokenProvisioningInformation)).append("\n"); if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); + if (pointOfSaleInformation != null) sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); if (bankAccount != null) sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); if (tokenizedCard != null) sb.append(" tokenizedCard: ").append(toIndentedString(tokenizedCard)).append("\n"); if (issuer != null) sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); diff --git a/src/main/java/Model/PostIssuerLifeCycleSimulationRequest.java b/src/main/java/Model/PostIssuerLifeCycleSimulationRequest.java deleted file mode 100644 index 3bebd063c..000000000 --- a/src/main/java/Model/PostIssuerLifeCycleSimulationRequest.java +++ /dev/null @@ -1,143 +0,0 @@ -/* - * CyberSource Merged Spec - * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import java.util.Arrays; -import Model.Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard; -import Model.Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Represents the Issuer LifeCycle Event Simulation for a Tokenized Card. - */ -@ApiModel(description = "Represents the Issuer LifeCycle Event Simulation for a Tokenized Card. ") - -public class PostIssuerLifeCycleSimulationRequest { - @SerializedName("state") - private String state = null; - - @SerializedName("card") - private Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard card = null; - - @SerializedName("metadata") - private Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata metadata = null; - - public PostIssuerLifeCycleSimulationRequest state(String state) { - this.state = state; - return this; - } - - /** - * The new state of the Tokenized Card. Possible Values: - ACTIVE - SUSPENDED - DELETED - * @return state - **/ - @ApiModelProperty(value = "The new state of the Tokenized Card. Possible Values: - ACTIVE - SUSPENDED - DELETED ") - public String getState() { - return state; - } - - public void setState(String state) { - this.state = state; - } - - public PostIssuerLifeCycleSimulationRequest card(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard card) { - this.card = card; - return this; - } - - /** - * Get card - * @return card - **/ - @ApiModelProperty(value = "") - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard getCard() { - return card; - } - - public void setCard(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard card) { - this.card = card; - } - - public PostIssuerLifeCycleSimulationRequest metadata(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata metadata) { - this.metadata = metadata; - return this; - } - - /** - * Get metadata - * @return metadata - **/ - @ApiModelProperty(value = "") - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata getMetadata() { - return metadata; - } - - public void setMetadata(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata metadata) { - this.metadata = metadata; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest = (PostIssuerLifeCycleSimulationRequest) o; - return Objects.equals(this.state, postIssuerLifeCycleSimulationRequest.state) && - Objects.equals(this.card, postIssuerLifeCycleSimulationRequest.card) && - Objects.equals(this.metadata, postIssuerLifeCycleSimulationRequest.metadata); - } - - @Override - public int hashCode() { - return Objects.hash(state, card, metadata); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PostIssuerLifeCycleSimulationRequest {\n"); - - if (state != null) sb.append(" state: ").append(toIndentedString(state)).append("\n"); - if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); - if (metadata != null) sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - // return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/PostPaymentCredentialsRequest.java b/src/main/java/Model/PostPaymentCredentialsRequest.java index 01e875d1c..87bd42335 100644 --- a/src/main/java/Model/PostPaymentCredentialsRequest.java +++ b/src/main/java/Model/PostPaymentCredentialsRequest.java @@ -15,6 +15,10 @@ import java.util.Objects; import java.util.Arrays; +import Model.Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities; +import Model.Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation; +import Model.Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation; +import Model.Tmsv2tokenstokenIdpaymentcredentialsOrderInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -23,6 +27,8 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.ArrayList; +import java.util.List; /** * PostPaymentCredentialsRequest @@ -35,6 +41,21 @@ public class PostPaymentCredentialsRequest { @SerializedName("transactionType") private String transactionType = null; + @SerializedName("clientCorrelationId") + private String clientCorrelationId = null; + + @SerializedName("orderInformation") + private Tmsv2tokenstokenIdpaymentcredentialsOrderInformation orderInformation = null; + + @SerializedName("merchantInformation") + private Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation merchantInformation = null; + + @SerializedName("deviceInformation") + private Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation deviceInformation = null; + + @SerializedName("authenticatedIdentities") + private List authenticatedIdentities = null; + public PostPaymentCredentialsRequest paymentCredentialType(String paymentCredentialType) { this.paymentCredentialType = paymentCredentialType; return this; @@ -44,7 +65,7 @@ public PostPaymentCredentialsRequest paymentCredentialType(String paymentCredent * 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 * @return paymentCredentialType **/ - @ApiModelProperty(value = "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 ") + @ApiModelProperty(example = "CRYPTOGRAM", value = "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 ") public String getPaymentCredentialType() { return paymentCredentialType; } @@ -62,7 +83,7 @@ public PostPaymentCredentialsRequest transactionType(String transactionType) { * Specifies the type of transaction for which the network token credentials are required. Possible Values: - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default. - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM. * @return transactionType **/ - @ApiModelProperty(value = "Specifies the type of transaction for which the network token credentials are required. Possible Values: - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default. - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM. ") + @ApiModelProperty(example = "ECOM", value = "Specifies the type of transaction for which the network token credentials are required. Possible Values: - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default. - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM. ") public String getTransactionType() { return transactionType; } @@ -71,6 +92,104 @@ public void setTransactionType(String transactionType) { this.transactionType = transactionType; } + public PostPaymentCredentialsRequest clientCorrelationId(String clientCorrelationId) { + this.clientCorrelationId = clientCorrelationId; + return this; + } + + /** + * Used to correlate authentication and payment credential requests. + * @return clientCorrelationId + **/ + @ApiModelProperty(example = "ad30cf0c-b825-42ca-806c-bf06094b0b15", value = "Used to correlate authentication and payment credential requests. ") + public String getClientCorrelationId() { + return clientCorrelationId; + } + + public void setClientCorrelationId(String clientCorrelationId) { + this.clientCorrelationId = clientCorrelationId; + } + + public PostPaymentCredentialsRequest orderInformation(Tmsv2tokenstokenIdpaymentcredentialsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Tmsv2tokenstokenIdpaymentcredentialsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public PostPaymentCredentialsRequest merchantInformation(Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + return this; + } + + /** + * Get merchantInformation + * @return merchantInformation + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation getMerchantInformation() { + return merchantInformation; + } + + public void setMerchantInformation(Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + } + + public PostPaymentCredentialsRequest deviceInformation(Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation deviceInformation) { + this.deviceInformation = deviceInformation; + return this; + } + + /** + * Get deviceInformation + * @return deviceInformation + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation getDeviceInformation() { + return deviceInformation; + } + + public void setDeviceInformation(Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation deviceInformation) { + this.deviceInformation = deviceInformation; + } + + public PostPaymentCredentialsRequest authenticatedIdentities(List authenticatedIdentities) { + this.authenticatedIdentities = authenticatedIdentities; + return this; + } + + public PostPaymentCredentialsRequest addAuthenticatedIdentitiesItem(Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities authenticatedIdentitiesItem) { + if (this.authenticatedIdentities == null) { + this.authenticatedIdentities = new ArrayList(); + } + this.authenticatedIdentities.add(authenticatedIdentitiesItem); + return this; + } + + /** + * Get authenticatedIdentities + * @return authenticatedIdentities + **/ + @ApiModelProperty(value = "") + public List getAuthenticatedIdentities() { + return authenticatedIdentities; + } + + public void setAuthenticatedIdentities(List authenticatedIdentities) { + this.authenticatedIdentities = authenticatedIdentities; + } + @Override public boolean equals(java.lang.Object o) { @@ -82,12 +201,17 @@ public boolean equals(java.lang.Object o) { } PostPaymentCredentialsRequest postPaymentCredentialsRequest = (PostPaymentCredentialsRequest) o; return Objects.equals(this.paymentCredentialType, postPaymentCredentialsRequest.paymentCredentialType) && - Objects.equals(this.transactionType, postPaymentCredentialsRequest.transactionType); + Objects.equals(this.transactionType, postPaymentCredentialsRequest.transactionType) && + Objects.equals(this.clientCorrelationId, postPaymentCredentialsRequest.clientCorrelationId) && + Objects.equals(this.orderInformation, postPaymentCredentialsRequest.orderInformation) && + Objects.equals(this.merchantInformation, postPaymentCredentialsRequest.merchantInformation) && + Objects.equals(this.deviceInformation, postPaymentCredentialsRequest.deviceInformation) && + Objects.equals(this.authenticatedIdentities, postPaymentCredentialsRequest.authenticatedIdentities); } @Override public int hashCode() { - return Objects.hash(paymentCredentialType, transactionType); + return Objects.hash(paymentCredentialType, transactionType, clientCorrelationId, orderInformation, merchantInformation, deviceInformation, authenticatedIdentities); } @@ -98,6 +222,11 @@ public String toString() { if (paymentCredentialType != null) sb.append(" paymentCredentialType: ").append(toIndentedString(paymentCredentialType)).append("\n"); if (transactionType != null) sb.append(" transactionType: ").append(toIndentedString(transactionType)).append("\n"); + if (clientCorrelationId != null) sb.append(" clientCorrelationId: ").append(toIndentedString(clientCorrelationId)).append("\n"); + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + if (merchantInformation != null) sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); + if (deviceInformation != null) sb.append(" deviceInformation: ").append(toIndentedString(deviceInformation)).append("\n"); + if (authenticatedIdentities != null) sb.append(" authenticatedIdentities: ").append(toIndentedString(authenticatedIdentities)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java index cbb530d27..7697b281b 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java @@ -44,10 +44,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice code(Strin } /** - * - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | + * - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company * @return code **/ - @ApiModelProperty(value = "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | ") + @ApiModelProperty(value = "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company ") public String getCode() { return code; } @@ -62,10 +62,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice codeRaw(St } /** - * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code + * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme * @return codeRaw **/ - @ApiModelProperty(value = "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code ") + @ApiModelProperty(value = "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme ") public String getCodeRaw() { return codeRaw; } diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java index 331b48941..a5f51ca6b 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java @@ -16,6 +16,7 @@ import java.util.Objects; import java.util.Arrays; import Model.PtsV2PaymentsPost201ResponseProcessorInformationAchVerification; +import Model.PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice; import Model.Ptsv2paymentsProcessorInformationReversalNetwork; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -61,6 +62,9 @@ public class PtsV2PaymentsRefundPost201ResponseProcessorInformation { @SerializedName("network") private Ptsv2paymentsProcessorInformationReversalNetwork network = null; + @SerializedName("merchantAdvice") + private PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice = null; + public PtsV2PaymentsRefundPost201ResponseProcessorInformation approvalCode(String approvalCode) { this.approvalCode = approvalCode; return this; @@ -241,6 +245,24 @@ public void setNetwork(Ptsv2paymentsProcessorInformationReversalNetwork network) this.network = network; } + public PtsV2PaymentsRefundPost201ResponseProcessorInformation merchantAdvice(PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice) { + this.merchantAdvice = merchantAdvice; + return this; + } + + /** + * Get merchantAdvice + * @return merchantAdvice + **/ + @ApiModelProperty(value = "") + public PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice getMerchantAdvice() { + return merchantAdvice; + } + + public void setMerchantAdvice(PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice) { + this.merchantAdvice = merchantAdvice; + } + @Override public boolean equals(java.lang.Object o) { @@ -260,12 +282,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.networkTransactionId, ptsV2PaymentsRefundPost201ResponseProcessorInformation.networkTransactionId) && Objects.equals(this.settlementDate, ptsV2PaymentsRefundPost201ResponseProcessorInformation.settlementDate) && Objects.equals(this.updateTimeUtc, ptsV2PaymentsRefundPost201ResponseProcessorInformation.updateTimeUtc) && - Objects.equals(this.network, ptsV2PaymentsRefundPost201ResponseProcessorInformation.network); + Objects.equals(this.network, ptsV2PaymentsRefundPost201ResponseProcessorInformation.network) && + Objects.equals(this.merchantAdvice, ptsV2PaymentsRefundPost201ResponseProcessorInformation.merchantAdvice); } @Override public int hashCode() { - return Objects.hash(approvalCode, transactionId, forwardedAcquirerCode, merchantNumber, responseCode, achVerification, networkTransactionId, settlementDate, updateTimeUtc, network); + return Objects.hash(approvalCode, transactionId, forwardedAcquirerCode, merchantNumber, responseCode, achVerification, networkTransactionId, settlementDate, updateTimeUtc, network, merchantAdvice); } @@ -284,6 +307,7 @@ public String toString() { if (settlementDate != null) sb.append(" settlementDate: ").append(toIndentedString(settlementDate)).append("\n"); if (updateTimeUtc != null) sb.append(" updateTimeUtc: ").append(toIndentedString(updateTimeUtc)).append("\n"); if (network != null) sb.append(" network: ").append(toIndentedString(network)).append("\n"); + if (merchantAdvice != null) sb.append(" merchantAdvice: ").append(toIndentedString(merchantAdvice)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.java new file mode 100644 index 000000000..d6a2ef975 --- /dev/null +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice + */ + +public class PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice { + @SerializedName("code") + private String code = null; + + @SerializedName("codeRaw") + private String codeRaw = null; + + public PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice code(String code) { + this.code = code; + return this; + } + + /** + * - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company + * @return code + **/ + @ApiModelProperty(value = "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | #### Possbile values for Barclays processor: - 00: No information, or response not provided. - 01: New account information available - 02: Try again later - 03: Do not try again - 05: Payment blocked by the payment card company ") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice codeRaw(String codeRaw) { + this.codeRaw = codeRaw; + return this; + } + + /** + * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme + * @return codeRaw + **/ + @ApiModelProperty(value = "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme ") + public String getCodeRaw() { + return codeRaw; + } + + public void setCodeRaw(String codeRaw) { + this.codeRaw = codeRaw; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice ptsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice = (PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice) o; + return Objects.equals(this.code, ptsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.code) && + Objects.equals(this.codeRaw, ptsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice.codeRaw); + } + + @Override + public int hashCode() { + return Objects.hash(code, codeRaw); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice {\n"); + + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + if (codeRaw != null) sb.append(" codeRaw: ").append(toIndentedString(codeRaw)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java index aedfa9f72..247b9a87c 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java @@ -15,6 +15,7 @@ import java.util.Objects; import java.util.Arrays; +import Model.PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -44,6 +45,9 @@ public class PtsV2PayoutsPost201ResponseProcessorInformation { @SerializedName("responseCodeSource") private String responseCodeSource = null; + @SerializedName("merchantAdvice") + private PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice = null; + public PtsV2PayoutsPost201ResponseProcessorInformation approvalCode(String approvalCode) { this.approvalCode = approvalCode; return this; @@ -134,6 +138,24 @@ public void setResponseCodeSource(String responseCodeSource) { this.responseCodeSource = responseCodeSource; } + public PtsV2PayoutsPost201ResponseProcessorInformation merchantAdvice(PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice) { + this.merchantAdvice = merchantAdvice; + return this; + } + + /** + * Get merchantAdvice + * @return merchantAdvice + **/ + @ApiModelProperty(value = "") + public PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice getMerchantAdvice() { + return merchantAdvice; + } + + public void setMerchantAdvice(PtsV2PaymentsRefundPost201ResponseProcessorInformationMerchantAdvice merchantAdvice) { + this.merchantAdvice = merchantAdvice; + } + @Override public boolean equals(java.lang.Object o) { @@ -148,12 +170,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.responseCode, ptsV2PayoutsPost201ResponseProcessorInformation.responseCode) && Objects.equals(this.transactionId, ptsV2PayoutsPost201ResponseProcessorInformation.transactionId) && Objects.equals(this.systemTraceAuditNumber, ptsV2PayoutsPost201ResponseProcessorInformation.systemTraceAuditNumber) && - Objects.equals(this.responseCodeSource, ptsV2PayoutsPost201ResponseProcessorInformation.responseCodeSource); + Objects.equals(this.responseCodeSource, ptsV2PayoutsPost201ResponseProcessorInformation.responseCodeSource) && + Objects.equals(this.merchantAdvice, ptsV2PayoutsPost201ResponseProcessorInformation.merchantAdvice); } @Override public int hashCode() { - return Objects.hash(approvalCode, responseCode, transactionId, systemTraceAuditNumber, responseCodeSource); + return Objects.hash(approvalCode, responseCode, transactionId, systemTraceAuditNumber, responseCodeSource, merchantAdvice); } @@ -167,6 +190,7 @@ public String toString() { if (transactionId != null) sb.append(" transactionId: ").append(toIndentedString(transactionId)).append("\n"); if (systemTraceAuditNumber != null) sb.append(" systemTraceAuditNumber: ").append(toIndentedString(systemTraceAuditNumber)).append("\n"); if (responseCodeSource != null) sb.append(" responseCodeSource: ").append(toIndentedString(responseCodeSource)).append("\n"); + if (merchantAdvice != null) sb.append(" merchantAdvice: ").append(toIndentedString(merchantAdvice)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Ptsv2paymentsProcessorInformation.java b/src/main/java/Model/Ptsv2paymentsProcessorInformation.java index ba2daa419..6e673f633 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessorInformation.java +++ b/src/main/java/Model/Ptsv2paymentsProcessorInformation.java @@ -45,6 +45,9 @@ public class Ptsv2paymentsProcessorInformation { @SerializedName("network") private Ptsv2paymentsProcessorInformationReversalNetwork network = null; + @SerializedName("responseSourceCode") + private String responseSourceCode = null; + public Ptsv2paymentsProcessorInformation preApprovalToken(String preApprovalToken) { this.preApprovalToken = preApprovalToken; return this; @@ -117,6 +120,24 @@ public void setNetwork(Ptsv2paymentsProcessorInformationReversalNetwork network) this.network = network; } + public Ptsv2paymentsProcessorInformation responseSourceCode(String responseSourceCode) { + this.responseSourceCode = responseSourceCode; + return this; + } + + /** + * Field contains the response source code that identifies the source. + * @return responseSourceCode + **/ + @ApiModelProperty(value = "Field contains the response source code that identifies the source. ") + public String getResponseSourceCode() { + return responseSourceCode; + } + + public void setResponseSourceCode(String responseSourceCode) { + this.responseSourceCode = responseSourceCode; + } + @Override public boolean equals(java.lang.Object o) { @@ -130,12 +151,13 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.preApprovalToken, ptsv2paymentsProcessorInformation.preApprovalToken) && Objects.equals(this.authorizationOptions, ptsv2paymentsProcessorInformation.authorizationOptions) && Objects.equals(this.reversal, ptsv2paymentsProcessorInformation.reversal) && - Objects.equals(this.network, ptsv2paymentsProcessorInformation.network); + Objects.equals(this.network, ptsv2paymentsProcessorInformation.network) && + Objects.equals(this.responseSourceCode, ptsv2paymentsProcessorInformation.responseSourceCode); } @Override public int hashCode() { - return Objects.hash(preApprovalToken, authorizationOptions, reversal, network); + return Objects.hash(preApprovalToken, authorizationOptions, reversal, network, responseSourceCode); } @@ -148,6 +170,7 @@ public String toString() { if (authorizationOptions != null) sb.append(" authorizationOptions: ").append(toIndentedString(authorizationOptions)).append("\n"); if (reversal != null) sb.append(" reversal: ").append(toIndentedString(reversal)).append("\n"); if (network != null) sb.append(" network: ").append(toIndentedString(network)).append("\n"); + if (responseSourceCode != null) sb.append(" responseSourceCode: ").append(toIndentedString(responseSourceCode)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java index ef380ba3a..95bc03c59 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java @@ -19,6 +19,7 @@ import Model.Ptsv2paymentsProcessingInformationLoanOptions; import Model.Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions; import Model.Ptsv2paymentsidcapturesProcessingInformationCaptureOptions; +import Model.Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -74,6 +75,9 @@ public class Ptsv2paymentsidcapturesProcessingInformation { @SerializedName("actionList") private List actionList = null; + @SerializedName("japanPaymentOptions") + private Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions japanPaymentOptions = null; + public Ptsv2paymentsidcapturesProcessingInformation paymentSolution(String paymentSolution) { this.paymentSolution = paymentSolution; return this; @@ -316,6 +320,24 @@ public void setActionList(List actionList) { this.actionList = actionList; } + public Ptsv2paymentsidcapturesProcessingInformation japanPaymentOptions(Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions japanPaymentOptions) { + this.japanPaymentOptions = japanPaymentOptions; + return this; + } + + /** + * Get japanPaymentOptions + * @return japanPaymentOptions + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions getJapanPaymentOptions() { + return japanPaymentOptions; + } + + public void setJapanPaymentOptions(Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions japanPaymentOptions) { + this.japanPaymentOptions = japanPaymentOptions; + } + @Override public boolean equals(java.lang.Object o) { @@ -338,12 +360,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.captureOptions, ptsv2paymentsidcapturesProcessingInformation.captureOptions) && Objects.equals(this.loanOptions, ptsv2paymentsidcapturesProcessingInformation.loanOptions) && Objects.equals(this.payByPointsIndicator, ptsv2paymentsidcapturesProcessingInformation.payByPointsIndicator) && - Objects.equals(this.actionList, ptsv2paymentsidcapturesProcessingInformation.actionList); + Objects.equals(this.actionList, ptsv2paymentsidcapturesProcessingInformation.actionList) && + Objects.equals(this.japanPaymentOptions, ptsv2paymentsidcapturesProcessingInformation.japanPaymentOptions); } @Override public int hashCode() { - return Objects.hash(paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, industryDataType, issuer, authorizationOptions, captureOptions, loanOptions, payByPointsIndicator, actionList); + return Objects.hash(paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, industryDataType, issuer, authorizationOptions, captureOptions, loanOptions, payByPointsIndicator, actionList, japanPaymentOptions); } @@ -365,6 +388,7 @@ public String toString() { if (loanOptions != null) sb.append(" loanOptions: ").append(toIndentedString(loanOptions)).append("\n"); if (payByPointsIndicator != null) sb.append(" payByPointsIndicator: ").append(toIndentedString(payByPointsIndicator)).append("\n"); if (actionList != null) sb.append(" actionList: ").append(toIndentedString(actionList)).append("\n"); + if (japanPaymentOptions != null) sb.append(" japanPaymentOptions: ").append(toIndentedString(japanPaymentOptions)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.java new file mode 100644 index 000000000..3a18f4cce --- /dev/null +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.java @@ -0,0 +1,255 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions + */ + +public class Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions { + @SerializedName("paymentMethod") + private String paymentMethod = null; + + @SerializedName("bonuses") + private String bonuses = null; + + @SerializedName("installments") + private String installments = null; + + @SerializedName("firstBillingMonth") + private String firstBillingMonth = null; + + @SerializedName("bonusAmount") + private String bonusAmount = null; + + @SerializedName("bonusMonth") + private String bonusMonth = null; + + @SerializedName("secondBonusAmount") + private String secondBonusAmount = null; + + @SerializedName("secondBonusMonth") + private String secondBonusMonth = null; + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions paymentMethod(String paymentMethod) { + this.paymentMethod = paymentMethod; + return this; + } + + /** + * This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) + * @return paymentMethod + **/ + @ApiModelProperty(value = "This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) ") + public String getPaymentMethod() { + return paymentMethod; + } + + public void setPaymentMethod(String paymentMethod) { + this.paymentMethod = paymentMethod; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions bonuses(String bonuses) { + this.bonuses = bonuses; + return this; + } + + /** + * Field contains the number of bonuses. + * @return bonuses + **/ + @ApiModelProperty(value = "Field contains the number of bonuses. ") + public String getBonuses() { + return bonuses; + } + + public void setBonuses(String bonuses) { + this.bonuses = bonuses; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions installments(String installments) { + this.installments = installments; + return this; + } + + /** + * Number of Installments. + * @return installments + **/ + @ApiModelProperty(value = "Number of Installments. ") + public String getInstallments() { + return installments; + } + + public void setInstallments(String installments) { + this.installments = installments; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions firstBillingMonth(String firstBillingMonth) { + this.firstBillingMonth = firstBillingMonth; + return this; + } + + /** + * Billing month in MM format. + * @return firstBillingMonth + **/ + @ApiModelProperty(value = "Billing month in MM format. ") + public String getFirstBillingMonth() { + return firstBillingMonth; + } + + public void setFirstBillingMonth(String firstBillingMonth) { + this.firstBillingMonth = firstBillingMonth; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions bonusAmount(String bonusAmount) { + this.bonusAmount = bonusAmount; + return this; + } + + /** + * This field contains the bonus amount. + * @return bonusAmount + **/ + @ApiModelProperty(value = "This field contains the bonus amount. ") + public String getBonusAmount() { + return bonusAmount; + } + + public void setBonusAmount(String bonusAmount) { + this.bonusAmount = bonusAmount; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions bonusMonth(String bonusMonth) { + this.bonusMonth = bonusMonth; + return this; + } + + /** + * This field contains the Japan specific first bonus month. + * @return bonusMonth + **/ + @ApiModelProperty(value = "This field contains the Japan specific first bonus month. ") + public String getBonusMonth() { + return bonusMonth; + } + + public void setBonusMonth(String bonusMonth) { + this.bonusMonth = bonusMonth; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions secondBonusAmount(String secondBonusAmount) { + this.secondBonusAmount = secondBonusAmount; + return this; + } + + /** + * Field contains the second bonus amount. + * @return secondBonusAmount + **/ + @ApiModelProperty(value = "Field contains the second bonus amount. ") + public String getSecondBonusAmount() { + return secondBonusAmount; + } + + public void setSecondBonusAmount(String secondBonusAmount) { + this.secondBonusAmount = secondBonusAmount; + } + + public Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions secondBonusMonth(String secondBonusMonth) { + this.secondBonusMonth = secondBonusMonth; + return this; + } + + /** + * Field contains the Japan specific second bonus month. + * @return secondBonusMonth + **/ + @ApiModelProperty(value = "Field contains the Japan specific second bonus month. ") + public String getSecondBonusMonth() { + return secondBonusMonth; + } + + public void setSecondBonusMonth(String secondBonusMonth) { + this.secondBonusMonth = secondBonusMonth; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions = (Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions) o; + return Objects.equals(this.paymentMethod, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.paymentMethod) && + Objects.equals(this.bonuses, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.bonuses) && + Objects.equals(this.installments, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.installments) && + Objects.equals(this.firstBillingMonth, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.firstBillingMonth) && + Objects.equals(this.bonusAmount, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.bonusAmount) && + Objects.equals(this.bonusMonth, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.bonusMonth) && + Objects.equals(this.secondBonusAmount, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.secondBonusAmount) && + Objects.equals(this.secondBonusMonth, ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions.secondBonusMonth); + } + + @Override + public int hashCode() { + return Objects.hash(paymentMethod, bonuses, installments, firstBillingMonth, bonusAmount, bonusMonth, secondBonusAmount, secondBonusMonth); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Ptsv2paymentsidcapturesProcessingInformationJapanPaymentOptions {\n"); + + if (paymentMethod != null) sb.append(" paymentMethod: ").append(toIndentedString(paymentMethod)).append("\n"); + if (bonuses != null) sb.append(" bonuses: ").append(toIndentedString(bonuses)).append("\n"); + if (installments != null) sb.append(" installments: ").append(toIndentedString(installments)).append("\n"); + if (firstBillingMonth != null) sb.append(" firstBillingMonth: ").append(toIndentedString(firstBillingMonth)).append("\n"); + if (bonusAmount != null) sb.append(" bonusAmount: ").append(toIndentedString(bonusAmount)).append("\n"); + if (bonusMonth != null) sb.append(" bonusMonth: ").append(toIndentedString(bonusMonth)).append("\n"); + if (secondBonusAmount != null) sb.append(" secondBonusAmount: ").append(toIndentedString(secondBonusAmount)).append("\n"); + if (secondBonusMonth != null) sb.append(" secondBonusMonth: ").append(toIndentedString(secondBonusMonth)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessorInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessorInformation.java new file mode 100644 index 000000000..c1e7715a8 --- /dev/null +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessorInformation.java @@ -0,0 +1,118 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Ptsv2paymentsProcessorInformationReversalNetwork; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Ptsv2paymentsidcapturesProcessorInformation + */ + +public class Ptsv2paymentsidcapturesProcessorInformation { + @SerializedName("network") + private Ptsv2paymentsProcessorInformationReversalNetwork network = null; + + @SerializedName("responseSourceCode") + private String responseSourceCode = null; + + public Ptsv2paymentsidcapturesProcessorInformation network(Ptsv2paymentsProcessorInformationReversalNetwork network) { + this.network = network; + return this; + } + + /** + * Get network + * @return network + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsProcessorInformationReversalNetwork getNetwork() { + return network; + } + + public void setNetwork(Ptsv2paymentsProcessorInformationReversalNetwork network) { + this.network = network; + } + + public Ptsv2paymentsidcapturesProcessorInformation responseSourceCode(String responseSourceCode) { + this.responseSourceCode = responseSourceCode; + return this; + } + + /** + * Field contains the response source code that identifies the source. + * @return responseSourceCode + **/ + @ApiModelProperty(value = "Field contains the response source code that identifies the source. ") + public String getResponseSourceCode() { + return responseSourceCode; + } + + public void setResponseSourceCode(String responseSourceCode) { + this.responseSourceCode = responseSourceCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Ptsv2paymentsidcapturesProcessorInformation ptsv2paymentsidcapturesProcessorInformation = (Ptsv2paymentsidcapturesProcessorInformation) o; + return Objects.equals(this.network, ptsv2paymentsidcapturesProcessorInformation.network) && + Objects.equals(this.responseSourceCode, ptsv2paymentsidcapturesProcessorInformation.responseSourceCode); + } + + @Override + public int hashCode() { + return Objects.hash(network, responseSourceCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Ptsv2paymentsidcapturesProcessorInformation {\n"); + + if (network != null) sb.append(" network: ").append(toIndentedString(network)).append("\n"); + if (responseSourceCode != null) sb.append(" responseSourceCode: ").append(toIndentedString(responseSourceCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsDeviceInformation.java b/src/main/java/Model/Riskv1decisionsDeviceInformation.java index 87ff095a2..3c4f88d76 100644 --- a/src/main/java/Model/Riskv1decisionsDeviceInformation.java +++ b/src/main/java/Model/Riskv1decisionsDeviceInformation.java @@ -44,6 +44,9 @@ public class Riskv1decisionsDeviceInformation { @SerializedName("fingerprintSessionId") private String fingerprintSessionId = null; + @SerializedName("useRawFingerprintSessionId") + private Boolean useRawFingerprintSessionId = null; + @SerializedName("httpBrowserEmail") private String httpBrowserEmail = null; @@ -155,6 +158,24 @@ public void setFingerprintSessionId(String fingerprintSessionId) { this.fingerprintSessionId = fingerprintSessionId; } + public Riskv1decisionsDeviceInformation useRawFingerprintSessionId(Boolean useRawFingerprintSessionId) { + this.useRawFingerprintSessionId = useRawFingerprintSessionId; + return this; + } + + /** + * Boolean that indicates whether request contains the device fingerprint information. Values: - `true`: Use raw fingerprintSessionId when looking up device details. - `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection. + * @return useRawFingerprintSessionId + **/ + @ApiModelProperty(value = "Boolean that indicates whether request contains the device fingerprint information. Values: - `true`: Use raw fingerprintSessionId when looking up device details. - `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection. ") + public Boolean UseRawFingerprintSessionId() { + return useRawFingerprintSessionId; + } + + public void setUseRawFingerprintSessionId(Boolean useRawFingerprintSessionId) { + this.useRawFingerprintSessionId = useRawFingerprintSessionId; + } + public Riskv1decisionsDeviceInformation httpBrowserEmail(String httpBrowserEmail) { this.httpBrowserEmail = httpBrowserEmail; return this; @@ -411,6 +432,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.ipAddress, riskv1decisionsDeviceInformation.ipAddress) && Objects.equals(this.hostName, riskv1decisionsDeviceInformation.hostName) && Objects.equals(this.fingerprintSessionId, riskv1decisionsDeviceInformation.fingerprintSessionId) && + Objects.equals(this.useRawFingerprintSessionId, riskv1decisionsDeviceInformation.useRawFingerprintSessionId) && Objects.equals(this.httpBrowserEmail, riskv1decisionsDeviceInformation.httpBrowserEmail) && Objects.equals(this.userAgent, riskv1decisionsDeviceInformation.userAgent) && Objects.equals(this.rawData, riskv1decisionsDeviceInformation.rawData) && @@ -428,7 +450,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(cookiesAccepted, ipAddress, hostName, fingerprintSessionId, httpBrowserEmail, userAgent, rawData, httpAcceptBrowserValue, httpAcceptContent, httpBrowserLanguage, httpBrowserJavaEnabled, httpBrowserJavaScriptEnabled, httpBrowserColorDepth, httpBrowserScreenHeight, httpBrowserScreenWidth, httpBrowserTimeDifference, userAgentBrowserValue); + return Objects.hash(cookiesAccepted, ipAddress, hostName, fingerprintSessionId, useRawFingerprintSessionId, httpBrowserEmail, userAgent, rawData, httpAcceptBrowserValue, httpAcceptContent, httpBrowserLanguage, httpBrowserJavaEnabled, httpBrowserJavaScriptEnabled, httpBrowserColorDepth, httpBrowserScreenHeight, httpBrowserScreenWidth, httpBrowserTimeDifference, userAgentBrowserValue); } @@ -441,6 +463,7 @@ public String toString() { if (ipAddress != null) sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n"); if (hostName != null) sb.append(" hostName: ").append(toIndentedString(hostName)).append("\n"); if (fingerprintSessionId != null) sb.append(" fingerprintSessionId: ").append(toIndentedString(fingerprintSessionId)).append("\n"); + if (useRawFingerprintSessionId != null) sb.append(" useRawFingerprintSessionId: ").append(toIndentedString(useRawFingerprintSessionId)).append("\n"); if (httpBrowserEmail != null) sb.append(" httpBrowserEmail: ").append(toIndentedString(httpBrowserEmail)).append("\n"); if (userAgent != null) sb.append(" userAgent: ").append(toIndentedString(userAgent)).append("\n"); if (rawData != null) sb.append(" rawData: ").append(toIndentedString(rawData)).append("\n"); diff --git a/src/main/java/Model/TmsEmbeddedInstrumentIdentifier.java b/src/main/java/Model/TmsEmbeddedInstrumentIdentifier.java index 3800ab6fb..95aff079c 100644 --- a/src/main/java/Model/TmsEmbeddedInstrumentIdentifier.java +++ b/src/main/java/Model/TmsEmbeddedInstrumentIdentifier.java @@ -23,6 +23,7 @@ import Model.TmsEmbeddedInstrumentIdentifierIssuer; import Model.TmsEmbeddedInstrumentIdentifierLinks; import Model.TmsEmbeddedInstrumentIdentifierMetadata; +import Model.TmsEmbeddedInstrumentIdentifierPointOfSaleInformation; import Model.TmsEmbeddedInstrumentIdentifierProcessingInformation; import Model.Tmsv2TokenizedCard; import com.google.gson.TypeAdapter; @@ -54,12 +55,18 @@ public class TmsEmbeddedInstrumentIdentifier { @SerializedName("type") private String type = null; + @SerializedName("source") + private String source = null; + @SerializedName("tokenProvisioningInformation") private Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation = null; @SerializedName("card") private TmsEmbeddedInstrumentIdentifierCard card = null; + @SerializedName("pointOfSaleInformation") + private TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation = null; + @SerializedName("bankAccount") private TmsEmbeddedInstrumentIdentifierBankAccount bankAccount = null; @@ -153,6 +160,24 @@ public void setType(String type) { this.type = type; } + public TmsEmbeddedInstrumentIdentifier source(String source) { + this.source = source; + return this; + } + + /** + * Source of the card details. Possible Values: - CONTACTLESS_TAP + * @return source + **/ + @ApiModelProperty(value = "Source of the card details. Possible Values: - CONTACTLESS_TAP ") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + public TmsEmbeddedInstrumentIdentifier tokenProvisioningInformation(Ptsv2paymentsTokenInformationTokenProvisioningInformation tokenProvisioningInformation) { this.tokenProvisioningInformation = tokenProvisioningInformation; return this; @@ -189,6 +214,24 @@ public void setCard(TmsEmbeddedInstrumentIdentifierCard card) { this.card = card; } + public TmsEmbeddedInstrumentIdentifier pointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(TmsEmbeddedInstrumentIdentifierPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + public TmsEmbeddedInstrumentIdentifier bankAccount(TmsEmbeddedInstrumentIdentifierBankAccount bankAccount) { this.bankAccount = bankAccount; return this; @@ -330,8 +373,10 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.object, tmsEmbeddedInstrumentIdentifier.object) && Objects.equals(this.state, tmsEmbeddedInstrumentIdentifier.state) && Objects.equals(this.type, tmsEmbeddedInstrumentIdentifier.type) && + Objects.equals(this.source, tmsEmbeddedInstrumentIdentifier.source) && Objects.equals(this.tokenProvisioningInformation, tmsEmbeddedInstrumentIdentifier.tokenProvisioningInformation) && Objects.equals(this.card, tmsEmbeddedInstrumentIdentifier.card) && + Objects.equals(this.pointOfSaleInformation, tmsEmbeddedInstrumentIdentifier.pointOfSaleInformation) && Objects.equals(this.bankAccount, tmsEmbeddedInstrumentIdentifier.bankAccount) && Objects.equals(this.tokenizedCard, tmsEmbeddedInstrumentIdentifier.tokenizedCard) && Objects.equals(this.issuer, tmsEmbeddedInstrumentIdentifier.issuer) && @@ -343,7 +388,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(links, id, object, state, type, tokenProvisioningInformation, card, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); + return Objects.hash(links, id, object, state, type, source, tokenProvisioningInformation, card, pointOfSaleInformation, bankAccount, tokenizedCard, issuer, processingInformation, billTo, metadata, embedded); } @@ -357,8 +402,10 @@ public String toString() { if (object != null) sb.append(" object: ").append(toIndentedString(object)).append("\n"); if (state != null) sb.append(" state: ").append(toIndentedString(state)).append("\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (source != null) sb.append(" source: ").append(toIndentedString(source)).append("\n"); if (tokenProvisioningInformation != null) sb.append(" tokenProvisioningInformation: ").append(toIndentedString(tokenProvisioningInformation)).append("\n"); if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); + if (pointOfSaleInformation != null) sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); if (bankAccount != null) sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); if (tokenizedCard != null) sb.append(" tokenizedCard: ").append(toIndentedString(tokenizedCard)).append("\n"); if (issuer != null) sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); diff --git a/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.java b/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.java new file mode 100644 index 000000000..cc9596925 --- /dev/null +++ b/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformation.java @@ -0,0 +1,102 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * TmsEmbeddedInstrumentIdentifierPointOfSaleInformation + */ + +public class TmsEmbeddedInstrumentIdentifierPointOfSaleInformation { + @SerializedName("emvTags") + private List emvTags = new ArrayList(); + + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation emvTags(List emvTags) { + this.emvTags = emvTags; + return this; + } + + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformation addEmvTagsItem(TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags emvTagsItem) { + this.emvTags.add(emvTagsItem); + return this; + } + + /** + * Get emvTags + * @return emvTags + **/ + @ApiModelProperty(required = true, value = "") + public List getEmvTags() { + return emvTags; + } + + public void setEmvTags(List emvTags) { + this.emvTags = emvTags; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsEmbeddedInstrumentIdentifierPointOfSaleInformation tmsEmbeddedInstrumentIdentifierPointOfSaleInformation = (TmsEmbeddedInstrumentIdentifierPointOfSaleInformation) o; + return Objects.equals(this.emvTags, tmsEmbeddedInstrumentIdentifierPointOfSaleInformation.emvTags); + } + + @Override + public int hashCode() { + return Objects.hash(emvTags); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsEmbeddedInstrumentIdentifierPointOfSaleInformation {\n"); + + if (emvTags != null) sb.append(" emvTags: ").append(toIndentedString(emvTags)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.java b/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.java new file mode 100644 index 000000000..b19ade8d8 --- /dev/null +++ b/src/main/java/Model/TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.java @@ -0,0 +1,140 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags + */ + +public class TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags { + @SerializedName("tag") + private String tag = null; + + @SerializedName("value") + private String value = null; + + @SerializedName("source") + private String source = null; + + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags tag(String tag) { + this.tag = tag; + return this; + } + + /** + * EMV tag, 1-10 hex characters. + * @return tag + **/ + @ApiModelProperty(required = true, value = "EMV tag, 1-10 hex characters.") + public String getTag() { + return tag; + } + + public void setTag(String tag) { + this.tag = tag; + } + + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags value(String value) { + this.value = value; + return this; + } + + /** + * EMV tag value, 1-64 characters. + * @return value + **/ + @ApiModelProperty(required = true, value = "EMV tag value, 1-64 characters.") + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags source(String source) { + this.source = source; + return this; + } + + /** + * Source of the tag. Possible Values: - CARD - TERMINAL + * @return source + **/ + @ApiModelProperty(required = true, value = "Source of the tag. Possible Values: - CARD - TERMINAL ") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags tmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags = (TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags) o; + return Objects.equals(this.tag, tmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.tag) && + Objects.equals(this.value, tmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.value) && + Objects.equals(this.source, tmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags.source); + } + + @Override + public int hashCode() { + return Objects.hash(tag, value, source); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsEmbeddedInstrumentIdentifierPointOfSaleInformationEmvTags {\n"); + + if (tag != null) sb.append(" tag: ").append(toIndentedString(tag)).append("\n"); + if (value != null) sb.append(" value: ").append(toIndentedString(value)).append("\n"); + if (source != null) sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2TokenizedCard.java b/src/main/java/Model/Tmsv2TokenizedCard.java index e7457d685..b83dcab0a 100644 --- a/src/main/java/Model/Tmsv2TokenizedCard.java +++ b/src/main/java/Model/Tmsv2TokenizedCard.java @@ -198,10 +198,10 @@ public Tmsv2TokenizedCard source(String source) { } /** - * Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER + * Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER * @return source **/ - @ApiModelProperty(value = "Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER ") + @ApiModelProperty(value = "Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER ") public String getSource() { return source; } diff --git a/src/main/java/Model/Tmsv2TokenizedCardCard.java b/src/main/java/Model/Tmsv2TokenizedCardCard.java index 0416f84a2..7fd0f497e 100644 --- a/src/main/java/Model/Tmsv2TokenizedCardCard.java +++ b/src/main/java/Model/Tmsv2TokenizedCardCard.java @@ -15,6 +15,7 @@ import java.util.Objects; import java.util.Arrays; +import Model.Tmsv2TokenizedCardCardTermsAndConditions; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -23,6 +24,7 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import org.joda.time.LocalDate; /** * Card object used to create a network token @@ -45,6 +47,21 @@ public class Tmsv2TokenizedCardCard { @SerializedName("suffix") private String suffix = null; + @SerializedName("issueDate") + private LocalDate issueDate = null; + + @SerializedName("activationDate") + private LocalDate activationDate = null; + + @SerializedName("expirationPrinted") + private Boolean expirationPrinted = null; + + @SerializedName("securityCodePrinted") + private Boolean securityCodePrinted = null; + + @SerializedName("termsAndConditions") + private Tmsv2TokenizedCardCardTermsAndConditions termsAndConditions = null; + public Tmsv2TokenizedCardCard number(String number) { this.number = number; return this; @@ -126,6 +143,60 @@ public String getSuffix() { return suffix; } + /** + * Card issuance date. XML date format: YYYY-MM-DD. + * @return issueDate + **/ + @ApiModelProperty(example = "2030-12-15", value = "Card issuance date. XML date format: YYYY-MM-DD.") + public LocalDate getIssueDate() { + return issueDate; + } + + /** + * Card activation date. XML date format: YYYY-MM-DD + * @return activationDate + **/ + @ApiModelProperty(example = "2030-12-20", value = "Card activation date. XML date format: YYYY-MM-DD") + public LocalDate getActivationDate() { + return activationDate; + } + + /** + * Indicates if the expiration date is printed on the card. + * @return expirationPrinted + **/ + @ApiModelProperty(example = "true", value = "Indicates if the expiration date is printed on the card.") + public Boolean ExpirationPrinted() { + return expirationPrinted; + } + + /** + * Indicates if the Card Verification Number is printed on the card. + * @return securityCodePrinted + **/ + @ApiModelProperty(example = "true", value = "Indicates if the Card Verification Number is printed on the card.") + public Boolean SecurityCodePrinted() { + return securityCodePrinted; + } + + public Tmsv2TokenizedCardCard termsAndConditions(Tmsv2TokenizedCardCardTermsAndConditions termsAndConditions) { + this.termsAndConditions = termsAndConditions; + return this; + } + + /** + * Get termsAndConditions + * @return termsAndConditions + **/ + @ApiModelProperty(value = "") + public Tmsv2TokenizedCardCardTermsAndConditions getTermsAndConditions() { + return termsAndConditions; + } + + public void setTermsAndConditions(Tmsv2TokenizedCardCardTermsAndConditions termsAndConditions) { + this.termsAndConditions = termsAndConditions; + } + @Override public boolean equals(java.lang.Object o) { @@ -140,12 +211,17 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.expirationMonth, tmsv2TokenizedCardCard.expirationMonth) && Objects.equals(this.expirationYear, tmsv2TokenizedCardCard.expirationYear) && Objects.equals(this.type, tmsv2TokenizedCardCard.type) && - Objects.equals(this.suffix, tmsv2TokenizedCardCard.suffix); + Objects.equals(this.suffix, tmsv2TokenizedCardCard.suffix) && + Objects.equals(this.issueDate, tmsv2TokenizedCardCard.issueDate) && + Objects.equals(this.activationDate, tmsv2TokenizedCardCard.activationDate) && + Objects.equals(this.expirationPrinted, tmsv2TokenizedCardCard.expirationPrinted) && + Objects.equals(this.securityCodePrinted, tmsv2TokenizedCardCard.securityCodePrinted) && + Objects.equals(this.termsAndConditions, tmsv2TokenizedCardCard.termsAndConditions); } @Override public int hashCode() { - return Objects.hash(number, expirationMonth, expirationYear, type, suffix); + return Objects.hash(number, expirationMonth, expirationYear, type, suffix, issueDate, activationDate, expirationPrinted, securityCodePrinted, termsAndConditions); } @@ -159,6 +235,11 @@ public String toString() { if (expirationYear != null) sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); if (suffix != null) sb.append(" suffix: ").append(toIndentedString(suffix)).append("\n"); + if (issueDate != null) sb.append(" issueDate: ").append(toIndentedString(issueDate)).append("\n"); + if (activationDate != null) sb.append(" activationDate: ").append(toIndentedString(activationDate)).append("\n"); + if (expirationPrinted != null) sb.append(" expirationPrinted: ").append(toIndentedString(expirationPrinted)).append("\n"); + if (securityCodePrinted != null) sb.append(" securityCodePrinted: ").append(toIndentedString(securityCodePrinted)).append("\n"); + if (termsAndConditions != null) sb.append(" termsAndConditions: ").append(toIndentedString(termsAndConditions)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Tmsv2TokenizedCardCardTermsAndConditions.java b/src/main/java/Model/Tmsv2TokenizedCardCardTermsAndConditions.java new file mode 100644 index 000000000..4c8782718 --- /dev/null +++ b/src/main/java/Model/Tmsv2TokenizedCardCardTermsAndConditions.java @@ -0,0 +1,85 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2TokenizedCardCardTermsAndConditions + */ + +public class Tmsv2TokenizedCardCardTermsAndConditions { + @SerializedName("url") + private String url = null; + + /** + * Issuer Card Terms and Conditions url. + * @return url + **/ + @ApiModelProperty(value = "Issuer Card Terms and Conditions url.") + public String getUrl() { + return url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2TokenizedCardCardTermsAndConditions tmsv2TokenizedCardCardTermsAndConditions = (Tmsv2TokenizedCardCardTermsAndConditions) o; + return Objects.equals(this.url, tmsv2TokenizedCardCardTermsAndConditions.url); + } + + @Override + public int hashCode() { + return Objects.hash(url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2TokenizedCardCardTermsAndConditions {\n"); + + if (url != null) sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2TokenizedCardMetadataIssuer.java b/src/main/java/Model/Tmsv2TokenizedCardMetadataIssuer.java index 2e3a46829..beabcc67c 100644 --- a/src/main/java/Model/Tmsv2TokenizedCardMetadataIssuer.java +++ b/src/main/java/Model/Tmsv2TokenizedCardMetadataIssuer.java @@ -39,33 +39,69 @@ public class Tmsv2TokenizedCardMetadataIssuer { @SerializedName("longDescription") private String longDescription = null; + @SerializedName("email") + private String email = null; + + @SerializedName("phoneNumber") + private String phoneNumber = null; + + @SerializedName("url") + private String url = null; + /** - * issuer name. + * Issuer name. * @return name **/ - @ApiModelProperty(value = "issuer name. ") + @ApiModelProperty(value = "Issuer name. ") public String getName() { return name; } /** - * issuer short description. + * Short description of the card. * @return shortDescription **/ - @ApiModelProperty(value = "issuer short description. ") + @ApiModelProperty(value = "Short description of the card. ") public String getShortDescription() { return shortDescription; } /** - * issuer long description. + * Long description of the card. * @return longDescription **/ - @ApiModelProperty(value = "issuer long description. ") + @ApiModelProperty(value = "Long description of the card. ") public String getLongDescription() { return longDescription; } + /** + * Issuer customer service email address. + * @return email + **/ + @ApiModelProperty(value = "Issuer customer service email address.") + public String getEmail() { + return email; + } + + /** + * Issuer customer service phone number. + * @return phoneNumber + **/ + @ApiModelProperty(value = "Issuer customer service phone number.") + public String getPhoneNumber() { + return phoneNumber; + } + + /** + * Issuer customer service url. + * @return url + **/ + @ApiModelProperty(value = "Issuer customer service url.") + public String getUrl() { + return url; + } + @Override public boolean equals(java.lang.Object o) { @@ -78,12 +114,15 @@ public boolean equals(java.lang.Object o) { Tmsv2TokenizedCardMetadataIssuer tmsv2TokenizedCardMetadataIssuer = (Tmsv2TokenizedCardMetadataIssuer) o; return Objects.equals(this.name, tmsv2TokenizedCardMetadataIssuer.name) && Objects.equals(this.shortDescription, tmsv2TokenizedCardMetadataIssuer.shortDescription) && - Objects.equals(this.longDescription, tmsv2TokenizedCardMetadataIssuer.longDescription); + Objects.equals(this.longDescription, tmsv2TokenizedCardMetadataIssuer.longDescription) && + Objects.equals(this.email, tmsv2TokenizedCardMetadataIssuer.email) && + Objects.equals(this.phoneNumber, tmsv2TokenizedCardMetadataIssuer.phoneNumber) && + Objects.equals(this.url, tmsv2TokenizedCardMetadataIssuer.url); } @Override public int hashCode() { - return Objects.hash(name, shortDescription, longDescription); + return Objects.hash(name, shortDescription, longDescription, email, phoneNumber, url); } @@ -95,6 +134,9 @@ public String toString() { if (name != null) sb.append(" name: ").append(toIndentedString(name)).append("\n"); if (shortDescription != null) sb.append(" shortDescription: ").append(toIndentedString(shortDescription)).append("\n"); if (longDescription != null) sb.append(" longDescription: ").append(toIndentedString(longDescription)).append("\n"); + if (email != null) sb.append(" email: ").append(toIndentedString(email)).append("\n"); + if (phoneNumber != null) sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n"); + if (url != null) sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.java b/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.java deleted file mode 100644 index eaa5c6214..000000000 --- a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.java +++ /dev/null @@ -1,140 +0,0 @@ -/* - * CyberSource Merged Spec - * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard - */ - -public class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard { - @SerializedName("last4") - private String last4 = null; - - @SerializedName("expirationMonth") - private String expirationMonth = null; - - @SerializedName("expirationYear") - private String expirationYear = null; - - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard last4(String last4) { - this.last4 = last4; - return this; - } - - /** - * The new last 4 digits of the card number associated to the Tokenized Card. - * @return last4 - **/ - @ApiModelProperty(value = "The new last 4 digits of the card number associated to the Tokenized Card. ") - public String getLast4() { - return last4; - } - - public void setLast4(String last4) { - this.last4 = last4; - } - - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard expirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - return this; - } - - /** - * The new two-digit month of the card associated to the Tokenized Card. Format: `MM`. Possible Values: `01` through `12`. - * @return expirationMonth - **/ - @ApiModelProperty(value = "The new two-digit month of the card associated to the Tokenized Card. Format: `MM`. Possible Values: `01` through `12`. ") - public String getExpirationMonth() { - return expirationMonth; - } - - public void setExpirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - } - - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard expirationYear(String expirationYear) { - this.expirationYear = expirationYear; - return this; - } - - /** - * The new four-digit year of the card associated to the Tokenized Card. Format: `YYYY`. - * @return expirationYear - **/ - @ApiModelProperty(value = "The new four-digit year of the card associated to the Tokenized Card. Format: `YYYY`. ") - public String getExpirationYear() { - return expirationYear; - } - - public void setExpirationYear(String expirationYear) { - this.expirationYear = expirationYear; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard = (Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard) o; - return Objects.equals(this.last4, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.last4) && - Objects.equals(this.expirationMonth, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.expirationMonth) && - Objects.equals(this.expirationYear, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.expirationYear); - } - - @Override - public int hashCode() { - return Objects.hash(last4, expirationMonth, expirationYear); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard {\n"); - - if (last4 != null) sb.append(" last4: ").append(toIndentedString(last4)).append("\n"); - if (expirationMonth != null) sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); - if (expirationYear != null) sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - // return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.java b/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.java deleted file mode 100644 index a927df8c9..000000000 --- a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.java +++ /dev/null @@ -1,95 +0,0 @@ -/* - * CyberSource Merged Spec - * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import java.util.Arrays; -import Model.Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt - */ - -public class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt { - @SerializedName("combinedAsset") - private Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset combinedAsset = null; - - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt combinedAsset(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset combinedAsset) { - this.combinedAsset = combinedAsset; - return this; - } - - /** - * Get combinedAsset - * @return combinedAsset - **/ - @ApiModelProperty(value = "") - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset getCombinedAsset() { - return combinedAsset; - } - - public void setCombinedAsset(Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset combinedAsset) { - this.combinedAsset = combinedAsset; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt = (Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt) o; - return Objects.equals(this.combinedAsset, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.combinedAsset); - } - - @Override - public int hashCode() { - return Objects.hash(combinedAsset); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt {\n"); - - if (combinedAsset != null) sb.append(" combinedAsset: ").append(toIndentedString(combinedAsset)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - // return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.java b/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.java deleted file mode 100644 index ace74811e..000000000 --- a/src/main/java/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.java +++ /dev/null @@ -1,94 +0,0 @@ -/* - * CyberSource Merged Spec - * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset - */ - -public class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset { - @SerializedName("update") - private String update = null; - - public Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset update(String update) { - this.update = update; - return this; - } - - /** - * Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card. - * @return update - **/ - @ApiModelProperty(value = "Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card. ") - public String getUpdate() { - return update; - } - - public void setUpdate(String update) { - this.update = update; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset = (Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset) o; - return Objects.equals(this.update, tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.update); - } - - @Override - public int hashCode() { - return Objects.hash(update); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset {\n"); - - if (update != null) sb.append(" update: ").append(toIndentedString(update)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - // return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.java new file mode 100644 index 000000000..03a0b38e5 --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.java @@ -0,0 +1,163 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities { + @SerializedName("id") + private String id = null; + + @SerializedName("provider") + private String provider = null; + + @SerializedName("data") + private String data = null; + + @SerializedName("relyingPartyId") + private String relyingPartyId = null; + + public Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities id(String id) { + this.id = id; + return this; + } + + /** + * The id from the authenticated identity. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. + * @return id + **/ + @ApiModelProperty(example = "88662a11a11fa88627e217ab9cb00001", value = "The id from the authenticated identity. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities provider(String provider) { + this.provider = provider; + return this; + } + + /** + * The provider of the authenticated identity. Possible Values: - VISA_PAYMENT_PASSKEY + * @return provider + **/ + @ApiModelProperty(example = "VISA_PAYMENT_PASSKEY", value = "The provider of the authenticated identity. Possible Values: - VISA_PAYMENT_PASSKEY ") + public String getProvider() { + return provider; + } + + public void setProvider(String provider) { + this.provider = provider; + } + + public Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities data(String data) { + this.data = data; + return this; + } + + /** + * The data from the authenticated identity, for FIDO this could be the Attestation. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. + * @return data + **/ + @ApiModelProperty(example = "dj0xJmM9ezAwMX06QUFSTk", value = "The data from the authenticated identity, for FIDO this could be the Attestation. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. ") + public String getData() { + return data; + } + + public void setData(String data) { + this.data = data; + } + + public Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities relyingPartyId(String relyingPartyId) { + this.relyingPartyId = relyingPartyId; + return this; + } + + /** + * The id of the Relying Party. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. + * @return relyingPartyId + **/ + @ApiModelProperty(example = "dnRzLmF1dGgudmlzYS5jb20=", value = "The id of the Relying Party. Base64URL encoded string (RFC4648). The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'. ") + public String getRelyingPartyId() { + return relyingPartyId; + } + + public void setRelyingPartyId(String relyingPartyId) { + this.relyingPartyId = relyingPartyId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities = (Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities) o; + return Objects.equals(this.id, tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.id) && + Objects.equals(this.provider, tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.provider) && + Objects.equals(this.data, tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.data) && + Objects.equals(this.relyingPartyId, tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities.relyingPartyId); + } + + @Override + public int hashCode() { + return Objects.hash(id, provider, data, relyingPartyId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsAuthenticatedIdentities {\n"); + + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (provider != null) sb.append(" provider: ").append(toIndentedString(provider)).append("\n"); + if (data != null) sb.append(" data: ").append(toIndentedString(data)).append("\n"); + if (relyingPartyId != null) sb.append(" relyingPartyId: ").append(toIndentedString(relyingPartyId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.java new file mode 100644 index 000000000..38ae7fb41 --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.java @@ -0,0 +1,324 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation { + @SerializedName("platformType") + private String platformType = null; + + @SerializedName("ipAddress") + private String ipAddress = null; + + @SerializedName("httpAcceptContent") + private String httpAcceptContent = null; + + @SerializedName("httpBrowserLanguage") + private String httpBrowserLanguage = null; + + @SerializedName("httpBrowserJavaEnabled") + private Boolean httpBrowserJavaEnabled = null; + + @SerializedName("httpBrowserJavaScriptEnabled") + private Boolean httpBrowserJavaScriptEnabled = null; + + @SerializedName("httpBrowserColorDepth") + private String httpBrowserColorDepth = null; + + @SerializedName("httpBrowserScreenHeight") + private String httpBrowserScreenHeight = null; + + @SerializedName("httpBrowserScreenWidth") + private String httpBrowserScreenWidth = null; + + @SerializedName("httpBrowserTimeDifference") + private String httpBrowserTimeDifference = null; + + @SerializedName("userAgentBrowserValue") + private String userAgentBrowserValue = null; + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation platformType(String platformType) { + this.platformType = platformType; + return this; + } + + /** + * Platform type. Possible Values: - iOS: iOS app - ANDROID: Android app - WINDOWS: Windows app - WEB: Browser-based app + * @return platformType + **/ + @ApiModelProperty(example = "WEB", value = "Platform type. Possible Values: - iOS: iOS app - ANDROID: Android app - WINDOWS: Windows app - WEB: Browser-based app ") + public String getPlatformType() { + return platformType; + } + + public void setPlatformType(String platformType) { + this.platformType = platformType; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation ipAddress(String ipAddress) { + this.ipAddress = ipAddress; + return this; + } + + /** + * IP address of the customer. + * @return ipAddress + **/ + @ApiModelProperty(example = "127.0.0.1", value = "IP address of the customer. ") + public String getIpAddress() { + return ipAddress; + } + + public void setIpAddress(String ipAddress) { + this.ipAddress = ipAddress; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpAcceptContent(String httpAcceptContent) { + this.httpAcceptContent = httpAcceptContent; + return this; + } + + /** + * The exact content of the HTTP accept header. + * @return httpAcceptContent + **/ + @ApiModelProperty(example = "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*_/_*;q=0.8,application/signed-exchange;v=b3;q=0.7", value = "The exact content of the HTTP accept header. ") + public String getHttpAcceptContent() { + return httpAcceptContent; + } + + public void setHttpAcceptContent(String httpAcceptContent) { + this.httpAcceptContent = httpAcceptContent; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserLanguage(String httpBrowserLanguage) { + this.httpBrowserLanguage = httpBrowserLanguage; + return this; + } + + /** + * Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. + * @return httpBrowserLanguage + **/ + @ApiModelProperty(example = "en-US", value = "Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. ") + public String getHttpBrowserLanguage() { + return httpBrowserLanguage; + } + + public void setHttpBrowserLanguage(String httpBrowserLanguage) { + this.httpBrowserLanguage = httpBrowserLanguage; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserJavaEnabled(Boolean httpBrowserJavaEnabled) { + this.httpBrowserJavaEnabled = httpBrowserJavaEnabled; + return this; + } + + /** + * A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False + * @return httpBrowserJavaEnabled + **/ + @ApiModelProperty(example = "false", value = "A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False ") + public Boolean HttpBrowserJavaEnabled() { + return httpBrowserJavaEnabled; + } + + public void setHttpBrowserJavaEnabled(Boolean httpBrowserJavaEnabled) { + this.httpBrowserJavaEnabled = httpBrowserJavaEnabled; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserJavaScriptEnabled(Boolean httpBrowserJavaScriptEnabled) { + this.httpBrowserJavaScriptEnabled = httpBrowserJavaScriptEnabled; + return this; + } + + /** + * A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. + * @return httpBrowserJavaScriptEnabled + **/ + @ApiModelProperty(example = "true", value = "A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. ") + public Boolean HttpBrowserJavaScriptEnabled() { + return httpBrowserJavaScriptEnabled; + } + + public void setHttpBrowserJavaScriptEnabled(Boolean httpBrowserJavaScriptEnabled) { + this.httpBrowserJavaScriptEnabled = httpBrowserJavaScriptEnabled; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserColorDepth(String httpBrowserColorDepth) { + this.httpBrowserColorDepth = httpBrowserColorDepth; + return this; + } + + /** + * Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details + * @return httpBrowserColorDepth + **/ + @ApiModelProperty(example = "24", value = "Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details ") + public String getHttpBrowserColorDepth() { + return httpBrowserColorDepth; + } + + public void setHttpBrowserColorDepth(String httpBrowserColorDepth) { + this.httpBrowserColorDepth = httpBrowserColorDepth; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserScreenHeight(String httpBrowserScreenHeight) { + this.httpBrowserScreenHeight = httpBrowserScreenHeight; + return this; + } + + /** + * Total height of the Cardholder's screen in pixels. + * @return httpBrowserScreenHeight + **/ + @ApiModelProperty(example = "1080", value = "Total height of the Cardholder's screen in pixels. ") + public String getHttpBrowserScreenHeight() { + return httpBrowserScreenHeight; + } + + public void setHttpBrowserScreenHeight(String httpBrowserScreenHeight) { + this.httpBrowserScreenHeight = httpBrowserScreenHeight; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserScreenWidth(String httpBrowserScreenWidth) { + this.httpBrowserScreenWidth = httpBrowserScreenWidth; + return this; + } + + /** + * Total width of the cardholder's screen in pixels. + * @return httpBrowserScreenWidth + **/ + @ApiModelProperty(example = "1920", value = "Total width of the cardholder's screen in pixels. ") + public String getHttpBrowserScreenWidth() { + return httpBrowserScreenWidth; + } + + public void setHttpBrowserScreenWidth(String httpBrowserScreenWidth) { + this.httpBrowserScreenWidth = httpBrowserScreenWidth; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation httpBrowserTimeDifference(String httpBrowserTimeDifference) { + this.httpBrowserTimeDifference = httpBrowserTimeDifference; + return this; + } + + /** + * Time difference between UTC time and the cardholder browser local time, in minutes. + * @return httpBrowserTimeDifference + **/ + @ApiModelProperty(example = "420", value = "Time difference between UTC time and the cardholder browser local time, in minutes. ") + public String getHttpBrowserTimeDifference() { + return httpBrowserTimeDifference; + } + + public void setHttpBrowserTimeDifference(String httpBrowserTimeDifference) { + this.httpBrowserTimeDifference = httpBrowserTimeDifference; + } + + public Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation userAgentBrowserValue(String userAgentBrowserValue) { + this.userAgentBrowserValue = userAgentBrowserValue; + return this; + } + + /** + * Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. + * @return userAgentBrowserValue + **/ + @ApiModelProperty(example = "Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/134.0.0.0Safari/537.36Edg/134.0.0.0", value = "Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. ") + public String getUserAgentBrowserValue() { + return userAgentBrowserValue; + } + + public void setUserAgentBrowserValue(String userAgentBrowserValue) { + this.userAgentBrowserValue = userAgentBrowserValue; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation tmsv2tokenstokenIdpaymentcredentialsDeviceInformation = (Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation) o; + return Objects.equals(this.platformType, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.platformType) && + Objects.equals(this.ipAddress, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.ipAddress) && + Objects.equals(this.httpAcceptContent, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpAcceptContent) && + Objects.equals(this.httpBrowserLanguage, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserLanguage) && + Objects.equals(this.httpBrowserJavaEnabled, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserJavaEnabled) && + Objects.equals(this.httpBrowserJavaScriptEnabled, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserJavaScriptEnabled) && + Objects.equals(this.httpBrowserColorDepth, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserColorDepth) && + Objects.equals(this.httpBrowserScreenHeight, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserScreenHeight) && + Objects.equals(this.httpBrowserScreenWidth, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserScreenWidth) && + Objects.equals(this.httpBrowserTimeDifference, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.httpBrowserTimeDifference) && + Objects.equals(this.userAgentBrowserValue, tmsv2tokenstokenIdpaymentcredentialsDeviceInformation.userAgentBrowserValue); + } + + @Override + public int hashCode() { + return Objects.hash(platformType, ipAddress, httpAcceptContent, httpBrowserLanguage, httpBrowserJavaEnabled, httpBrowserJavaScriptEnabled, httpBrowserColorDepth, httpBrowserScreenHeight, httpBrowserScreenWidth, httpBrowserTimeDifference, userAgentBrowserValue); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsDeviceInformation {\n"); + + if (platformType != null) sb.append(" platformType: ").append(toIndentedString(platformType)).append("\n"); + if (ipAddress != null) sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n"); + if (httpAcceptContent != null) sb.append(" httpAcceptContent: ").append(toIndentedString(httpAcceptContent)).append("\n"); + if (httpBrowserLanguage != null) sb.append(" httpBrowserLanguage: ").append(toIndentedString(httpBrowserLanguage)).append("\n"); + if (httpBrowserJavaEnabled != null) sb.append(" httpBrowserJavaEnabled: ").append(toIndentedString(httpBrowserJavaEnabled)).append("\n"); + if (httpBrowserJavaScriptEnabled != null) sb.append(" httpBrowserJavaScriptEnabled: ").append(toIndentedString(httpBrowserJavaScriptEnabled)).append("\n"); + if (httpBrowserColorDepth != null) sb.append(" httpBrowserColorDepth: ").append(toIndentedString(httpBrowserColorDepth)).append("\n"); + if (httpBrowserScreenHeight != null) sb.append(" httpBrowserScreenHeight: ").append(toIndentedString(httpBrowserScreenHeight)).append("\n"); + if (httpBrowserScreenWidth != null) sb.append(" httpBrowserScreenWidth: ").append(toIndentedString(httpBrowserScreenWidth)).append("\n"); + if (httpBrowserTimeDifference != null) sb.append(" httpBrowserTimeDifference: ").append(toIndentedString(httpBrowserTimeDifference)).append("\n"); + if (userAgentBrowserValue != null) sb.append(" userAgentBrowserValue: ").append(toIndentedString(userAgentBrowserValue)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.java new file mode 100644 index 000000000..5f69f4ec4 --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.java @@ -0,0 +1,95 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation { + @SerializedName("merchantDescriptor") + private Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor merchantDescriptor = null; + + public Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation merchantDescriptor(Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor merchantDescriptor) { + this.merchantDescriptor = merchantDescriptor; + return this; + } + + /** + * Get merchantDescriptor + * @return merchantDescriptor + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor getMerchantDescriptor() { + return merchantDescriptor; + } + + public void setMerchantDescriptor(Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor merchantDescriptor) { + this.merchantDescriptor = merchantDescriptor; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation tmsv2tokenstokenIdpaymentcredentialsMerchantInformation = (Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation) o; + return Objects.equals(this.merchantDescriptor, tmsv2tokenstokenIdpaymentcredentialsMerchantInformation.merchantDescriptor); + } + + @Override + public int hashCode() { + return Objects.hash(merchantDescriptor); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsMerchantInformation {\n"); + + if (merchantDescriptor != null) sb.append(" merchantDescriptor: ").append(toIndentedString(merchantDescriptor)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.java new file mode 100644 index 000000000..7fc6ceb7e --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor { + @SerializedName("name") + private String name = null; + + @SerializedName("url") + private String url = null; + + public Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor name(String name) { + this.name = name; + return this; + } + + /** + * Merchant's name + * @return name + **/ + @ApiModelProperty(example = "TWVyY2hhbnQgVlphRjVYQmo", value = "Merchant's name") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor url(String url) { + this.url = url; + return this; + } + + /** + * Address of company's website provided by merchant + * @return url + **/ + @ApiModelProperty(example = "aHR0cHM6Ly93d3cuTWVyY2hhbnQtVlphRjVYQmouY29t", value = "Address of company's website provided by merchant") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor = (Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor) o; + return Objects.equals(this.name, tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.name) && + Objects.equals(this.url, tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor.url); + } + + @Override + public int hashCode() { + return Objects.hash(name, url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsMerchantInformationMerchantDescriptor {\n"); + + if (name != null) sb.append(" name: ").append(toIndentedString(name)).append("\n"); + if (url != null) sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.java new file mode 100644 index 000000000..92e6a885e --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformation.java @@ -0,0 +1,119 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails; +import Model.Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsOrderInformation + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsOrderInformation { + @SerializedName("amountDetails") + private Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails amountDetails = null; + + @SerializedName("billTo") + private Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo billTo = null; + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformation amountDetails(Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + return this; + } + + /** + * Get amountDetails + * @return amountDetails + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails getAmountDetails() { + return amountDetails; + } + + public void setAmountDetails(Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformation billTo(Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo billTo) { + this.billTo = billTo; + return this; + } + + /** + * Get billTo + * @return billTo + **/ + @ApiModelProperty(value = "") + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo getBillTo() { + return billTo; + } + + public void setBillTo(Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo billTo) { + this.billTo = billTo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsOrderInformation tmsv2tokenstokenIdpaymentcredentialsOrderInformation = (Tmsv2tokenstokenIdpaymentcredentialsOrderInformation) o; + return Objects.equals(this.amountDetails, tmsv2tokenstokenIdpaymentcredentialsOrderInformation.amountDetails) && + Objects.equals(this.billTo, tmsv2tokenstokenIdpaymentcredentialsOrderInformation.billTo); + } + + @Override + public int hashCode() { + return Objects.hash(amountDetails, billTo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsOrderInformation {\n"); + + if (amountDetails != null) sb.append(" amountDetails: ").append(toIndentedString(amountDetails)).append("\n"); + if (billTo != null) sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.java new file mode 100644 index 000000000..b9ae55d67 --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails { + @SerializedName("totalAmount") + private String totalAmount = null; + + @SerializedName("currency") + private String currency = null; + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails totalAmount(String totalAmount) { + this.totalAmount = totalAmount; + return this; + } + + /** + * Total amount for the order + * @return totalAmount + **/ + @ApiModelProperty(example = "102.21", value = "Total amount for the order") + public String getTotalAmount() { + return totalAmount; + } + + public void setTotalAmount(String totalAmount) { + this.totalAmount = totalAmount; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Currency used for the order. Use an ISO 4217 numeric format currency code. + * @return currency + **/ + @ApiModelProperty(example = "978", value = "Currency used for the order. Use an ISO 4217 numeric format currency code. ") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails = (Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails) o; + return Objects.equals(this.totalAmount, tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.totalAmount) && + Objects.equals(this.currency, tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails.currency); + } + + @Override + public int hashCode() { + return Objects.hash(totalAmount, currency); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsOrderInformationAmountDetails {\n"); + + if (totalAmount != null) sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n"); + if (currency != null) sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.java b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.java new file mode 100644 index 000000000..e68b32ea0 --- /dev/null +++ b/src/main/java/Model/Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.java @@ -0,0 +1,255 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo + */ + +public class Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo { + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("address1") + private String address1 = null; + + @SerializedName("locality") + private String locality = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("postalCode") + private String postalCode = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("email") + private String email = null; + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Customer's first name. This name must be the same as the name on the card. + * @return firstName + **/ + @ApiModelProperty(example = "John", value = "Customer's first name. This name must be the same as the name on the card. ") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Customer's last name. This name must be the same as the name on the card. + * @return lastName + **/ + @ApiModelProperty(example = "Doe", value = "Customer's last name. This name must be the same as the name on the card. ") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo address1(String address1) { + this.address1 = address1; + return this; + } + + /** + * Payment card billing street address as it appears on the credit card issuer's records. + * @return address1 + **/ + @ApiModelProperty(example = "1 Market St", value = "Payment card billing street address as it appears on the credit card issuer's records. ") + public String getAddress1() { + return address1; + } + + public void setAddress1(String address1) { + this.address1 = address1; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo locality(String locality) { + this.locality = locality; + return this; + } + + /** + * Payment card billing city. + * @return locality + **/ + @ApiModelProperty(example = "San Francisco", value = "Payment card billing city. ") + public String getLocality() { + return locality; + } + + public void setLocality(String locality) { + this.locality = locality; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. + * @return administrativeArea + **/ + @ApiModelProperty(example = "CA", value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. ") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` + * @return postalCode + **/ + @ApiModelProperty(example = "94105", value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` ") + public String getPostalCode() { + return postalCode; + } + + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo country(String country) { + this.country = country; + return this; + } + + /** + * Payment card billing country. Use the two-character ISO Standard Country Codes. + * @return country + **/ + @ApiModelProperty(example = "US", value = "Payment card billing country. Use the two-character ISO Standard Country Codes. ") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo email(String email) { + this.email = email; + return this; + } + + /** + * Customer's email address, including the full domain name. + * @return email + **/ + @ApiModelProperty(example = "test@cybs.com", value = "Customer's email address, including the full domain name. ") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo = (Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo) o; + return Objects.equals(this.firstName, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.firstName) && + Objects.equals(this.lastName, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.lastName) && + Objects.equals(this.address1, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.address1) && + Objects.equals(this.locality, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.locality) && + Objects.equals(this.administrativeArea, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.administrativeArea) && + Objects.equals(this.postalCode, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.postalCode) && + Objects.equals(this.country, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.country) && + Objects.equals(this.email, tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo.email); + } + + @Override + public int hashCode() { + return Objects.hash(firstName, lastName, address1, locality, administrativeArea, postalCode, country, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv2tokenstokenIdpaymentcredentialsOrderInformationBillTo {\n"); + + if (firstName != null) sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + if (lastName != null) sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + if (address1 != null) sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); + if (locality != null) sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); + if (administrativeArea != null) sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + if (postalCode != null) sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + if (country != null) sb.append(" country: ").append(toIndentedString(country)).append("\n"); + if (email != null) sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TokenizedcardRequest.java b/src/main/java/Model/TokenizedcardRequest.java index fc0719261..9a4102bc5 100644 --- a/src/main/java/Model/TokenizedcardRequest.java +++ b/src/main/java/Model/TokenizedcardRequest.java @@ -198,10 +198,10 @@ public TokenizedcardRequest source(String source) { } /** - * Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER + * Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER * @return source **/ - @ApiModelProperty(value = "Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER ") + @ApiModelProperty(value = "Source of the card details. Possible Values: - ONFILE - TOKEN - ISSUER ") public String getSource() { return source; } diff --git a/src/main/java/Model/Upv1capturecontextsCompleteMandate.java b/src/main/java/Model/Upv1capturecontextsCompleteMandate.java index fbc339a21..c13068e4a 100644 --- a/src/main/java/Model/Upv1capturecontextsCompleteMandate.java +++ b/src/main/java/Model/Upv1capturecontextsCompleteMandate.java @@ -15,6 +15,7 @@ import java.util.Objects; import java.util.Arrays; +import Model.Upv1capturecontextsCompleteMandateTms; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -33,6 +34,9 @@ public class Upv1capturecontextsCompleteMandate { @SerializedName("type") private String type = null; + @SerializedName("tms") + private Upv1capturecontextsCompleteMandateTms tms = null; + @SerializedName("decisionManager") private Boolean decisionManager = null; @@ -57,6 +61,24 @@ public void setType(String type) { this.type = type; } + public Upv1capturecontextsCompleteMandate tms(Upv1capturecontextsCompleteMandateTms tms) { + this.tms = tms; + return this; + } + + /** + * Get tms + * @return tms + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsCompleteMandateTms getTms() { + return tms; + } + + public void setTms(Upv1capturecontextsCompleteMandateTms tms) { + this.tms = tms; + } + public Upv1capturecontextsCompleteMandate decisionManager(Boolean decisionManager) { this.decisionManager = decisionManager; return this; @@ -104,13 +126,14 @@ public boolean equals(java.lang.Object o) { } Upv1capturecontextsCompleteMandate upv1capturecontextsCompleteMandate = (Upv1capturecontextsCompleteMandate) o; return Objects.equals(this.type, upv1capturecontextsCompleteMandate.type) && + Objects.equals(this.tms, upv1capturecontextsCompleteMandate.tms) && Objects.equals(this.decisionManager, upv1capturecontextsCompleteMandate.decisionManager) && Objects.equals(this.consumerAuthentication, upv1capturecontextsCompleteMandate.consumerAuthentication); } @Override public int hashCode() { - return Objects.hash(type, decisionManager, consumerAuthentication); + return Objects.hash(type, tms, decisionManager, consumerAuthentication); } @@ -120,6 +143,7 @@ public String toString() { sb.append("class Upv1capturecontextsCompleteMandate {\n"); if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (tms != null) sb.append(" tms: ").append(toIndentedString(tms)).append("\n"); if (decisionManager != null) sb.append(" decisionManager: ").append(toIndentedString(decisionManager)).append("\n"); if (consumerAuthentication != null) sb.append(" consumerAuthentication: ").append(toIndentedString(consumerAuthentication)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Upv1capturecontextsCompleteMandateTms.java b/src/main/java/Model/Upv1capturecontextsCompleteMandateTms.java new file mode 100644 index 000000000..3bdfa6f15 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsCompleteMandateTms.java @@ -0,0 +1,128 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Configure Unified Checkout to create a TMS token at the end of the payment journey + */ +@ApiModel(description = "Configure Unified Checkout to create a TMS token at the end of the payment journey ") + +public class Upv1capturecontextsCompleteMandateTms { + @SerializedName("tokenCreate") + private Boolean tokenCreate = null; + + @SerializedName("tokenTypes") + private List tokenTypes = null; + + public Upv1capturecontextsCompleteMandateTms tokenCreate(Boolean tokenCreate) { + this.tokenCreate = tokenCreate; + return this; + } + + /** + * Use this when you want to create a token from the card/bank data in your payment request. Possible values: - True - False<br><br> + * @return tokenCreate + **/ + @ApiModelProperty(example = "true", value = "Use this when you want to create a token from the card/bank data in your payment request. Possible values: - True - False

") + public Boolean TokenCreate() { + return tokenCreate; + } + + public void setTokenCreate(Boolean tokenCreate) { + this.tokenCreate = tokenCreate; + } + + public Upv1capturecontextsCompleteMandateTms tokenTypes(List tokenTypes) { + this.tokenTypes = tokenTypes; + return this; + } + + public Upv1capturecontextsCompleteMandateTms addTokenTypesItem(String tokenTypesItem) { + if (this.tokenTypes == null) { + this.tokenTypes = new ArrayList(); + } + this.tokenTypes.add(tokenTypesItem); + return this; + } + + /** + * Cybersource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Possible values: - Customer - paymentInstrument - instrumentIdentifier - shippingAddress + * @return tokenTypes + **/ + @ApiModelProperty(value = "Cybersource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Possible values: - Customer - paymentInstrument - instrumentIdentifier - shippingAddress ") + public List getTokenTypes() { + return tokenTypes; + } + + public void setTokenTypes(List tokenTypes) { + this.tokenTypes = tokenTypes; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsCompleteMandateTms upv1capturecontextsCompleteMandateTms = (Upv1capturecontextsCompleteMandateTms) o; + return Objects.equals(this.tokenCreate, upv1capturecontextsCompleteMandateTms.tokenCreate) && + Objects.equals(this.tokenTypes, upv1capturecontextsCompleteMandateTms.tokenTypes); + } + + @Override + public int hashCode() { + return Objects.hash(tokenCreate, tokenTypes); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsCompleteMandateTms {\n"); + + if (tokenCreate != null) sb.append(" tokenCreate: ").append(toIndentedString(tokenCreate)).append("\n"); + if (tokenTypes != null) sb.append(" tokenTypes: ").append(toIndentedString(tokenTypes)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsData.java b/src/main/java/Model/Upv1capturecontextsData.java new file mode 100644 index 000000000..f8a0f417e --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsData.java @@ -0,0 +1,263 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataBuyerInformation; +import Model.Upv1capturecontextsDataClientReferenceInformation; +import Model.Upv1capturecontextsDataConsumerAuthenticationInformation; +import Model.Upv1capturecontextsDataMerchantDefinedInformation; +import Model.Upv1capturecontextsDataMerchantInformation; +import Model.Upv1capturecontextsDataOrderInformation; +import Model.Upv1capturecontextsDataProcessingInformation; +import Model.Upv1capturecontextsDataRecipientInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsData + */ + +public class Upv1capturecontextsData { + @SerializedName("orderInformation") + private Upv1capturecontextsDataOrderInformation orderInformation = null; + + @SerializedName("buyerInformation") + private Upv1capturecontextsDataBuyerInformation buyerInformation = null; + + @SerializedName("clientReferenceInformation") + private Upv1capturecontextsDataClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("consumerAuthenticationInformation") + private Upv1capturecontextsDataConsumerAuthenticationInformation consumerAuthenticationInformation = null; + + @SerializedName("merchantInformation") + private Upv1capturecontextsDataMerchantInformation merchantInformation = null; + + @SerializedName("processingInformation") + private Upv1capturecontextsDataProcessingInformation processingInformation = null; + + @SerializedName("recipientInformation") + private Upv1capturecontextsDataRecipientInformation recipientInformation = null; + + @SerializedName("merchantDefinedInformation") + private Upv1capturecontextsDataMerchantDefinedInformation merchantDefinedInformation = null; + + public Upv1capturecontextsData orderInformation(Upv1capturecontextsDataOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Upv1capturecontextsDataOrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public Upv1capturecontextsData buyerInformation(Upv1capturecontextsDataBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + return this; + } + + /** + * Get buyerInformation + * @return buyerInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataBuyerInformation getBuyerInformation() { + return buyerInformation; + } + + public void setBuyerInformation(Upv1capturecontextsDataBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + } + + public Upv1capturecontextsData clientReferenceInformation(Upv1capturecontextsDataClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(Upv1capturecontextsDataClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public Upv1capturecontextsData consumerAuthenticationInformation(Upv1capturecontextsDataConsumerAuthenticationInformation consumerAuthenticationInformation) { + this.consumerAuthenticationInformation = consumerAuthenticationInformation; + return this; + } + + /** + * Get consumerAuthenticationInformation + * @return consumerAuthenticationInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataConsumerAuthenticationInformation getConsumerAuthenticationInformation() { + return consumerAuthenticationInformation; + } + + public void setConsumerAuthenticationInformation(Upv1capturecontextsDataConsumerAuthenticationInformation consumerAuthenticationInformation) { + this.consumerAuthenticationInformation = consumerAuthenticationInformation; + } + + public Upv1capturecontextsData merchantInformation(Upv1capturecontextsDataMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + return this; + } + + /** + * Get merchantInformation + * @return merchantInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataMerchantInformation getMerchantInformation() { + return merchantInformation; + } + + public void setMerchantInformation(Upv1capturecontextsDataMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + } + + public Upv1capturecontextsData processingInformation(Upv1capturecontextsDataProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + return this; + } + + /** + * Get processingInformation + * @return processingInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataProcessingInformation getProcessingInformation() { + return processingInformation; + } + + public void setProcessingInformation(Upv1capturecontextsDataProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + } + + public Upv1capturecontextsData recipientInformation(Upv1capturecontextsDataRecipientInformation recipientInformation) { + this.recipientInformation = recipientInformation; + return this; + } + + /** + * Get recipientInformation + * @return recipientInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataRecipientInformation getRecipientInformation() { + return recipientInformation; + } + + public void setRecipientInformation(Upv1capturecontextsDataRecipientInformation recipientInformation) { + this.recipientInformation = recipientInformation; + } + + public Upv1capturecontextsData merchantDefinedInformation(Upv1capturecontextsDataMerchantDefinedInformation merchantDefinedInformation) { + this.merchantDefinedInformation = merchantDefinedInformation; + return this; + } + + /** + * Get merchantDefinedInformation + * @return merchantDefinedInformation + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataMerchantDefinedInformation getMerchantDefinedInformation() { + return merchantDefinedInformation; + } + + public void setMerchantDefinedInformation(Upv1capturecontextsDataMerchantDefinedInformation merchantDefinedInformation) { + this.merchantDefinedInformation = merchantDefinedInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsData upv1capturecontextsData = (Upv1capturecontextsData) o; + return Objects.equals(this.orderInformation, upv1capturecontextsData.orderInformation) && + Objects.equals(this.buyerInformation, upv1capturecontextsData.buyerInformation) && + Objects.equals(this.clientReferenceInformation, upv1capturecontextsData.clientReferenceInformation) && + Objects.equals(this.consumerAuthenticationInformation, upv1capturecontextsData.consumerAuthenticationInformation) && + Objects.equals(this.merchantInformation, upv1capturecontextsData.merchantInformation) && + Objects.equals(this.processingInformation, upv1capturecontextsData.processingInformation) && + Objects.equals(this.recipientInformation, upv1capturecontextsData.recipientInformation) && + Objects.equals(this.merchantDefinedInformation, upv1capturecontextsData.merchantDefinedInformation); + } + + @Override + public int hashCode() { + return Objects.hash(orderInformation, buyerInformation, clientReferenceInformation, consumerAuthenticationInformation, merchantInformation, processingInformation, recipientInformation, merchantDefinedInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsData {\n"); + + if (orderInformation != null) sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + if (buyerInformation != null) sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); + if (clientReferenceInformation != null) sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + if (consumerAuthenticationInformation != null) sb.append(" consumerAuthenticationInformation: ").append(toIndentedString(consumerAuthenticationInformation)).append("\n"); + if (merchantInformation != null) sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); + if (processingInformation != null) sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); + if (recipientInformation != null) sb.append(" recipientInformation: ").append(toIndentedString(recipientInformation)).append("\n"); + if (merchantDefinedInformation != null) sb.append(" merchantDefinedInformation: ").append(toIndentedString(merchantDefinedInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataBuyerInformation.java b/src/main/java/Model/Upv1capturecontextsDataBuyerInformation.java new file mode 100644 index 000000000..6b82adfba --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataBuyerInformation.java @@ -0,0 +1,141 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataBuyerInformationPersonalIdentification; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataBuyerInformation + */ + +public class Upv1capturecontextsDataBuyerInformation { + @SerializedName("personalIdentification") + private Upv1capturecontextsDataBuyerInformationPersonalIdentification personalIdentification = null; + + @SerializedName("merchantCustomerId") + private String merchantCustomerId = null; + + @SerializedName("companyTaxId") + private String companyTaxId = null; + + public Upv1capturecontextsDataBuyerInformation personalIdentification(Upv1capturecontextsDataBuyerInformationPersonalIdentification personalIdentification) { + this.personalIdentification = personalIdentification; + return this; + } + + /** + * Get personalIdentification + * @return personalIdentification + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataBuyerInformationPersonalIdentification getPersonalIdentification() { + return personalIdentification; + } + + public void setPersonalIdentification(Upv1capturecontextsDataBuyerInformationPersonalIdentification personalIdentification) { + this.personalIdentification = personalIdentification; + } + + public Upv1capturecontextsDataBuyerInformation merchantCustomerId(String merchantCustomerId) { + this.merchantCustomerId = merchantCustomerId; + return this; + } + + /** + * Get merchantCustomerId + * @return merchantCustomerId + **/ + @ApiModelProperty(example = "M123456767", value = "") + public String getMerchantCustomerId() { + return merchantCustomerId; + } + + public void setMerchantCustomerId(String merchantCustomerId) { + this.merchantCustomerId = merchantCustomerId; + } + + public Upv1capturecontextsDataBuyerInformation companyTaxId(String companyTaxId) { + this.companyTaxId = companyTaxId; + return this; + } + + /** + * Get companyTaxId + * @return companyTaxId + **/ + @ApiModelProperty(example = "", value = "") + public String getCompanyTaxId() { + return companyTaxId; + } + + public void setCompanyTaxId(String companyTaxId) { + this.companyTaxId = companyTaxId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataBuyerInformation upv1capturecontextsDataBuyerInformation = (Upv1capturecontextsDataBuyerInformation) o; + return Objects.equals(this.personalIdentification, upv1capturecontextsDataBuyerInformation.personalIdentification) && + Objects.equals(this.merchantCustomerId, upv1capturecontextsDataBuyerInformation.merchantCustomerId) && + Objects.equals(this.companyTaxId, upv1capturecontextsDataBuyerInformation.companyTaxId); + } + + @Override + public int hashCode() { + return Objects.hash(personalIdentification, merchantCustomerId, companyTaxId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataBuyerInformation {\n"); + + if (personalIdentification != null) sb.append(" personalIdentification: ").append(toIndentedString(personalIdentification)).append("\n"); + if (merchantCustomerId != null) sb.append(" merchantCustomerId: ").append(toIndentedString(merchantCustomerId)).append("\n"); + if (companyTaxId != null) sb.append(" companyTaxId: ").append(toIndentedString(companyTaxId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.java b/src/main/java/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.java new file mode 100644 index 000000000..6561d92eb --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataBuyerInformationPersonalIdentification + */ + +public class Upv1capturecontextsDataBuyerInformationPersonalIdentification { + @SerializedName("cpf") + private String cpf = null; + + public Upv1capturecontextsDataBuyerInformationPersonalIdentification cpf(String cpf) { + this.cpf = cpf; + return this; + } + + /** + * Get cpf + * @return cpf + **/ + @ApiModelProperty(example = "12345678900", value = "") + public String getCpf() { + return cpf; + } + + public void setCpf(String cpf) { + this.cpf = cpf; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataBuyerInformationPersonalIdentification upv1capturecontextsDataBuyerInformationPersonalIdentification = (Upv1capturecontextsDataBuyerInformationPersonalIdentification) o; + return Objects.equals(this.cpf, upv1capturecontextsDataBuyerInformationPersonalIdentification.cpf); + } + + @Override + public int hashCode() { + return Objects.hash(cpf); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataBuyerInformationPersonalIdentification {\n"); + + if (cpf != null) sb.append(" cpf: ").append(toIndentedString(cpf)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformation.java b/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformation.java new file mode 100644 index 000000000..3b30614b2 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformation.java @@ -0,0 +1,118 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataClientReferenceInformationPartner; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataClientReferenceInformation + */ + +public class Upv1capturecontextsDataClientReferenceInformation { + @SerializedName("code") + private String code = null; + + @SerializedName("partner") + private Upv1capturecontextsDataClientReferenceInformationPartner partner = null; + + public Upv1capturecontextsDataClientReferenceInformation code(String code) { + this.code = code; + return this; + } + + /** + * Get code + * @return code + **/ + @ApiModelProperty(example = "TC50171_3", value = "") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public Upv1capturecontextsDataClientReferenceInformation partner(Upv1capturecontextsDataClientReferenceInformationPartner partner) { + this.partner = partner; + return this; + } + + /** + * Get partner + * @return partner + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataClientReferenceInformationPartner getPartner() { + return partner; + } + + public void setPartner(Upv1capturecontextsDataClientReferenceInformationPartner partner) { + this.partner = partner; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataClientReferenceInformation upv1capturecontextsDataClientReferenceInformation = (Upv1capturecontextsDataClientReferenceInformation) o; + return Objects.equals(this.code, upv1capturecontextsDataClientReferenceInformation.code) && + Objects.equals(this.partner, upv1capturecontextsDataClientReferenceInformation.partner); + } + + @Override + public int hashCode() { + return Objects.hash(code, partner); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataClientReferenceInformation {\n"); + + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + if (partner != null) sb.append(" partner: ").append(toIndentedString(partner)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformationPartner.java b/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformationPartner.java new file mode 100644 index 000000000..c95a7cc1a --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataClientReferenceInformationPartner.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataClientReferenceInformationPartner + */ + +public class Upv1capturecontextsDataClientReferenceInformationPartner { + @SerializedName("developerId") + private String developerId = null; + + @SerializedName("SolutionId") + private String solutionId = null; + + public Upv1capturecontextsDataClientReferenceInformationPartner developerId(String developerId) { + this.developerId = developerId; + return this; + } + + /** + * Get developerId + * @return developerId + **/ + @ApiModelProperty(example = "DEV12345", value = "") + public String getDeveloperId() { + return developerId; + } + + public void setDeveloperId(String developerId) { + this.developerId = developerId; + } + + public Upv1capturecontextsDataClientReferenceInformationPartner solutionId(String solutionId) { + this.solutionId = solutionId; + return this; + } + + /** + * Get solutionId + * @return solutionId + **/ + @ApiModelProperty(example = "SOL1234", value = "") + public String getSolutionId() { + return solutionId; + } + + public void setSolutionId(String solutionId) { + this.solutionId = solutionId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataClientReferenceInformationPartner upv1capturecontextsDataClientReferenceInformationPartner = (Upv1capturecontextsDataClientReferenceInformationPartner) o; + return Objects.equals(this.developerId, upv1capturecontextsDataClientReferenceInformationPartner.developerId) && + Objects.equals(this.solutionId, upv1capturecontextsDataClientReferenceInformationPartner.solutionId); + } + + @Override + public int hashCode() { + return Objects.hash(developerId, solutionId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataClientReferenceInformationPartner {\n"); + + if (developerId != null) sb.append(" developerId: ").append(toIndentedString(developerId)).append("\n"); + if (solutionId != null) sb.append(" solutionId: ").append(toIndentedString(solutionId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.java b/src/main/java/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.java new file mode 100644 index 000000000..74c7eb8f0 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataConsumerAuthenticationInformation + */ + +public class Upv1capturecontextsDataConsumerAuthenticationInformation { + @SerializedName("challengeCode") + private String challengeCode = null; + + @SerializedName("messageCategory") + private String messageCategory = null; + + public Upv1capturecontextsDataConsumerAuthenticationInformation challengeCode(String challengeCode) { + this.challengeCode = challengeCode; + return this; + } + + /** + * Get challengeCode + * @return challengeCode + **/ + @ApiModelProperty(example = "01", value = "") + public String getChallengeCode() { + return challengeCode; + } + + public void setChallengeCode(String challengeCode) { + this.challengeCode = challengeCode; + } + + public Upv1capturecontextsDataConsumerAuthenticationInformation messageCategory(String messageCategory) { + this.messageCategory = messageCategory; + return this; + } + + /** + * Get messageCategory + * @return messageCategory + **/ + @ApiModelProperty(example = "01", value = "") + public String getMessageCategory() { + return messageCategory; + } + + public void setMessageCategory(String messageCategory) { + this.messageCategory = messageCategory; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataConsumerAuthenticationInformation upv1capturecontextsDataConsumerAuthenticationInformation = (Upv1capturecontextsDataConsumerAuthenticationInformation) o; + return Objects.equals(this.challengeCode, upv1capturecontextsDataConsumerAuthenticationInformation.challengeCode) && + Objects.equals(this.messageCategory, upv1capturecontextsDataConsumerAuthenticationInformation.messageCategory); + } + + @Override + public int hashCode() { + return Objects.hash(challengeCode, messageCategory); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataConsumerAuthenticationInformation {\n"); + + if (challengeCode != null) sb.append(" challengeCode: ").append(toIndentedString(challengeCode)).append("\n"); + if (messageCategory != null) sb.append(" messageCategory: ").append(toIndentedString(messageCategory)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataMerchantDefinedInformation.java b/src/main/java/Model/Upv1capturecontextsDataMerchantDefinedInformation.java new file mode 100644 index 000000000..8b7f60f44 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataMerchantDefinedInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataMerchantDefinedInformation + */ + +public class Upv1capturecontextsDataMerchantDefinedInformation { + @SerializedName("key") + private String key = null; + + @SerializedName("value") + private String value = null; + + public Upv1capturecontextsDataMerchantDefinedInformation key(String key) { + this.key = key; + return this; + } + + /** + * The key or identifier for the merchant-defined data field + * @return key + **/ + @ApiModelProperty(value = "The key or identifier for the merchant-defined data field") + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } + + public Upv1capturecontextsDataMerchantDefinedInformation value(String value) { + this.value = value; + return this; + } + + /** + * The value associated with the merchant-defined data field + * @return value + **/ + @ApiModelProperty(value = "The value associated with the merchant-defined data field") + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataMerchantDefinedInformation upv1capturecontextsDataMerchantDefinedInformation = (Upv1capturecontextsDataMerchantDefinedInformation) o; + return Objects.equals(this.key, upv1capturecontextsDataMerchantDefinedInformation.key) && + Objects.equals(this.value, upv1capturecontextsDataMerchantDefinedInformation.value); + } + + @Override + public int hashCode() { + return Objects.hash(key, value); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataMerchantDefinedInformation {\n"); + + if (key != null) sb.append(" key: ").append(toIndentedString(key)).append("\n"); + if (value != null) sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataMerchantInformation.java b/src/main/java/Model/Upv1capturecontextsDataMerchantInformation.java new file mode 100644 index 000000000..42cfa3aa6 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataMerchantInformation.java @@ -0,0 +1,95 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataMerchantInformationMerchantDescriptor; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataMerchantInformation + */ + +public class Upv1capturecontextsDataMerchantInformation { + @SerializedName("merchantDescriptor") + private Upv1capturecontextsDataMerchantInformationMerchantDescriptor merchantDescriptor = null; + + public Upv1capturecontextsDataMerchantInformation merchantDescriptor(Upv1capturecontextsDataMerchantInformationMerchantDescriptor merchantDescriptor) { + this.merchantDescriptor = merchantDescriptor; + return this; + } + + /** + * Get merchantDescriptor + * @return merchantDescriptor + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataMerchantInformationMerchantDescriptor getMerchantDescriptor() { + return merchantDescriptor; + } + + public void setMerchantDescriptor(Upv1capturecontextsDataMerchantInformationMerchantDescriptor merchantDescriptor) { + this.merchantDescriptor = merchantDescriptor; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataMerchantInformation upv1capturecontextsDataMerchantInformation = (Upv1capturecontextsDataMerchantInformation) o; + return Objects.equals(this.merchantDescriptor, upv1capturecontextsDataMerchantInformation.merchantDescriptor); + } + + @Override + public int hashCode() { + return Objects.hash(merchantDescriptor); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataMerchantInformation {\n"); + + if (merchantDescriptor != null) sb.append(" merchantDescriptor: ").append(toIndentedString(merchantDescriptor)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.java new file mode 100644 index 000000000..d60624eae --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataMerchantInformationMerchantDescriptor + */ + +public class Upv1capturecontextsDataMerchantInformationMerchantDescriptor { + @SerializedName("name") + private String name = null; + + public Upv1capturecontextsDataMerchantInformationMerchantDescriptor name(String name) { + this.name = name; + return this; + } + + /** + * The name of the merchant + * @return name + **/ + @ApiModelProperty(example = "Euro Electronics", value = "The name of the merchant") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataMerchantInformationMerchantDescriptor upv1capturecontextsDataMerchantInformationMerchantDescriptor = (Upv1capturecontextsDataMerchantInformationMerchantDescriptor) o; + return Objects.equals(this.name, upv1capturecontextsDataMerchantInformationMerchantDescriptor.name); + } + + @Override + public int hashCode() { + return Objects.hash(name); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataMerchantInformationMerchantDescriptor {\n"); + + if (name != null) sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformation.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformation.java new file mode 100644 index 000000000..05da7cc85 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformation.java @@ -0,0 +1,167 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataOrderInformationAmountDetails; +import Model.Upv1capturecontextsDataOrderInformationBillTo; +import Model.Upv1capturecontextsDataOrderInformationLineItems; +import Model.Upv1capturecontextsDataOrderInformationShipTo; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformation + */ + +public class Upv1capturecontextsDataOrderInformation { + @SerializedName("amountDetails") + private Upv1capturecontextsDataOrderInformationAmountDetails amountDetails = null; + + @SerializedName("billTo") + private Upv1capturecontextsDataOrderInformationBillTo billTo = null; + + @SerializedName("shipTo") + private Upv1capturecontextsDataOrderInformationShipTo shipTo = null; + + @SerializedName("lineItems") + private Upv1capturecontextsDataOrderInformationLineItems lineItems = null; + + public Upv1capturecontextsDataOrderInformation amountDetails(Upv1capturecontextsDataOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + return this; + } + + /** + * Get amountDetails + * @return amountDetails + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationAmountDetails getAmountDetails() { + return amountDetails; + } + + public void setAmountDetails(Upv1capturecontextsDataOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + } + + public Upv1capturecontextsDataOrderInformation billTo(Upv1capturecontextsDataOrderInformationBillTo billTo) { + this.billTo = billTo; + return this; + } + + /** + * Get billTo + * @return billTo + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationBillTo getBillTo() { + return billTo; + } + + public void setBillTo(Upv1capturecontextsDataOrderInformationBillTo billTo) { + this.billTo = billTo; + } + + public Upv1capturecontextsDataOrderInformation shipTo(Upv1capturecontextsDataOrderInformationShipTo shipTo) { + this.shipTo = shipTo; + return this; + } + + /** + * Get shipTo + * @return shipTo + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationShipTo getShipTo() { + return shipTo; + } + + public void setShipTo(Upv1capturecontextsDataOrderInformationShipTo shipTo) { + this.shipTo = shipTo; + } + + public Upv1capturecontextsDataOrderInformation lineItems(Upv1capturecontextsDataOrderInformationLineItems lineItems) { + this.lineItems = lineItems; + return this; + } + + /** + * Get lineItems + * @return lineItems + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationLineItems getLineItems() { + return lineItems; + } + + public void setLineItems(Upv1capturecontextsDataOrderInformationLineItems lineItems) { + this.lineItems = lineItems; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformation upv1capturecontextsDataOrderInformation = (Upv1capturecontextsDataOrderInformation) o; + return Objects.equals(this.amountDetails, upv1capturecontextsDataOrderInformation.amountDetails) && + Objects.equals(this.billTo, upv1capturecontextsDataOrderInformation.billTo) && + Objects.equals(this.shipTo, upv1capturecontextsDataOrderInformation.shipTo) && + Objects.equals(this.lineItems, upv1capturecontextsDataOrderInformation.lineItems); + } + + @Override + public int hashCode() { + return Objects.hash(amountDetails, billTo, shipTo, lineItems); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformation {\n"); + + if (amountDetails != null) sb.append(" amountDetails: ").append(toIndentedString(amountDetails)).append("\n"); + if (billTo != null) sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); + if (shipTo != null) sb.append(" shipTo: ").append(toIndentedString(shipTo)).append("\n"); + if (lineItems != null) sb.append(" lineItems: ").append(toIndentedString(lineItems)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetails.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetails.java new file mode 100644 index 000000000..bc6218cbc --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetails.java @@ -0,0 +1,233 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformationAmountDetails + */ + +public class Upv1capturecontextsDataOrderInformationAmountDetails { + @SerializedName("totalAmount") + private String totalAmount = null; + + @SerializedName("currency") + private String currency = null; + + @SerializedName("surcharge") + private Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge surcharge = null; + + @SerializedName("discountAmount") + private String discountAmount = null; + + @SerializedName("subTotalAmount") + private String subTotalAmount = null; + + @SerializedName("serviceFeeAmount") + private String serviceFeeAmount = null; + + @SerializedName("taxAmount") + private String taxAmount = null; + + public Upv1capturecontextsDataOrderInformationAmountDetails totalAmount(String totalAmount) { + this.totalAmount = totalAmount; + return this; + } + + /** + * This field defines the total order amount. + * @return totalAmount + **/ + @ApiModelProperty(example = "21", value = "This field defines the total order amount. ") + public String getTotalAmount() { + return totalAmount; + } + + public void setTotalAmount(String totalAmount) { + this.totalAmount = totalAmount; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails currency(String currency) { + this.currency = currency; + return this; + } + + /** + * This field defines the currency applicable to the order. + * @return currency + **/ + @ApiModelProperty(example = "USD", value = "This field defines the currency applicable to the order. ") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails surcharge(Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge surcharge) { + this.surcharge = surcharge; + return this; + } + + /** + * Get surcharge + * @return surcharge + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge getSurcharge() { + return surcharge; + } + + public void setSurcharge(Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge surcharge) { + this.surcharge = surcharge; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails discountAmount(String discountAmount) { + this.discountAmount = discountAmount; + return this; + } + + /** + * This field defines the discount amount applicable to the order. + * @return discountAmount + **/ + @ApiModelProperty(example = "2", value = "This field defines the discount amount applicable to the order. ") + public String getDiscountAmount() { + return discountAmount; + } + + public void setDiscountAmount(String discountAmount) { + this.discountAmount = discountAmount; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails subTotalAmount(String subTotalAmount) { + this.subTotalAmount = subTotalAmount; + return this; + } + + /** + * This field defines the sub total amount applicable to the order. + * @return subTotalAmount + **/ + @ApiModelProperty(example = "5", value = "This field defines the sub total amount applicable to the order. ") + public String getSubTotalAmount() { + return subTotalAmount; + } + + public void setSubTotalAmount(String subTotalAmount) { + this.subTotalAmount = subTotalAmount; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails serviceFeeAmount(String serviceFeeAmount) { + this.serviceFeeAmount = serviceFeeAmount; + return this; + } + + /** + * This field defines the service fee amount applicable to the order. + * @return serviceFeeAmount + **/ + @ApiModelProperty(example = "5", value = "This field defines the service fee amount applicable to the order. ") + public String getServiceFeeAmount() { + return serviceFeeAmount; + } + + public void setServiceFeeAmount(String serviceFeeAmount) { + this.serviceFeeAmount = serviceFeeAmount; + } + + public Upv1capturecontextsDataOrderInformationAmountDetails taxAmount(String taxAmount) { + this.taxAmount = taxAmount; + return this; + } + + /** + * This field defines the tax amount applicable to the order. + * @return taxAmount + **/ + @ApiModelProperty(example = "10", value = "This field defines the tax amount applicable to the order. ") + public String getTaxAmount() { + return taxAmount; + } + + public void setTaxAmount(String taxAmount) { + this.taxAmount = taxAmount; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformationAmountDetails upv1capturecontextsDataOrderInformationAmountDetails = (Upv1capturecontextsDataOrderInformationAmountDetails) o; + return Objects.equals(this.totalAmount, upv1capturecontextsDataOrderInformationAmountDetails.totalAmount) && + Objects.equals(this.currency, upv1capturecontextsDataOrderInformationAmountDetails.currency) && + Objects.equals(this.surcharge, upv1capturecontextsDataOrderInformationAmountDetails.surcharge) && + Objects.equals(this.discountAmount, upv1capturecontextsDataOrderInformationAmountDetails.discountAmount) && + Objects.equals(this.subTotalAmount, upv1capturecontextsDataOrderInformationAmountDetails.subTotalAmount) && + Objects.equals(this.serviceFeeAmount, upv1capturecontextsDataOrderInformationAmountDetails.serviceFeeAmount) && + Objects.equals(this.taxAmount, upv1capturecontextsDataOrderInformationAmountDetails.taxAmount); + } + + @Override + public int hashCode() { + return Objects.hash(totalAmount, currency, surcharge, discountAmount, subTotalAmount, serviceFeeAmount, taxAmount); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformationAmountDetails {\n"); + + if (totalAmount != null) sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n"); + if (currency != null) sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + if (surcharge != null) sb.append(" surcharge: ").append(toIndentedString(surcharge)).append("\n"); + if (discountAmount != null) sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n"); + if (subTotalAmount != null) sb.append(" subTotalAmount: ").append(toIndentedString(subTotalAmount)).append("\n"); + if (serviceFeeAmount != null) sb.append(" serviceFeeAmount: ").append(toIndentedString(serviceFeeAmount)).append("\n"); + if (taxAmount != null) sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.java new file mode 100644 index 000000000..5200e0847 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge + */ + +public class Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge { + @SerializedName("amount") + private String amount = null; + + public Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge amount(String amount) { + this.amount = amount; + return this; + } + + /** + * This field defines the surcharge amount applicable to the order. + * @return amount + **/ + @ApiModelProperty(example = "2.5", value = "This field defines the surcharge amount applicable to the order. ") + public String getAmount() { + return amount; + } + + public void setAmount(String amount) { + this.amount = amount; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge upv1capturecontextsDataOrderInformationAmountDetailsSurcharge = (Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge) o; + return Objects.equals(this.amount, upv1capturecontextsDataOrderInformationAmountDetailsSurcharge.amount); + } + + @Override + public int hashCode() { + return Objects.hash(amount); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge {\n"); + + if (amount != null) sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsOrderInformationBillTo.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationBillTo.java similarity index 76% rename from src/main/java/Model/Upv1capturecontextsOrderInformationBillTo.java rename to src/main/java/Model/Upv1capturecontextsDataOrderInformationBillTo.java index 2ce5a35df..5338ecd65 100644 --- a/src/main/java/Model/Upv1capturecontextsOrderInformationBillTo.java +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationBillTo.java @@ -15,7 +15,7 @@ import java.util.Objects; import java.util.Arrays; -import Model.Upv1capturecontextsOrderInformationBillToCompany; +import Model.Upv1capturecontextsDataOrderInformationBillToCompany; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -26,10 +26,10 @@ import java.io.IOException; /** - * Upv1capturecontextsOrderInformationBillTo + * Upv1capturecontextsDataOrderInformationBillTo */ -public class Upv1capturecontextsOrderInformationBillTo { +public class Upv1capturecontextsDataOrderInformationBillTo { @SerializedName("address1") private String address1 = null; @@ -61,7 +61,7 @@ public class Upv1capturecontextsOrderInformationBillTo { private String postalCode = null; @SerializedName("company") - private Upv1capturecontextsOrderInformationBillToCompany company = null; + private Upv1capturecontextsDataOrderInformationBillToCompany company = null; @SerializedName("email") private String email = null; @@ -87,7 +87,7 @@ public class Upv1capturecontextsOrderInformationBillTo { @SerializedName("phoneType") private String phoneType = null; - public Upv1capturecontextsOrderInformationBillTo address1(String address1) { + public Upv1capturecontextsDataOrderInformationBillTo address1(String address1) { this.address1 = address1; return this; } @@ -105,7 +105,7 @@ public void setAddress1(String address1) { this.address1 = address1; } - public Upv1capturecontextsOrderInformationBillTo address2(String address2) { + public Upv1capturecontextsDataOrderInformationBillTo address2(String address2) { this.address2 = address2; return this; } @@ -123,7 +123,7 @@ public void setAddress2(String address2) { this.address2 = address2; } - public Upv1capturecontextsOrderInformationBillTo address3(String address3) { + public Upv1capturecontextsDataOrderInformationBillTo address3(String address3) { this.address3 = address3; return this; } @@ -141,7 +141,7 @@ public void setAddress3(String address3) { this.address3 = address3; } - public Upv1capturecontextsOrderInformationBillTo address4(String address4) { + public Upv1capturecontextsDataOrderInformationBillTo address4(String address4) { this.address4 = address4; return this; } @@ -159,7 +159,7 @@ public void setAddress4(String address4) { this.address4 = address4; } - public Upv1capturecontextsOrderInformationBillTo administrativeArea(String administrativeArea) { + public Upv1capturecontextsDataOrderInformationBillTo administrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; return this; } @@ -177,7 +177,7 @@ public void setAdministrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; } - public Upv1capturecontextsOrderInformationBillTo buildingNumber(String buildingNumber) { + public Upv1capturecontextsDataOrderInformationBillTo buildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; return this; } @@ -195,7 +195,7 @@ public void setBuildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; } - public Upv1capturecontextsOrderInformationBillTo country(String country) { + public Upv1capturecontextsDataOrderInformationBillTo country(String country) { this.country = country; return this; } @@ -213,7 +213,7 @@ public void setCountry(String country) { this.country = country; } - public Upv1capturecontextsOrderInformationBillTo district(String district) { + public Upv1capturecontextsDataOrderInformationBillTo district(String district) { this.district = district; return this; } @@ -231,7 +231,7 @@ public void setDistrict(String district) { this.district = district; } - public Upv1capturecontextsOrderInformationBillTo locality(String locality) { + public Upv1capturecontextsDataOrderInformationBillTo locality(String locality) { this.locality = locality; return this; } @@ -249,7 +249,7 @@ public void setLocality(String locality) { this.locality = locality; } - public Upv1capturecontextsOrderInformationBillTo postalCode(String postalCode) { + public Upv1capturecontextsDataOrderInformationBillTo postalCode(String postalCode) { this.postalCode = postalCode; return this; } @@ -267,7 +267,7 @@ public void setPostalCode(String postalCode) { this.postalCode = postalCode; } - public Upv1capturecontextsOrderInformationBillTo company(Upv1capturecontextsOrderInformationBillToCompany company) { + public Upv1capturecontextsDataOrderInformationBillTo company(Upv1capturecontextsDataOrderInformationBillToCompany company) { this.company = company; return this; } @@ -277,15 +277,15 @@ public Upv1capturecontextsOrderInformationBillTo company(Upv1capturecontextsOrde * @return company **/ @ApiModelProperty(value = "") - public Upv1capturecontextsOrderInformationBillToCompany getCompany() { + public Upv1capturecontextsDataOrderInformationBillToCompany getCompany() { return company; } - public void setCompany(Upv1capturecontextsOrderInformationBillToCompany company) { + public void setCompany(Upv1capturecontextsDataOrderInformationBillToCompany company) { this.company = company; } - public Upv1capturecontextsOrderInformationBillTo email(String email) { + public Upv1capturecontextsDataOrderInformationBillTo email(String email) { this.email = email; return this; } @@ -303,7 +303,7 @@ public void setEmail(String email) { this.email = email; } - public Upv1capturecontextsOrderInformationBillTo firstName(String firstName) { + public Upv1capturecontextsDataOrderInformationBillTo firstName(String firstName) { this.firstName = firstName; return this; } @@ -321,7 +321,7 @@ public void setFirstName(String firstName) { this.firstName = firstName; } - public Upv1capturecontextsOrderInformationBillTo lastName(String lastName) { + public Upv1capturecontextsDataOrderInformationBillTo lastName(String lastName) { this.lastName = lastName; return this; } @@ -339,7 +339,7 @@ public void setLastName(String lastName) { this.lastName = lastName; } - public Upv1capturecontextsOrderInformationBillTo middleName(String middleName) { + public Upv1capturecontextsDataOrderInformationBillTo middleName(String middleName) { this.middleName = middleName; return this; } @@ -357,7 +357,7 @@ public void setMiddleName(String middleName) { this.middleName = middleName; } - public Upv1capturecontextsOrderInformationBillTo nameSuffix(String nameSuffix) { + public Upv1capturecontextsDataOrderInformationBillTo nameSuffix(String nameSuffix) { this.nameSuffix = nameSuffix; return this; } @@ -375,7 +375,7 @@ public void setNameSuffix(String nameSuffix) { this.nameSuffix = nameSuffix; } - public Upv1capturecontextsOrderInformationBillTo title(String title) { + public Upv1capturecontextsDataOrderInformationBillTo title(String title) { this.title = title; return this; } @@ -393,7 +393,7 @@ public void setTitle(String title) { this.title = title; } - public Upv1capturecontextsOrderInformationBillTo phoneNumber(String phoneNumber) { + public Upv1capturecontextsDataOrderInformationBillTo phoneNumber(String phoneNumber) { this.phoneNumber = phoneNumber; return this; } @@ -411,7 +411,7 @@ public void setPhoneNumber(String phoneNumber) { this.phoneNumber = phoneNumber; } - public Upv1capturecontextsOrderInformationBillTo phoneType(String phoneType) { + public Upv1capturecontextsDataOrderInformationBillTo phoneType(String phoneType) { this.phoneType = phoneType; return this; } @@ -438,26 +438,26 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Upv1capturecontextsOrderInformationBillTo upv1capturecontextsOrderInformationBillTo = (Upv1capturecontextsOrderInformationBillTo) o; - return Objects.equals(this.address1, upv1capturecontextsOrderInformationBillTo.address1) && - Objects.equals(this.address2, upv1capturecontextsOrderInformationBillTo.address2) && - Objects.equals(this.address3, upv1capturecontextsOrderInformationBillTo.address3) && - Objects.equals(this.address4, upv1capturecontextsOrderInformationBillTo.address4) && - Objects.equals(this.administrativeArea, upv1capturecontextsOrderInformationBillTo.administrativeArea) && - Objects.equals(this.buildingNumber, upv1capturecontextsOrderInformationBillTo.buildingNumber) && - Objects.equals(this.country, upv1capturecontextsOrderInformationBillTo.country) && - Objects.equals(this.district, upv1capturecontextsOrderInformationBillTo.district) && - Objects.equals(this.locality, upv1capturecontextsOrderInformationBillTo.locality) && - Objects.equals(this.postalCode, upv1capturecontextsOrderInformationBillTo.postalCode) && - Objects.equals(this.company, upv1capturecontextsOrderInformationBillTo.company) && - Objects.equals(this.email, upv1capturecontextsOrderInformationBillTo.email) && - Objects.equals(this.firstName, upv1capturecontextsOrderInformationBillTo.firstName) && - Objects.equals(this.lastName, upv1capturecontextsOrderInformationBillTo.lastName) && - Objects.equals(this.middleName, upv1capturecontextsOrderInformationBillTo.middleName) && - Objects.equals(this.nameSuffix, upv1capturecontextsOrderInformationBillTo.nameSuffix) && - Objects.equals(this.title, upv1capturecontextsOrderInformationBillTo.title) && - Objects.equals(this.phoneNumber, upv1capturecontextsOrderInformationBillTo.phoneNumber) && - Objects.equals(this.phoneType, upv1capturecontextsOrderInformationBillTo.phoneType); + Upv1capturecontextsDataOrderInformationBillTo upv1capturecontextsDataOrderInformationBillTo = (Upv1capturecontextsDataOrderInformationBillTo) o; + return Objects.equals(this.address1, upv1capturecontextsDataOrderInformationBillTo.address1) && + Objects.equals(this.address2, upv1capturecontextsDataOrderInformationBillTo.address2) && + Objects.equals(this.address3, upv1capturecontextsDataOrderInformationBillTo.address3) && + Objects.equals(this.address4, upv1capturecontextsDataOrderInformationBillTo.address4) && + Objects.equals(this.administrativeArea, upv1capturecontextsDataOrderInformationBillTo.administrativeArea) && + Objects.equals(this.buildingNumber, upv1capturecontextsDataOrderInformationBillTo.buildingNumber) && + Objects.equals(this.country, upv1capturecontextsDataOrderInformationBillTo.country) && + Objects.equals(this.district, upv1capturecontextsDataOrderInformationBillTo.district) && + Objects.equals(this.locality, upv1capturecontextsDataOrderInformationBillTo.locality) && + Objects.equals(this.postalCode, upv1capturecontextsDataOrderInformationBillTo.postalCode) && + Objects.equals(this.company, upv1capturecontextsDataOrderInformationBillTo.company) && + Objects.equals(this.email, upv1capturecontextsDataOrderInformationBillTo.email) && + Objects.equals(this.firstName, upv1capturecontextsDataOrderInformationBillTo.firstName) && + Objects.equals(this.lastName, upv1capturecontextsDataOrderInformationBillTo.lastName) && + Objects.equals(this.middleName, upv1capturecontextsDataOrderInformationBillTo.middleName) && + Objects.equals(this.nameSuffix, upv1capturecontextsDataOrderInformationBillTo.nameSuffix) && + Objects.equals(this.title, upv1capturecontextsDataOrderInformationBillTo.title) && + Objects.equals(this.phoneNumber, upv1capturecontextsDataOrderInformationBillTo.phoneNumber) && + Objects.equals(this.phoneType, upv1capturecontextsDataOrderInformationBillTo.phoneType); } @Override @@ -469,7 +469,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Upv1capturecontextsOrderInformationBillTo {\n"); + sb.append("class Upv1capturecontextsDataOrderInformationBillTo {\n"); if (address1 != null) sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); if (address2 != null) sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); diff --git a/src/main/java/Model/Upv1capturecontextsOrderInformationBillToCompany.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationBillToCompany.java similarity index 77% rename from src/main/java/Model/Upv1capturecontextsOrderInformationBillToCompany.java rename to src/main/java/Model/Upv1capturecontextsDataOrderInformationBillToCompany.java index 7de6e3542..5f926d986 100644 --- a/src/main/java/Model/Upv1capturecontextsOrderInformationBillToCompany.java +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationBillToCompany.java @@ -25,10 +25,10 @@ import java.io.IOException; /** - * Upv1capturecontextsOrderInformationBillToCompany + * Upv1capturecontextsDataOrderInformationBillToCompany */ -public class Upv1capturecontextsOrderInformationBillToCompany { +public class Upv1capturecontextsDataOrderInformationBillToCompany { @SerializedName("name") private String name = null; @@ -62,7 +62,7 @@ public class Upv1capturecontextsOrderInformationBillToCompany { @SerializedName("postalCode") private String postalCode = null; - public Upv1capturecontextsOrderInformationBillToCompany name(String name) { + public Upv1capturecontextsDataOrderInformationBillToCompany name(String name) { this.name = name; return this; } @@ -80,7 +80,7 @@ public void setName(String name) { this.name = name; } - public Upv1capturecontextsOrderInformationBillToCompany address1(String address1) { + public Upv1capturecontextsDataOrderInformationBillToCompany address1(String address1) { this.address1 = address1; return this; } @@ -98,7 +98,7 @@ public void setAddress1(String address1) { this.address1 = address1; } - public Upv1capturecontextsOrderInformationBillToCompany address2(String address2) { + public Upv1capturecontextsDataOrderInformationBillToCompany address2(String address2) { this.address2 = address2; return this; } @@ -116,7 +116,7 @@ public void setAddress2(String address2) { this.address2 = address2; } - public Upv1capturecontextsOrderInformationBillToCompany address3(String address3) { + public Upv1capturecontextsDataOrderInformationBillToCompany address3(String address3) { this.address3 = address3; return this; } @@ -134,7 +134,7 @@ public void setAddress3(String address3) { this.address3 = address3; } - public Upv1capturecontextsOrderInformationBillToCompany address4(String address4) { + public Upv1capturecontextsDataOrderInformationBillToCompany address4(String address4) { this.address4 = address4; return this; } @@ -152,7 +152,7 @@ public void setAddress4(String address4) { this.address4 = address4; } - public Upv1capturecontextsOrderInformationBillToCompany administrativeArea(String administrativeArea) { + public Upv1capturecontextsDataOrderInformationBillToCompany administrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; return this; } @@ -170,7 +170,7 @@ public void setAdministrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; } - public Upv1capturecontextsOrderInformationBillToCompany buildingNumber(String buildingNumber) { + public Upv1capturecontextsDataOrderInformationBillToCompany buildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; return this; } @@ -188,7 +188,7 @@ public void setBuildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; } - public Upv1capturecontextsOrderInformationBillToCompany country(String country) { + public Upv1capturecontextsDataOrderInformationBillToCompany country(String country) { this.country = country; return this; } @@ -206,7 +206,7 @@ public void setCountry(String country) { this.country = country; } - public Upv1capturecontextsOrderInformationBillToCompany district(String district) { + public Upv1capturecontextsDataOrderInformationBillToCompany district(String district) { this.district = district; return this; } @@ -224,7 +224,7 @@ public void setDistrict(String district) { this.district = district; } - public Upv1capturecontextsOrderInformationBillToCompany locality(String locality) { + public Upv1capturecontextsDataOrderInformationBillToCompany locality(String locality) { this.locality = locality; return this; } @@ -242,7 +242,7 @@ public void setLocality(String locality) { this.locality = locality; } - public Upv1capturecontextsOrderInformationBillToCompany postalCode(String postalCode) { + public Upv1capturecontextsDataOrderInformationBillToCompany postalCode(String postalCode) { this.postalCode = postalCode; return this; } @@ -269,18 +269,18 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Upv1capturecontextsOrderInformationBillToCompany upv1capturecontextsOrderInformationBillToCompany = (Upv1capturecontextsOrderInformationBillToCompany) o; - return Objects.equals(this.name, upv1capturecontextsOrderInformationBillToCompany.name) && - Objects.equals(this.address1, upv1capturecontextsOrderInformationBillToCompany.address1) && - Objects.equals(this.address2, upv1capturecontextsOrderInformationBillToCompany.address2) && - Objects.equals(this.address3, upv1capturecontextsOrderInformationBillToCompany.address3) && - Objects.equals(this.address4, upv1capturecontextsOrderInformationBillToCompany.address4) && - Objects.equals(this.administrativeArea, upv1capturecontextsOrderInformationBillToCompany.administrativeArea) && - Objects.equals(this.buildingNumber, upv1capturecontextsOrderInformationBillToCompany.buildingNumber) && - Objects.equals(this.country, upv1capturecontextsOrderInformationBillToCompany.country) && - Objects.equals(this.district, upv1capturecontextsOrderInformationBillToCompany.district) && - Objects.equals(this.locality, upv1capturecontextsOrderInformationBillToCompany.locality) && - Objects.equals(this.postalCode, upv1capturecontextsOrderInformationBillToCompany.postalCode); + Upv1capturecontextsDataOrderInformationBillToCompany upv1capturecontextsDataOrderInformationBillToCompany = (Upv1capturecontextsDataOrderInformationBillToCompany) o; + return Objects.equals(this.name, upv1capturecontextsDataOrderInformationBillToCompany.name) && + Objects.equals(this.address1, upv1capturecontextsDataOrderInformationBillToCompany.address1) && + Objects.equals(this.address2, upv1capturecontextsDataOrderInformationBillToCompany.address2) && + Objects.equals(this.address3, upv1capturecontextsDataOrderInformationBillToCompany.address3) && + Objects.equals(this.address4, upv1capturecontextsDataOrderInformationBillToCompany.address4) && + Objects.equals(this.administrativeArea, upv1capturecontextsDataOrderInformationBillToCompany.administrativeArea) && + Objects.equals(this.buildingNumber, upv1capturecontextsDataOrderInformationBillToCompany.buildingNumber) && + Objects.equals(this.country, upv1capturecontextsDataOrderInformationBillToCompany.country) && + Objects.equals(this.district, upv1capturecontextsDataOrderInformationBillToCompany.district) && + Objects.equals(this.locality, upv1capturecontextsDataOrderInformationBillToCompany.locality) && + Objects.equals(this.postalCode, upv1capturecontextsDataOrderInformationBillToCompany.postalCode); } @Override @@ -292,7 +292,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Upv1capturecontextsOrderInformationBillToCompany {\n"); + sb.append("class Upv1capturecontextsDataOrderInformationBillToCompany {\n"); if (name != null) sb.append(" name: ").append(toIndentedString(name)).append("\n"); if (address1 != null) sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItems.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItems.java new file mode 100644 index 000000000..e9037facd --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItems.java @@ -0,0 +1,811 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataOrderInformationLineItemsPassenger; +import Model.Upv1capturecontextsDataOrderInformationLineItemsTaxDetails; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformationLineItems + */ + +public class Upv1capturecontextsDataOrderInformationLineItems { + @SerializedName("productCode") + private String productCode = null; + + @SerializedName("productName") + private String productName = null; + + @SerializedName("productSku") + private String productSku = null; + + @SerializedName("quantity") + private Integer quantity = null; + + @SerializedName("unitPrice") + private String unitPrice = null; + + @SerializedName("unitOfMeasure") + private String unitOfMeasure = null; + + @SerializedName("totalAmount") + private String totalAmount = null; + + @SerializedName("taxAmount") + private String taxAmount = null; + + @SerializedName("taxRate") + private String taxRate = null; + + @SerializedName("taxAppliedAfterDiscount") + private String taxAppliedAfterDiscount = null; + + @SerializedName("taxStatusIndicator") + private String taxStatusIndicator = null; + + @SerializedName("taxTypeCode") + private String taxTypeCode = null; + + @SerializedName("amountIncludesTax") + private Boolean amountIncludesTax = null; + + @SerializedName("typeOfSupply") + private String typeOfSupply = null; + + @SerializedName("commodityCode") + private String commodityCode = null; + + @SerializedName("discountAmount") + private String discountAmount = null; + + @SerializedName("discountApplied") + private Boolean discountApplied = null; + + @SerializedName("discountRate") + private String discountRate = null; + + @SerializedName("invoiceNumber") + private String invoiceNumber = null; + + @SerializedName("taxDetails") + private Upv1capturecontextsDataOrderInformationLineItemsTaxDetails taxDetails = null; + + @SerializedName("fulfillmentType") + private String fulfillmentType = null; + + @SerializedName("weight") + private String weight = null; + + @SerializedName("weightIdentifier") + private String weightIdentifier = null; + + @SerializedName("weightUnit") + private String weightUnit = null; + + @SerializedName("referenceDataCode") + private String referenceDataCode = null; + + @SerializedName("referenceDataNumber") + private String referenceDataNumber = null; + + @SerializedName("unitTaxAmount") + private String unitTaxAmount = null; + + @SerializedName("productDescription") + private String productDescription = null; + + @SerializedName("giftCardCurrency") + private String giftCardCurrency = null; + + @SerializedName("shippingDestinationTypes") + private String shippingDestinationTypes = null; + + @SerializedName("gift") + private Boolean gift = null; + + @SerializedName("passenger") + private Upv1capturecontextsDataOrderInformationLineItemsPassenger passenger = null; + + public Upv1capturecontextsDataOrderInformationLineItems productCode(String productCode) { + this.productCode = productCode; + return this; + } + + /** + * Get productCode + * @return productCode + **/ + @ApiModelProperty(example = "electronics", value = "") + public String getProductCode() { + return productCode; + } + + public void setProductCode(String productCode) { + this.productCode = productCode; + } + + public Upv1capturecontextsDataOrderInformationLineItems productName(String productName) { + this.productName = productName; + return this; + } + + /** + * Get productName + * @return productName + **/ + @ApiModelProperty(example = "smartphone", value = "") + public String getProductName() { + return productName; + } + + public void setProductName(String productName) { + this.productName = productName; + } + + public Upv1capturecontextsDataOrderInformationLineItems productSku(String productSku) { + this.productSku = productSku; + return this; + } + + /** + * Get productSku + * @return productSku + **/ + @ApiModelProperty(example = "SKU12345", value = "") + public String getProductSku() { + return productSku; + } + + public void setProductSku(String productSku) { + this.productSku = productSku; + } + + public Upv1capturecontextsDataOrderInformationLineItems quantity(Integer quantity) { + this.quantity = quantity; + return this; + } + + /** + * Get quantity + * minimum: 1 + * maximum: 999999999 + * @return quantity + **/ + @ApiModelProperty(example = "2", value = "") + public Integer getQuantity() { + return quantity; + } + + public void setQuantity(Integer quantity) { + this.quantity = quantity; + } + + public Upv1capturecontextsDataOrderInformationLineItems unitPrice(String unitPrice) { + this.unitPrice = unitPrice; + return this; + } + + /** + * Get unitPrice + * @return unitPrice + **/ + @ApiModelProperty(example = "399.99", value = "") + public String getUnitPrice() { + return unitPrice; + } + + public void setUnitPrice(String unitPrice) { + this.unitPrice = unitPrice; + } + + public Upv1capturecontextsDataOrderInformationLineItems unitOfMeasure(String unitOfMeasure) { + this.unitOfMeasure = unitOfMeasure; + return this; + } + + /** + * Get unitOfMeasure + * @return unitOfMeasure + **/ + @ApiModelProperty(example = "EA", value = "") + public String getUnitOfMeasure() { + return unitOfMeasure; + } + + public void setUnitOfMeasure(String unitOfMeasure) { + this.unitOfMeasure = unitOfMeasure; + } + + public Upv1capturecontextsDataOrderInformationLineItems totalAmount(String totalAmount) { + this.totalAmount = totalAmount; + return this; + } + + /** + * Get totalAmount + * @return totalAmount + **/ + @ApiModelProperty(example = "799.98", value = "") + public String getTotalAmount() { + return totalAmount; + } + + public void setTotalAmount(String totalAmount) { + this.totalAmount = totalAmount; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxAmount(String taxAmount) { + this.taxAmount = taxAmount; + return this; + } + + /** + * Get taxAmount + * @return taxAmount + **/ + @ApiModelProperty(example = "64.00", value = "") + public String getTaxAmount() { + return taxAmount; + } + + public void setTaxAmount(String taxAmount) { + this.taxAmount = taxAmount; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxRate(String taxRate) { + this.taxRate = taxRate; + return this; + } + + /** + * Get taxRate + * @return taxRate + **/ + @ApiModelProperty(example = "0.88", value = "") + public String getTaxRate() { + return taxRate; + } + + public void setTaxRate(String taxRate) { + this.taxRate = taxRate; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxAppliedAfterDiscount(String taxAppliedAfterDiscount) { + this.taxAppliedAfterDiscount = taxAppliedAfterDiscount; + return this; + } + + /** + * Get taxAppliedAfterDiscount + * @return taxAppliedAfterDiscount + **/ + @ApiModelProperty(example = "Y", value = "") + public String getTaxAppliedAfterDiscount() { + return taxAppliedAfterDiscount; + } + + public void setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount) { + this.taxAppliedAfterDiscount = taxAppliedAfterDiscount; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxStatusIndicator(String taxStatusIndicator) { + this.taxStatusIndicator = taxStatusIndicator; + return this; + } + + /** + * Get taxStatusIndicator + * @return taxStatusIndicator + **/ + @ApiModelProperty(example = "N", value = "") + public String getTaxStatusIndicator() { + return taxStatusIndicator; + } + + public void setTaxStatusIndicator(String taxStatusIndicator) { + this.taxStatusIndicator = taxStatusIndicator; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxTypeCode(String taxTypeCode) { + this.taxTypeCode = taxTypeCode; + return this; + } + + /** + * Get taxTypeCode + * @return taxTypeCode + **/ + @ApiModelProperty(example = "VAT", value = "") + public String getTaxTypeCode() { + return taxTypeCode; + } + + public void setTaxTypeCode(String taxTypeCode) { + this.taxTypeCode = taxTypeCode; + } + + public Upv1capturecontextsDataOrderInformationLineItems amountIncludesTax(Boolean amountIncludesTax) { + this.amountIncludesTax = amountIncludesTax; + return this; + } + + /** + * Get amountIncludesTax + * @return amountIncludesTax + **/ + @ApiModelProperty(example = "false", value = "") + public Boolean AmountIncludesTax() { + return amountIncludesTax; + } + + public void setAmountIncludesTax(Boolean amountIncludesTax) { + this.amountIncludesTax = amountIncludesTax; + } + + public Upv1capturecontextsDataOrderInformationLineItems typeOfSupply(String typeOfSupply) { + this.typeOfSupply = typeOfSupply; + return this; + } + + /** + * Get typeOfSupply + * @return typeOfSupply + **/ + @ApiModelProperty(example = "GS", value = "") + public String getTypeOfSupply() { + return typeOfSupply; + } + + public void setTypeOfSupply(String typeOfSupply) { + this.typeOfSupply = typeOfSupply; + } + + public Upv1capturecontextsDataOrderInformationLineItems commodityCode(String commodityCode) { + this.commodityCode = commodityCode; + return this; + } + + /** + * Get commodityCode + * @return commodityCode + **/ + @ApiModelProperty(example = "123456", value = "") + public String getCommodityCode() { + return commodityCode; + } + + public void setCommodityCode(String commodityCode) { + this.commodityCode = commodityCode; + } + + public Upv1capturecontextsDataOrderInformationLineItems discountAmount(String discountAmount) { + this.discountAmount = discountAmount; + return this; + } + + /** + * Get discountAmount + * @return discountAmount + **/ + @ApiModelProperty(example = "10.00", value = "") + public String getDiscountAmount() { + return discountAmount; + } + + public void setDiscountAmount(String discountAmount) { + this.discountAmount = discountAmount; + } + + public Upv1capturecontextsDataOrderInformationLineItems discountApplied(Boolean discountApplied) { + this.discountApplied = discountApplied; + return this; + } + + /** + * Get discountApplied + * @return discountApplied + **/ + @ApiModelProperty(example = "true", value = "") + public Boolean DiscountApplied() { + return discountApplied; + } + + public void setDiscountApplied(Boolean discountApplied) { + this.discountApplied = discountApplied; + } + + public Upv1capturecontextsDataOrderInformationLineItems discountRate(String discountRate) { + this.discountRate = discountRate; + return this; + } + + /** + * Get discountRate + * @return discountRate + **/ + @ApiModelProperty(example = "0.05", value = "") + public String getDiscountRate() { + return discountRate; + } + + public void setDiscountRate(String discountRate) { + this.discountRate = discountRate; + } + + public Upv1capturecontextsDataOrderInformationLineItems invoiceNumber(String invoiceNumber) { + this.invoiceNumber = invoiceNumber; + return this; + } + + /** + * Get invoiceNumber + * @return invoiceNumber + **/ + @ApiModelProperty(example = "INV-001", value = "") + public String getInvoiceNumber() { + return invoiceNumber; + } + + public void setInvoiceNumber(String invoiceNumber) { + this.invoiceNumber = invoiceNumber; + } + + public Upv1capturecontextsDataOrderInformationLineItems taxDetails(Upv1capturecontextsDataOrderInformationLineItemsTaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + + /** + * Get taxDetails + * @return taxDetails + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails getTaxDetails() { + return taxDetails; + } + + public void setTaxDetails(Upv1capturecontextsDataOrderInformationLineItemsTaxDetails taxDetails) { + this.taxDetails = taxDetails; + } + + public Upv1capturecontextsDataOrderInformationLineItems fulfillmentType(String fulfillmentType) { + this.fulfillmentType = fulfillmentType; + return this; + } + + /** + * Get fulfillmentType + * @return fulfillmentType + **/ + @ApiModelProperty(example = "Delivery", value = "") + public String getFulfillmentType() { + return fulfillmentType; + } + + public void setFulfillmentType(String fulfillmentType) { + this.fulfillmentType = fulfillmentType; + } + + public Upv1capturecontextsDataOrderInformationLineItems weight(String weight) { + this.weight = weight; + return this; + } + + /** + * Get weight + * @return weight + **/ + @ApiModelProperty(example = "1.5", value = "") + public String getWeight() { + return weight; + } + + public void setWeight(String weight) { + this.weight = weight; + } + + public Upv1capturecontextsDataOrderInformationLineItems weightIdentifier(String weightIdentifier) { + this.weightIdentifier = weightIdentifier; + return this; + } + + /** + * Get weightIdentifier + * @return weightIdentifier + **/ + @ApiModelProperty(example = "N", value = "") + public String getWeightIdentifier() { + return weightIdentifier; + } + + public void setWeightIdentifier(String weightIdentifier) { + this.weightIdentifier = weightIdentifier; + } + + public Upv1capturecontextsDataOrderInformationLineItems weightUnit(String weightUnit) { + this.weightUnit = weightUnit; + return this; + } + + /** + * Get weightUnit + * @return weightUnit + **/ + @ApiModelProperty(example = "KG", value = "") + public String getWeightUnit() { + return weightUnit; + } + + public void setWeightUnit(String weightUnit) { + this.weightUnit = weightUnit; + } + + public Upv1capturecontextsDataOrderInformationLineItems referenceDataCode(String referenceDataCode) { + this.referenceDataCode = referenceDataCode; + return this; + } + + /** + * Get referenceDataCode + * @return referenceDataCode + **/ + @ApiModelProperty(example = "REFCODE", value = "") + public String getReferenceDataCode() { + return referenceDataCode; + } + + public void setReferenceDataCode(String referenceDataCode) { + this.referenceDataCode = referenceDataCode; + } + + public Upv1capturecontextsDataOrderInformationLineItems referenceDataNumber(String referenceDataNumber) { + this.referenceDataNumber = referenceDataNumber; + return this; + } + + /** + * Get referenceDataNumber + * @return referenceDataNumber + **/ + @ApiModelProperty(example = "REF123", value = "") + public String getReferenceDataNumber() { + return referenceDataNumber; + } + + public void setReferenceDataNumber(String referenceDataNumber) { + this.referenceDataNumber = referenceDataNumber; + } + + public Upv1capturecontextsDataOrderInformationLineItems unitTaxAmount(String unitTaxAmount) { + this.unitTaxAmount = unitTaxAmount; + return this; + } + + /** + * Get unitTaxAmount + * @return unitTaxAmount + **/ + @ApiModelProperty(example = "3.20", value = "") + public String getUnitTaxAmount() { + return unitTaxAmount; + } + + public void setUnitTaxAmount(String unitTaxAmount) { + this.unitTaxAmount = unitTaxAmount; + } + + public Upv1capturecontextsDataOrderInformationLineItems productDescription(String productDescription) { + this.productDescription = productDescription; + return this; + } + + /** + * Get productDescription + * @return productDescription + **/ + @ApiModelProperty(example = "Latest model smartphone", value = "") + public String getProductDescription() { + return productDescription; + } + + public void setProductDescription(String productDescription) { + this.productDescription = productDescription; + } + + public Upv1capturecontextsDataOrderInformationLineItems giftCardCurrency(String giftCardCurrency) { + this.giftCardCurrency = giftCardCurrency; + return this; + } + + /** + * Get giftCardCurrency + * @return giftCardCurrency + **/ + @ApiModelProperty(example = "USD", value = "") + public String getGiftCardCurrency() { + return giftCardCurrency; + } + + public void setGiftCardCurrency(String giftCardCurrency) { + this.giftCardCurrency = giftCardCurrency; + } + + public Upv1capturecontextsDataOrderInformationLineItems shippingDestinationTypes(String shippingDestinationTypes) { + this.shippingDestinationTypes = shippingDestinationTypes; + return this; + } + + /** + * Get shippingDestinationTypes + * @return shippingDestinationTypes + **/ + @ApiModelProperty(example = "Residential", value = "") + public String getShippingDestinationTypes() { + return shippingDestinationTypes; + } + + public void setShippingDestinationTypes(String shippingDestinationTypes) { + this.shippingDestinationTypes = shippingDestinationTypes; + } + + public Upv1capturecontextsDataOrderInformationLineItems gift(Boolean gift) { + this.gift = gift; + return this; + } + + /** + * Get gift + * @return gift + **/ + @ApiModelProperty(example = "false", value = "") + public Boolean Gift() { + return gift; + } + + public void setGift(Boolean gift) { + this.gift = gift; + } + + public Upv1capturecontextsDataOrderInformationLineItems passenger(Upv1capturecontextsDataOrderInformationLineItemsPassenger passenger) { + this.passenger = passenger; + return this; + } + + /** + * Get passenger + * @return passenger + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataOrderInformationLineItemsPassenger getPassenger() { + return passenger; + } + + public void setPassenger(Upv1capturecontextsDataOrderInformationLineItemsPassenger passenger) { + this.passenger = passenger; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformationLineItems upv1capturecontextsDataOrderInformationLineItems = (Upv1capturecontextsDataOrderInformationLineItems) o; + return Objects.equals(this.productCode, upv1capturecontextsDataOrderInformationLineItems.productCode) && + Objects.equals(this.productName, upv1capturecontextsDataOrderInformationLineItems.productName) && + Objects.equals(this.productSku, upv1capturecontextsDataOrderInformationLineItems.productSku) && + Objects.equals(this.quantity, upv1capturecontextsDataOrderInformationLineItems.quantity) && + Objects.equals(this.unitPrice, upv1capturecontextsDataOrderInformationLineItems.unitPrice) && + Objects.equals(this.unitOfMeasure, upv1capturecontextsDataOrderInformationLineItems.unitOfMeasure) && + Objects.equals(this.totalAmount, upv1capturecontextsDataOrderInformationLineItems.totalAmount) && + Objects.equals(this.taxAmount, upv1capturecontextsDataOrderInformationLineItems.taxAmount) && + Objects.equals(this.taxRate, upv1capturecontextsDataOrderInformationLineItems.taxRate) && + Objects.equals(this.taxAppliedAfterDiscount, upv1capturecontextsDataOrderInformationLineItems.taxAppliedAfterDiscount) && + Objects.equals(this.taxStatusIndicator, upv1capturecontextsDataOrderInformationLineItems.taxStatusIndicator) && + Objects.equals(this.taxTypeCode, upv1capturecontextsDataOrderInformationLineItems.taxTypeCode) && + Objects.equals(this.amountIncludesTax, upv1capturecontextsDataOrderInformationLineItems.amountIncludesTax) && + Objects.equals(this.typeOfSupply, upv1capturecontextsDataOrderInformationLineItems.typeOfSupply) && + Objects.equals(this.commodityCode, upv1capturecontextsDataOrderInformationLineItems.commodityCode) && + Objects.equals(this.discountAmount, upv1capturecontextsDataOrderInformationLineItems.discountAmount) && + Objects.equals(this.discountApplied, upv1capturecontextsDataOrderInformationLineItems.discountApplied) && + Objects.equals(this.discountRate, upv1capturecontextsDataOrderInformationLineItems.discountRate) && + Objects.equals(this.invoiceNumber, upv1capturecontextsDataOrderInformationLineItems.invoiceNumber) && + Objects.equals(this.taxDetails, upv1capturecontextsDataOrderInformationLineItems.taxDetails) && + Objects.equals(this.fulfillmentType, upv1capturecontextsDataOrderInformationLineItems.fulfillmentType) && + Objects.equals(this.weight, upv1capturecontextsDataOrderInformationLineItems.weight) && + Objects.equals(this.weightIdentifier, upv1capturecontextsDataOrderInformationLineItems.weightIdentifier) && + Objects.equals(this.weightUnit, upv1capturecontextsDataOrderInformationLineItems.weightUnit) && + Objects.equals(this.referenceDataCode, upv1capturecontextsDataOrderInformationLineItems.referenceDataCode) && + Objects.equals(this.referenceDataNumber, upv1capturecontextsDataOrderInformationLineItems.referenceDataNumber) && + Objects.equals(this.unitTaxAmount, upv1capturecontextsDataOrderInformationLineItems.unitTaxAmount) && + Objects.equals(this.productDescription, upv1capturecontextsDataOrderInformationLineItems.productDescription) && + Objects.equals(this.giftCardCurrency, upv1capturecontextsDataOrderInformationLineItems.giftCardCurrency) && + Objects.equals(this.shippingDestinationTypes, upv1capturecontextsDataOrderInformationLineItems.shippingDestinationTypes) && + Objects.equals(this.gift, upv1capturecontextsDataOrderInformationLineItems.gift) && + Objects.equals(this.passenger, upv1capturecontextsDataOrderInformationLineItems.passenger); + } + + @Override + public int hashCode() { + return Objects.hash(productCode, productName, productSku, quantity, unitPrice, unitOfMeasure, totalAmount, taxAmount, taxRate, taxAppliedAfterDiscount, taxStatusIndicator, taxTypeCode, amountIncludesTax, typeOfSupply, commodityCode, discountAmount, discountApplied, discountRate, invoiceNumber, taxDetails, fulfillmentType, weight, weightIdentifier, weightUnit, referenceDataCode, referenceDataNumber, unitTaxAmount, productDescription, giftCardCurrency, shippingDestinationTypes, gift, passenger); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformationLineItems {\n"); + + if (productCode != null) sb.append(" productCode: ").append(toIndentedString(productCode)).append("\n"); + if (productName != null) sb.append(" productName: ").append(toIndentedString(productName)).append("\n"); + if (productSku != null) sb.append(" productSku: ").append(toIndentedString(productSku)).append("\n"); + if (quantity != null) sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n"); + if (unitPrice != null) sb.append(" unitPrice: ").append(toIndentedString(unitPrice)).append("\n"); + if (unitOfMeasure != null) sb.append(" unitOfMeasure: ").append(toIndentedString(unitOfMeasure)).append("\n"); + if (totalAmount != null) sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n"); + if (taxAmount != null) sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n"); + if (taxRate != null) sb.append(" taxRate: ").append(toIndentedString(taxRate)).append("\n"); + if (taxAppliedAfterDiscount != null) sb.append(" taxAppliedAfterDiscount: ").append(toIndentedString(taxAppliedAfterDiscount)).append("\n"); + if (taxStatusIndicator != null) sb.append(" taxStatusIndicator: ").append(toIndentedString(taxStatusIndicator)).append("\n"); + if (taxTypeCode != null) sb.append(" taxTypeCode: ").append(toIndentedString(taxTypeCode)).append("\n"); + if (amountIncludesTax != null) sb.append(" amountIncludesTax: ").append(toIndentedString(amountIncludesTax)).append("\n"); + if (typeOfSupply != null) sb.append(" typeOfSupply: ").append(toIndentedString(typeOfSupply)).append("\n"); + if (commodityCode != null) sb.append(" commodityCode: ").append(toIndentedString(commodityCode)).append("\n"); + if (discountAmount != null) sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n"); + if (discountApplied != null) sb.append(" discountApplied: ").append(toIndentedString(discountApplied)).append("\n"); + if (discountRate != null) sb.append(" discountRate: ").append(toIndentedString(discountRate)).append("\n"); + if (invoiceNumber != null) sb.append(" invoiceNumber: ").append(toIndentedString(invoiceNumber)).append("\n"); + if (taxDetails != null) sb.append(" taxDetails: ").append(toIndentedString(taxDetails)).append("\n"); + if (fulfillmentType != null) sb.append(" fulfillmentType: ").append(toIndentedString(fulfillmentType)).append("\n"); + if (weight != null) sb.append(" weight: ").append(toIndentedString(weight)).append("\n"); + if (weightIdentifier != null) sb.append(" weightIdentifier: ").append(toIndentedString(weightIdentifier)).append("\n"); + if (weightUnit != null) sb.append(" weightUnit: ").append(toIndentedString(weightUnit)).append("\n"); + if (referenceDataCode != null) sb.append(" referenceDataCode: ").append(toIndentedString(referenceDataCode)).append("\n"); + if (referenceDataNumber != null) sb.append(" referenceDataNumber: ").append(toIndentedString(referenceDataNumber)).append("\n"); + if (unitTaxAmount != null) sb.append(" unitTaxAmount: ").append(toIndentedString(unitTaxAmount)).append("\n"); + if (productDescription != null) sb.append(" productDescription: ").append(toIndentedString(productDescription)).append("\n"); + if (giftCardCurrency != null) sb.append(" giftCardCurrency: ").append(toIndentedString(giftCardCurrency)).append("\n"); + if (shippingDestinationTypes != null) sb.append(" shippingDestinationTypes: ").append(toIndentedString(shippingDestinationTypes)).append("\n"); + if (gift != null) sb.append(" gift: ").append(toIndentedString(gift)).append("\n"); + if (passenger != null) sb.append(" passenger: ").append(toIndentedString(passenger)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.java new file mode 100644 index 000000000..c87e480d9 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.java @@ -0,0 +1,255 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformationLineItemsPassenger + */ + +public class Upv1capturecontextsDataOrderInformationLineItemsPassenger { + @SerializedName("type") + private String type = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("phone") + private String phone = null; + + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("email") + private String email = null; + + @SerializedName("nationality") + private String nationality = null; + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @ApiModelProperty(example = "Residential", value = "") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger status(String status) { + this.status = status; + return this; + } + + /** + * Get status + * @return status + **/ + @ApiModelProperty(example = "Gold", value = "") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger phone(String phone) { + this.phone = phone; + return this; + } + + /** + * Get phone + * @return phone + **/ + @ApiModelProperty(example = "123456789", value = "") + public String getPhone() { + return phone; + } + + public void setPhone(String phone) { + this.phone = phone; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Get firstName + * @return firstName + **/ + @ApiModelProperty(example = "John", value = "") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Get lastName + * @return lastName + **/ + @ApiModelProperty(example = "Doe", value = "") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @ApiModelProperty(example = "AIR1234567", value = "") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger email(String email) { + this.email = email; + return this; + } + + /** + * Get email + * @return email + **/ + @ApiModelProperty(example = "john.doe@example.com", value = "") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public Upv1capturecontextsDataOrderInformationLineItemsPassenger nationality(String nationality) { + this.nationality = nationality; + return this; + } + + /** + * Get nationality + * @return nationality + **/ + @ApiModelProperty(example = "US", value = "") + public String getNationality() { + return nationality; + } + + public void setNationality(String nationality) { + this.nationality = nationality; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformationLineItemsPassenger upv1capturecontextsDataOrderInformationLineItemsPassenger = (Upv1capturecontextsDataOrderInformationLineItemsPassenger) o; + return Objects.equals(this.type, upv1capturecontextsDataOrderInformationLineItemsPassenger.type) && + Objects.equals(this.status, upv1capturecontextsDataOrderInformationLineItemsPassenger.status) && + Objects.equals(this.phone, upv1capturecontextsDataOrderInformationLineItemsPassenger.phone) && + Objects.equals(this.firstName, upv1capturecontextsDataOrderInformationLineItemsPassenger.firstName) && + Objects.equals(this.lastName, upv1capturecontextsDataOrderInformationLineItemsPassenger.lastName) && + Objects.equals(this.id, upv1capturecontextsDataOrderInformationLineItemsPassenger.id) && + Objects.equals(this.email, upv1capturecontextsDataOrderInformationLineItemsPassenger.email) && + Objects.equals(this.nationality, upv1capturecontextsDataOrderInformationLineItemsPassenger.nationality); + } + + @Override + public int hashCode() { + return Objects.hash(type, status, phone, firstName, lastName, id, email, nationality); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformationLineItemsPassenger {\n"); + + if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (status != null) sb.append(" status: ").append(toIndentedString(status)).append("\n"); + if (phone != null) sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + if (firstName != null) sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + if (lastName != null) sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + if (id != null) sb.append(" id: ").append(toIndentedString(id)).append("\n"); + if (email != null) sb.append(" email: ").append(toIndentedString(email)).append("\n"); + if (nationality != null) sb.append(" nationality: ").append(toIndentedString(nationality)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.java new file mode 100644 index 000000000..571d21819 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.java @@ -0,0 +1,232 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataOrderInformationLineItemsTaxDetails + */ + +public class Upv1capturecontextsDataOrderInformationLineItemsTaxDetails { + @SerializedName("type") + private String type = null; + + @SerializedName("amount") + private String amount = null; + + @SerializedName("rate") + private String rate = null; + + @SerializedName("code") + private String code = null; + + @SerializedName("taxId") + private String taxId = null; + + @SerializedName("applied") + private Boolean applied = null; + + @SerializedName("exemptionCode") + private String exemptionCode = null; + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @ApiModelProperty(example = "VAT", value = "") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails amount(String amount) { + this.amount = amount; + return this; + } + + /** + * Get amount + * @return amount + **/ + @ApiModelProperty(example = "5.99", value = "") + public String getAmount() { + return amount; + } + + public void setAmount(String amount) { + this.amount = amount; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails rate(String rate) { + this.rate = rate; + return this; + } + + /** + * Get rate + * @return rate + **/ + @ApiModelProperty(example = "20", value = "") + public String getRate() { + return rate; + } + + public void setRate(String rate) { + this.rate = rate; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails code(String code) { + this.code = code; + return this; + } + + /** + * Get code + * @return code + **/ + @ApiModelProperty(example = "VAT", value = "") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails taxId(String taxId) { + this.taxId = taxId; + return this; + } + + /** + * Get taxId + * @return taxId + **/ + @ApiModelProperty(example = "TAXID12345", value = "") + public String getTaxId() { + return taxId; + } + + public void setTaxId(String taxId) { + this.taxId = taxId; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails applied(Boolean applied) { + this.applied = applied; + return this; + } + + /** + * Get applied + * @return applied + **/ + @ApiModelProperty(example = "true", value = "") + public Boolean Applied() { + return applied; + } + + public void setApplied(Boolean applied) { + this.applied = applied; + } + + public Upv1capturecontextsDataOrderInformationLineItemsTaxDetails exemptionCode(String exemptionCode) { + this.exemptionCode = exemptionCode; + return this; + } + + /** + * Get exemptionCode + * @return exemptionCode + **/ + @ApiModelProperty(example = "E", value = "") + public String getExemptionCode() { + return exemptionCode; + } + + public void setExemptionCode(String exemptionCode) { + this.exemptionCode = exemptionCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataOrderInformationLineItemsTaxDetails upv1capturecontextsDataOrderInformationLineItemsTaxDetails = (Upv1capturecontextsDataOrderInformationLineItemsTaxDetails) o; + return Objects.equals(this.type, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.type) && + Objects.equals(this.amount, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.amount) && + Objects.equals(this.rate, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.rate) && + Objects.equals(this.code, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.code) && + Objects.equals(this.taxId, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.taxId) && + Objects.equals(this.applied, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.applied) && + Objects.equals(this.exemptionCode, upv1capturecontextsDataOrderInformationLineItemsTaxDetails.exemptionCode); + } + + @Override + public int hashCode() { + return Objects.hash(type, amount, rate, code, taxId, applied, exemptionCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataOrderInformationLineItemsTaxDetails {\n"); + + if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + if (amount != null) sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + if (rate != null) sb.append(" rate: ").append(toIndentedString(rate)).append("\n"); + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + if (taxId != null) sb.append(" taxId: ").append(toIndentedString(taxId)).append("\n"); + if (applied != null) sb.append(" applied: ").append(toIndentedString(applied)).append("\n"); + if (exemptionCode != null) sb.append(" exemptionCode: ").append(toIndentedString(exemptionCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsOrderInformationShipTo.java b/src/main/java/Model/Upv1capturecontextsDataOrderInformationShipTo.java similarity index 78% rename from src/main/java/Model/Upv1capturecontextsOrderInformationShipTo.java rename to src/main/java/Model/Upv1capturecontextsDataOrderInformationShipTo.java index 2fd0711eb..7598de572 100644 --- a/src/main/java/Model/Upv1capturecontextsOrderInformationShipTo.java +++ b/src/main/java/Model/Upv1capturecontextsDataOrderInformationShipTo.java @@ -25,10 +25,10 @@ import java.io.IOException; /** - * Upv1capturecontextsOrderInformationShipTo + * Upv1capturecontextsDataOrderInformationShipTo */ -public class Upv1capturecontextsOrderInformationShipTo { +public class Upv1capturecontextsDataOrderInformationShipTo { @SerializedName("address1") private String address1 = null; @@ -65,7 +65,7 @@ public class Upv1capturecontextsOrderInformationShipTo { @SerializedName("lastName") private String lastName = null; - public Upv1capturecontextsOrderInformationShipTo address1(String address1) { + public Upv1capturecontextsDataOrderInformationShipTo address1(String address1) { this.address1 = address1; return this; } @@ -83,7 +83,7 @@ public void setAddress1(String address1) { this.address1 = address1; } - public Upv1capturecontextsOrderInformationShipTo address2(String address2) { + public Upv1capturecontextsDataOrderInformationShipTo address2(String address2) { this.address2 = address2; return this; } @@ -101,7 +101,7 @@ public void setAddress2(String address2) { this.address2 = address2; } - public Upv1capturecontextsOrderInformationShipTo address3(String address3) { + public Upv1capturecontextsDataOrderInformationShipTo address3(String address3) { this.address3 = address3; return this; } @@ -119,7 +119,7 @@ public void setAddress3(String address3) { this.address3 = address3; } - public Upv1capturecontextsOrderInformationShipTo address4(String address4) { + public Upv1capturecontextsDataOrderInformationShipTo address4(String address4) { this.address4 = address4; return this; } @@ -137,7 +137,7 @@ public void setAddress4(String address4) { this.address4 = address4; } - public Upv1capturecontextsOrderInformationShipTo administrativeArea(String administrativeArea) { + public Upv1capturecontextsDataOrderInformationShipTo administrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; return this; } @@ -155,7 +155,7 @@ public void setAdministrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; } - public Upv1capturecontextsOrderInformationShipTo buildingNumber(String buildingNumber) { + public Upv1capturecontextsDataOrderInformationShipTo buildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; return this; } @@ -173,7 +173,7 @@ public void setBuildingNumber(String buildingNumber) { this.buildingNumber = buildingNumber; } - public Upv1capturecontextsOrderInformationShipTo country(String country) { + public Upv1capturecontextsDataOrderInformationShipTo country(String country) { this.country = country; return this; } @@ -191,7 +191,7 @@ public void setCountry(String country) { this.country = country; } - public Upv1capturecontextsOrderInformationShipTo district(String district) { + public Upv1capturecontextsDataOrderInformationShipTo district(String district) { this.district = district; return this; } @@ -209,7 +209,7 @@ public void setDistrict(String district) { this.district = district; } - public Upv1capturecontextsOrderInformationShipTo locality(String locality) { + public Upv1capturecontextsDataOrderInformationShipTo locality(String locality) { this.locality = locality; return this; } @@ -227,7 +227,7 @@ public void setLocality(String locality) { this.locality = locality; } - public Upv1capturecontextsOrderInformationShipTo postalCode(String postalCode) { + public Upv1capturecontextsDataOrderInformationShipTo postalCode(String postalCode) { this.postalCode = postalCode; return this; } @@ -245,7 +245,7 @@ public void setPostalCode(String postalCode) { this.postalCode = postalCode; } - public Upv1capturecontextsOrderInformationShipTo firstName(String firstName) { + public Upv1capturecontextsDataOrderInformationShipTo firstName(String firstName) { this.firstName = firstName; return this; } @@ -263,7 +263,7 @@ public void setFirstName(String firstName) { this.firstName = firstName; } - public Upv1capturecontextsOrderInformationShipTo lastName(String lastName) { + public Upv1capturecontextsDataOrderInformationShipTo lastName(String lastName) { this.lastName = lastName; return this; } @@ -290,19 +290,19 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Upv1capturecontextsOrderInformationShipTo upv1capturecontextsOrderInformationShipTo = (Upv1capturecontextsOrderInformationShipTo) o; - return Objects.equals(this.address1, upv1capturecontextsOrderInformationShipTo.address1) && - Objects.equals(this.address2, upv1capturecontextsOrderInformationShipTo.address2) && - Objects.equals(this.address3, upv1capturecontextsOrderInformationShipTo.address3) && - Objects.equals(this.address4, upv1capturecontextsOrderInformationShipTo.address4) && - Objects.equals(this.administrativeArea, upv1capturecontextsOrderInformationShipTo.administrativeArea) && - Objects.equals(this.buildingNumber, upv1capturecontextsOrderInformationShipTo.buildingNumber) && - Objects.equals(this.country, upv1capturecontextsOrderInformationShipTo.country) && - Objects.equals(this.district, upv1capturecontextsOrderInformationShipTo.district) && - Objects.equals(this.locality, upv1capturecontextsOrderInformationShipTo.locality) && - Objects.equals(this.postalCode, upv1capturecontextsOrderInformationShipTo.postalCode) && - Objects.equals(this.firstName, upv1capturecontextsOrderInformationShipTo.firstName) && - Objects.equals(this.lastName, upv1capturecontextsOrderInformationShipTo.lastName); + Upv1capturecontextsDataOrderInformationShipTo upv1capturecontextsDataOrderInformationShipTo = (Upv1capturecontextsDataOrderInformationShipTo) o; + return Objects.equals(this.address1, upv1capturecontextsDataOrderInformationShipTo.address1) && + Objects.equals(this.address2, upv1capturecontextsDataOrderInformationShipTo.address2) && + Objects.equals(this.address3, upv1capturecontextsDataOrderInformationShipTo.address3) && + Objects.equals(this.address4, upv1capturecontextsDataOrderInformationShipTo.address4) && + Objects.equals(this.administrativeArea, upv1capturecontextsDataOrderInformationShipTo.administrativeArea) && + Objects.equals(this.buildingNumber, upv1capturecontextsDataOrderInformationShipTo.buildingNumber) && + Objects.equals(this.country, upv1capturecontextsDataOrderInformationShipTo.country) && + Objects.equals(this.district, upv1capturecontextsDataOrderInformationShipTo.district) && + Objects.equals(this.locality, upv1capturecontextsDataOrderInformationShipTo.locality) && + Objects.equals(this.postalCode, upv1capturecontextsDataOrderInformationShipTo.postalCode) && + Objects.equals(this.firstName, upv1capturecontextsDataOrderInformationShipTo.firstName) && + Objects.equals(this.lastName, upv1capturecontextsDataOrderInformationShipTo.lastName); } @Override @@ -314,7 +314,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Upv1capturecontextsOrderInformationShipTo {\n"); + sb.append("class Upv1capturecontextsDataOrderInformationShipTo {\n"); if (address1 != null) sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); if (address2 != null) sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); diff --git a/src/main/java/Model/Upv1capturecontextsDataProcessingInformation.java b/src/main/java/Model/Upv1capturecontextsDataProcessingInformation.java new file mode 100644 index 000000000..4c48b8b4b --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataProcessingInformation.java @@ -0,0 +1,118 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataProcessingInformationAuthorizationOptions; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataProcessingInformation + */ + +public class Upv1capturecontextsDataProcessingInformation { + @SerializedName("reconciliationId") + private String reconciliationId = null; + + @SerializedName("authorizationOptions") + private Upv1capturecontextsDataProcessingInformationAuthorizationOptions authorizationOptions = null; + + public Upv1capturecontextsDataProcessingInformation reconciliationId(String reconciliationId) { + this.reconciliationId = reconciliationId; + return this; + } + + /** + * Get reconciliationId + * @return reconciliationId + **/ + @ApiModelProperty(example = "01234567", value = "") + public String getReconciliationId() { + return reconciliationId; + } + + public void setReconciliationId(String reconciliationId) { + this.reconciliationId = reconciliationId; + } + + public Upv1capturecontextsDataProcessingInformation authorizationOptions(Upv1capturecontextsDataProcessingInformationAuthorizationOptions authorizationOptions) { + this.authorizationOptions = authorizationOptions; + return this; + } + + /** + * Get authorizationOptions + * @return authorizationOptions + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataProcessingInformationAuthorizationOptions getAuthorizationOptions() { + return authorizationOptions; + } + + public void setAuthorizationOptions(Upv1capturecontextsDataProcessingInformationAuthorizationOptions authorizationOptions) { + this.authorizationOptions = authorizationOptions; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataProcessingInformation upv1capturecontextsDataProcessingInformation = (Upv1capturecontextsDataProcessingInformation) o; + return Objects.equals(this.reconciliationId, upv1capturecontextsDataProcessingInformation.reconciliationId) && + Objects.equals(this.authorizationOptions, upv1capturecontextsDataProcessingInformation.authorizationOptions); + } + + @Override + public int hashCode() { + return Objects.hash(reconciliationId, authorizationOptions); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataProcessingInformation {\n"); + + if (reconciliationId != null) sb.append(" reconciliationId: ").append(toIndentedString(reconciliationId)).append("\n"); + if (authorizationOptions != null) sb.append(" authorizationOptions: ").append(toIndentedString(authorizationOptions)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.java b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.java new file mode 100644 index 000000000..ef6ff56c2 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.java @@ -0,0 +1,141 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataProcessingInformationAuthorizationOptions + */ + +public class Upv1capturecontextsDataProcessingInformationAuthorizationOptions { + @SerializedName("aftIndicator") + private Boolean aftIndicator = null; + + @SerializedName("initiator") + private Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator initiator = null; + + @SerializedName("businessApplicationId") + private String businessApplicationId = null; + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptions aftIndicator(Boolean aftIndicator) { + this.aftIndicator = aftIndicator; + return this; + } + + /** + * Get aftIndicator + * @return aftIndicator + **/ + @ApiModelProperty(example = "true", value = "") + public Boolean AftIndicator() { + return aftIndicator; + } + + public void setAftIndicator(Boolean aftIndicator) { + this.aftIndicator = aftIndicator; + } + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptions initiator(Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator initiator) { + this.initiator = initiator; + return this; + } + + /** + * Get initiator + * @return initiator + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator getInitiator() { + return initiator; + } + + public void setInitiator(Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator initiator) { + this.initiator = initiator; + } + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptions businessApplicationId(String businessApplicationId) { + this.businessApplicationId = businessApplicationId; + return this; + } + + /** + * Get businessApplicationId + * @return businessApplicationId + **/ + @ApiModelProperty(example = "AA", value = "") + public String getBusinessApplicationId() { + return businessApplicationId; + } + + public void setBusinessApplicationId(String businessApplicationId) { + this.businessApplicationId = businessApplicationId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataProcessingInformationAuthorizationOptions upv1capturecontextsDataProcessingInformationAuthorizationOptions = (Upv1capturecontextsDataProcessingInformationAuthorizationOptions) o; + return Objects.equals(this.aftIndicator, upv1capturecontextsDataProcessingInformationAuthorizationOptions.aftIndicator) && + Objects.equals(this.initiator, upv1capturecontextsDataProcessingInformationAuthorizationOptions.initiator) && + Objects.equals(this.businessApplicationId, upv1capturecontextsDataProcessingInformationAuthorizationOptions.businessApplicationId); + } + + @Override + public int hashCode() { + return Objects.hash(aftIndicator, initiator, businessApplicationId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataProcessingInformationAuthorizationOptions {\n"); + + if (aftIndicator != null) sb.append(" aftIndicator: ").append(toIndentedString(aftIndicator)).append("\n"); + if (initiator != null) sb.append(" initiator: ").append(toIndentedString(initiator)).append("\n"); + if (businessApplicationId != null) sb.append(" businessApplicationId: ").append(toIndentedString(businessApplicationId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.java b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.java new file mode 100644 index 000000000..e1cfd2b42 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.java @@ -0,0 +1,118 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator + */ + +public class Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator { + @SerializedName("credentialStoredOnFile") + private Boolean credentialStoredOnFile = null; + + @SerializedName("merchantInitiatedTransaction") + private Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction = null; + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator credentialStoredOnFile(Boolean credentialStoredOnFile) { + this.credentialStoredOnFile = credentialStoredOnFile; + return this; + } + + /** + * Get credentialStoredOnFile + * @return credentialStoredOnFile + **/ + @ApiModelProperty(example = "true", value = "") + public Boolean CredentialStoredOnFile() { + return credentialStoredOnFile; + } + + public void setCredentialStoredOnFile(Boolean credentialStoredOnFile) { + this.credentialStoredOnFile = credentialStoredOnFile; + } + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator merchantInitiatedTransaction(Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { + this.merchantInitiatedTransaction = merchantInitiatedTransaction; + return this; + } + + /** + * Get merchantInitiatedTransaction + * @return merchantInitiatedTransaction + **/ + @ApiModelProperty(value = "") + public Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction getMerchantInitiatedTransaction() { + return merchantInitiatedTransaction; + } + + public void setMerchantInitiatedTransaction(Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { + this.merchantInitiatedTransaction = merchantInitiatedTransaction; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator = (Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator) o; + return Objects.equals(this.credentialStoredOnFile, upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.credentialStoredOnFile) && + Objects.equals(this.merchantInitiatedTransaction, upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.merchantInitiatedTransaction); + } + + @Override + public int hashCode() { + return Objects.hash(credentialStoredOnFile, merchantInitiatedTransaction); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator {\n"); + + if (credentialStoredOnFile != null) sb.append(" credentialStoredOnFile: ").append(toIndentedString(credentialStoredOnFile)).append("\n"); + if (merchantInitiatedTransaction != null) sb.append(" merchantInitiatedTransaction: ").append(toIndentedString(merchantInitiatedTransaction)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java new file mode 100644 index 000000000..27a93d2e9 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction + */ + +public class Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { + @SerializedName("reason") + private String reason = null; + + public Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction reason(String reason) { + this.reason = reason; + return this; + } + + /** + * Get reason + * @return reason + **/ + @ApiModelProperty(example = "1", value = "") + public String getReason() { + return reason; + } + + public void setReason(String reason) { + this.reason = reason; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction = (Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction) o; + return Objects.equals(this.reason, upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.reason); + } + + @Override + public int hashCode() { + return Objects.hash(reason); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction {\n"); + + if (reason != null) sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsDataRecipientInformation.java b/src/main/java/Model/Upv1capturecontextsDataRecipientInformation.java new file mode 100644 index 000000000..715885397 --- /dev/null +++ b/src/main/java/Model/Upv1capturecontextsDataRecipientInformation.java @@ -0,0 +1,232 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Upv1capturecontextsDataRecipientInformation + */ + +public class Upv1capturecontextsDataRecipientInformation { + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("middleName") + private String middleName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("accountId") + private String accountId = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("accountType") + private String accountType = null; + + public Upv1capturecontextsDataRecipientInformation firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Get firstName + * @return firstName + **/ + @ApiModelProperty(example = "John", value = "") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Upv1capturecontextsDataRecipientInformation middleName(String middleName) { + this.middleName = middleName; + return this; + } + + /** + * Get middleName + * @return middleName + **/ + @ApiModelProperty(example = "John", value = "") + public String getMiddleName() { + return middleName; + } + + public void setMiddleName(String middleName) { + this.middleName = middleName; + } + + public Upv1capturecontextsDataRecipientInformation lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Get lastName + * @return lastName + **/ + @ApiModelProperty(example = "John", value = "") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Upv1capturecontextsDataRecipientInformation country(String country) { + this.country = country; + return this; + } + + /** + * The country code of the recipient's country + * @return country + **/ + @ApiModelProperty(example = "GB", value = "The country code of the recipient's country") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public Upv1capturecontextsDataRecipientInformation accountId(String accountId) { + this.accountId = accountId; + return this; + } + + /** + * The account ID of the recipient + * @return accountId + **/ + @ApiModelProperty(example = "2342312", value = "The account ID of the recipient") + public String getAccountId() { + return accountId; + } + + public void setAccountId(String accountId) { + this.accountId = accountId; + } + + public Upv1capturecontextsDataRecipientInformation administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * The administrative area of the recipient + * @return administrativeArea + **/ + @ApiModelProperty(example = "Devon", value = "The administrative area of the recipient") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public Upv1capturecontextsDataRecipientInformation accountType(String accountType) { + this.accountType = accountType; + return this; + } + + /** + * The account type of the recipient + * @return accountType + **/ + @ApiModelProperty(example = "Checking", value = "The account type of the recipient") + public String getAccountType() { + return accountType; + } + + public void setAccountType(String accountType) { + this.accountType = accountType; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Upv1capturecontextsDataRecipientInformation upv1capturecontextsDataRecipientInformation = (Upv1capturecontextsDataRecipientInformation) o; + return Objects.equals(this.firstName, upv1capturecontextsDataRecipientInformation.firstName) && + Objects.equals(this.middleName, upv1capturecontextsDataRecipientInformation.middleName) && + Objects.equals(this.lastName, upv1capturecontextsDataRecipientInformation.lastName) && + Objects.equals(this.country, upv1capturecontextsDataRecipientInformation.country) && + Objects.equals(this.accountId, upv1capturecontextsDataRecipientInformation.accountId) && + Objects.equals(this.administrativeArea, upv1capturecontextsDataRecipientInformation.administrativeArea) && + Objects.equals(this.accountType, upv1capturecontextsDataRecipientInformation.accountType); + } + + @Override + public int hashCode() { + return Objects.hash(firstName, middleName, lastName, country, accountId, administrativeArea, accountType); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Upv1capturecontextsDataRecipientInformation {\n"); + + if (firstName != null) sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + if (middleName != null) sb.append(" middleName: ").append(toIndentedString(middleName)).append("\n"); + if (lastName != null) sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + if (country != null) sb.append(" country: ").append(toIndentedString(country)).append("\n"); + if (accountId != null) sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); + if (administrativeArea != null) sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + if (accountType != null) sb.append(" accountType: ").append(toIndentedString(accountType)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Upv1capturecontextsOrderInformation.java b/src/main/java/Model/Upv1capturecontextsOrderInformation.java index 7b51df346..349a2eea0 100644 --- a/src/main/java/Model/Upv1capturecontextsOrderInformation.java +++ b/src/main/java/Model/Upv1capturecontextsOrderInformation.java @@ -15,9 +15,9 @@ import java.util.Objects; import java.util.Arrays; +import Model.Upv1capturecontextsDataOrderInformationBillTo; +import Model.Upv1capturecontextsDataOrderInformationShipTo; import Model.Upv1capturecontextsOrderInformationAmountDetails; -import Model.Upv1capturecontextsOrderInformationBillTo; -import Model.Upv1capturecontextsOrderInformationShipTo; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -36,10 +36,10 @@ public class Upv1capturecontextsOrderInformation { private Upv1capturecontextsOrderInformationAmountDetails amountDetails = null; @SerializedName("billTo") - private Upv1capturecontextsOrderInformationBillTo billTo = null; + private Upv1capturecontextsDataOrderInformationBillTo billTo = null; @SerializedName("shipTo") - private Upv1capturecontextsOrderInformationShipTo shipTo = null; + private Upv1capturecontextsDataOrderInformationShipTo shipTo = null; public Upv1capturecontextsOrderInformation amountDetails(Upv1capturecontextsOrderInformationAmountDetails amountDetails) { this.amountDetails = amountDetails; @@ -59,7 +59,7 @@ public void setAmountDetails(Upv1capturecontextsOrderInformationAmountDetails am this.amountDetails = amountDetails; } - public Upv1capturecontextsOrderInformation billTo(Upv1capturecontextsOrderInformationBillTo billTo) { + public Upv1capturecontextsOrderInformation billTo(Upv1capturecontextsDataOrderInformationBillTo billTo) { this.billTo = billTo; return this; } @@ -69,15 +69,15 @@ public Upv1capturecontextsOrderInformation billTo(Upv1capturecontextsOrderInform * @return billTo **/ @ApiModelProperty(value = "") - public Upv1capturecontextsOrderInformationBillTo getBillTo() { + public Upv1capturecontextsDataOrderInformationBillTo getBillTo() { return billTo; } - public void setBillTo(Upv1capturecontextsOrderInformationBillTo billTo) { + public void setBillTo(Upv1capturecontextsDataOrderInformationBillTo billTo) { this.billTo = billTo; } - public Upv1capturecontextsOrderInformation shipTo(Upv1capturecontextsOrderInformationShipTo shipTo) { + public Upv1capturecontextsOrderInformation shipTo(Upv1capturecontextsDataOrderInformationShipTo shipTo) { this.shipTo = shipTo; return this; } @@ -87,11 +87,11 @@ public Upv1capturecontextsOrderInformation shipTo(Upv1capturecontextsOrderInform * @return shipTo **/ @ApiModelProperty(value = "") - public Upv1capturecontextsOrderInformationShipTo getShipTo() { + public Upv1capturecontextsDataOrderInformationShipTo getShipTo() { return shipTo; } - public void setShipTo(Upv1capturecontextsOrderInformationShipTo shipTo) { + public void setShipTo(Upv1capturecontextsDataOrderInformationShipTo shipTo) { this.shipTo = shipTo; } diff --git a/src/main/java/Model/Vasv1currencyconversionClientReferenceInformation.java b/src/main/java/Model/Vasv1currencyconversionClientReferenceInformation.java new file mode 100644 index 000000000..254a77edd --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionClientReferenceInformation.java @@ -0,0 +1,187 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Vasv1currencyconversionClientReferenceInformationPartner; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionClientReferenceInformation + */ + +public class Vasv1currencyconversionClientReferenceInformation { + @SerializedName("code") + private String code = null; + + @SerializedName("applicationName") + private String applicationName = null; + + @SerializedName("applicationVersion") + private String applicationVersion = null; + + @SerializedName("applicationUser") + private String applicationUser = null; + + @SerializedName("partner") + private Vasv1currencyconversionClientReferenceInformationPartner partner = null; + + public Vasv1currencyconversionClientReferenceInformation code(String code) { + this.code = code; + return this; + } + + /** + * Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * @return code + **/ + @ApiModelProperty(value = "Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public Vasv1currencyconversionClientReferenceInformation applicationName(String applicationName) { + this.applicationName = applicationName; + return this; + } + + /** + * The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. + * @return applicationName + **/ + @ApiModelProperty(value = "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.") + public String getApplicationName() { + return applicationName; + } + + public void setApplicationName(String applicationName) { + this.applicationName = applicationName; + } + + public Vasv1currencyconversionClientReferenceInformation applicationVersion(String applicationVersion) { + this.applicationVersion = applicationVersion; + return this; + } + + /** + * Version of the CyberSource application or integration used for a transaction. + * @return applicationVersion + **/ + @ApiModelProperty(value = "Version of the CyberSource application or integration used for a transaction.") + public String getApplicationVersion() { + return applicationVersion; + } + + public void setApplicationVersion(String applicationVersion) { + this.applicationVersion = applicationVersion; + } + + public Vasv1currencyconversionClientReferenceInformation applicationUser(String applicationUser) { + this.applicationUser = applicationUser; + return this; + } + + /** + * The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. + * @return applicationUser + **/ + @ApiModelProperty(value = "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.") + public String getApplicationUser() { + return applicationUser; + } + + public void setApplicationUser(String applicationUser) { + this.applicationUser = applicationUser; + } + + public Vasv1currencyconversionClientReferenceInformation partner(Vasv1currencyconversionClientReferenceInformationPartner partner) { + this.partner = partner; + return this; + } + + /** + * Get partner + * @return partner + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionClientReferenceInformationPartner getPartner() { + return partner; + } + + public void setPartner(Vasv1currencyconversionClientReferenceInformationPartner partner) { + this.partner = partner; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionClientReferenceInformation vasv1currencyconversionClientReferenceInformation = (Vasv1currencyconversionClientReferenceInformation) o; + return Objects.equals(this.code, vasv1currencyconversionClientReferenceInformation.code) && + Objects.equals(this.applicationName, vasv1currencyconversionClientReferenceInformation.applicationName) && + Objects.equals(this.applicationVersion, vasv1currencyconversionClientReferenceInformation.applicationVersion) && + Objects.equals(this.applicationUser, vasv1currencyconversionClientReferenceInformation.applicationUser) && + Objects.equals(this.partner, vasv1currencyconversionClientReferenceInformation.partner); + } + + @Override + public int hashCode() { + return Objects.hash(code, applicationName, applicationVersion, applicationUser, partner); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionClientReferenceInformation {\n"); + + if (code != null) sb.append(" code: ").append(toIndentedString(code)).append("\n"); + if (applicationName != null) sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + if (applicationVersion != null) sb.append(" applicationVersion: ").append(toIndentedString(applicationVersion)).append("\n"); + if (applicationUser != null) sb.append(" applicationUser: ").append(toIndentedString(applicationUser)).append("\n"); + if (partner != null) sb.append(" partner: ").append(toIndentedString(partner)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionClientReferenceInformationPartner.java b/src/main/java/Model/Vasv1currencyconversionClientReferenceInformationPartner.java new file mode 100644 index 000000000..25c9586d0 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionClientReferenceInformationPartner.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionClientReferenceInformationPartner + */ + +public class Vasv1currencyconversionClientReferenceInformationPartner { + @SerializedName("developerId") + private String developerId = null; + + @SerializedName("solutionId") + private String solutionId = null; + + public Vasv1currencyconversionClientReferenceInformationPartner developerId(String developerId) { + this.developerId = developerId; + return this; + } + + /** + * Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. + * @return developerId + **/ + @ApiModelProperty(value = "Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. ") + public String getDeveloperId() { + return developerId; + } + + public void setDeveloperId(String developerId) { + this.developerId = developerId; + } + + public Vasv1currencyconversionClientReferenceInformationPartner solutionId(String solutionId) { + this.solutionId = solutionId; + return this; + } + + /** + * Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. + * @return solutionId + **/ + @ApiModelProperty(value = "Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. ") + public String getSolutionId() { + return solutionId; + } + + public void setSolutionId(String solutionId) { + this.solutionId = solutionId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionClientReferenceInformationPartner vasv1currencyconversionClientReferenceInformationPartner = (Vasv1currencyconversionClientReferenceInformationPartner) o; + return Objects.equals(this.developerId, vasv1currencyconversionClientReferenceInformationPartner.developerId) && + Objects.equals(this.solutionId, vasv1currencyconversionClientReferenceInformationPartner.solutionId); + } + + @Override + public int hashCode() { + return Objects.hash(developerId, solutionId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionClientReferenceInformationPartner {\n"); + + if (developerId != null) sb.append(" developerId: ").append(toIndentedString(developerId)).append("\n"); + if (solutionId != null) sb.append(" solutionId: ").append(toIndentedString(solutionId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionOrderInformation.java b/src/main/java/Model/Vasv1currencyconversionOrderInformation.java new file mode 100644 index 000000000..8990463ff --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionOrderInformation.java @@ -0,0 +1,119 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Vasv1currencyconversionOrderInformationAmountDetails; +import Model.Vasv1currencyconversionOrderInformationCurrencyConversion; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionOrderInformation + */ + +public class Vasv1currencyconversionOrderInformation { + @SerializedName("amountDetails") + private Vasv1currencyconversionOrderInformationAmountDetails amountDetails = null; + + @SerializedName("currencyConversion") + private Vasv1currencyconversionOrderInformationCurrencyConversion currencyConversion = null; + + public Vasv1currencyconversionOrderInformation amountDetails(Vasv1currencyconversionOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + return this; + } + + /** + * Get amountDetails + * @return amountDetails + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionOrderInformationAmountDetails getAmountDetails() { + return amountDetails; + } + + public void setAmountDetails(Vasv1currencyconversionOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + } + + public Vasv1currencyconversionOrderInformation currencyConversion(Vasv1currencyconversionOrderInformationCurrencyConversion currencyConversion) { + this.currencyConversion = currencyConversion; + return this; + } + + /** + * Get currencyConversion + * @return currencyConversion + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionOrderInformationCurrencyConversion getCurrencyConversion() { + return currencyConversion; + } + + public void setCurrencyConversion(Vasv1currencyconversionOrderInformationCurrencyConversion currencyConversion) { + this.currencyConversion = currencyConversion; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionOrderInformation vasv1currencyconversionOrderInformation = (Vasv1currencyconversionOrderInformation) o; + return Objects.equals(this.amountDetails, vasv1currencyconversionOrderInformation.amountDetails) && + Objects.equals(this.currencyConversion, vasv1currencyconversionOrderInformation.currencyConversion); + } + + @Override + public int hashCode() { + return Objects.hash(amountDetails, currencyConversion); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionOrderInformation {\n"); + + if (amountDetails != null) sb.append(" amountDetails: ").append(toIndentedString(amountDetails)).append("\n"); + if (currencyConversion != null) sb.append(" currencyConversion: ").append(toIndentedString(currencyConversion)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionOrderInformationAmountDetails.java b/src/main/java/Model/Vasv1currencyconversionOrderInformationAmountDetails.java new file mode 100644 index 000000000..cd1e1ad90 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionOrderInformationAmountDetails.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionOrderInformationAmountDetails + */ + +public class Vasv1currencyconversionOrderInformationAmountDetails { + @SerializedName("originalAmount") + private String originalAmount = null; + + @SerializedName("originalCurrency") + private String originalCurrency = null; + + public Vasv1currencyconversionOrderInformationAmountDetails originalAmount(String originalAmount) { + this.originalAmount = originalAmount; + return this; + } + + /** + * The amount of the sale in the merchant's currency. Mandatory when type=DCC, optional otherwise. This value cannot be negative. You can include a decimal point (.), but no other special characters. + * @return originalAmount + **/ + @ApiModelProperty(value = "The amount of the sale in the merchant's currency. Mandatory when type=DCC, optional otherwise. This value cannot be negative. You can include a decimal point (.), but no other special characters.") + public String getOriginalAmount() { + return originalAmount; + } + + public void setOriginalAmount(String originalAmount) { + this.originalAmount = originalAmount; + } + + public Vasv1currencyconversionOrderInformationAmountDetails originalCurrency(String originalCurrency) { + this.originalCurrency = originalCurrency; + return this; + } + + /** + * Original currency of the transaction in the merchant's currency. Mandatory when type=DCC, optional otherwise. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) + * @return originalCurrency + **/ + @ApiModelProperty(value = "Original currency of the transaction in the merchant's currency. Mandatory when type=DCC, optional otherwise. Use three-character alphabetic [ISO 4271 Currency Codes.](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html) ") + public String getOriginalCurrency() { + return originalCurrency; + } + + public void setOriginalCurrency(String originalCurrency) { + this.originalCurrency = originalCurrency; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionOrderInformationAmountDetails vasv1currencyconversionOrderInformationAmountDetails = (Vasv1currencyconversionOrderInformationAmountDetails) o; + return Objects.equals(this.originalAmount, vasv1currencyconversionOrderInformationAmountDetails.originalAmount) && + Objects.equals(this.originalCurrency, vasv1currencyconversionOrderInformationAmountDetails.originalCurrency); + } + + @Override + public int hashCode() { + return Objects.hash(originalAmount, originalCurrency); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionOrderInformationAmountDetails {\n"); + + if (originalAmount != null) sb.append(" originalAmount: ").append(toIndentedString(originalAmount)).append("\n"); + if (originalCurrency != null) sb.append(" originalCurrency: ").append(toIndentedString(originalCurrency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionOrderInformationCurrencyConversion.java b/src/main/java/Model/Vasv1currencyconversionOrderInformationCurrencyConversion.java new file mode 100644 index 000000000..d58e2e901 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionOrderInformationCurrencyConversion.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionOrderInformationCurrencyConversion + */ + +public class Vasv1currencyconversionOrderInformationCurrencyConversion { + @SerializedName("type") + private String type = "DCC"; + + public Vasv1currencyconversionOrderInformationCurrencyConversion type(String type) { + this.type = type; + return this; + } + + /** + * Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing + * @return type + **/ + @ApiModelProperty(value = "Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionOrderInformationCurrencyConversion vasv1currencyconversionOrderInformationCurrencyConversion = (Vasv1currencyconversionOrderInformationCurrencyConversion) o; + return Objects.equals(this.type, vasv1currencyconversionOrderInformationCurrencyConversion.type); + } + + @Override + public int hashCode() { + return Objects.hash(type); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionOrderInformationCurrencyConversion {\n"); + + if (type != null) sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionPaymentInformation.java b/src/main/java/Model/Vasv1currencyconversionPaymentInformation.java new file mode 100644 index 000000000..ebcec32f5 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionPaymentInformation.java @@ -0,0 +1,95 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import Model.Vasv1currencyconversionPaymentInformationCard; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionPaymentInformation + */ + +public class Vasv1currencyconversionPaymentInformation { + @SerializedName("card") + private Vasv1currencyconversionPaymentInformationCard card = null; + + public Vasv1currencyconversionPaymentInformation card(Vasv1currencyconversionPaymentInformationCard card) { + this.card = card; + return this; + } + + /** + * Get card + * @return card + **/ + @ApiModelProperty(value = "") + public Vasv1currencyconversionPaymentInformationCard getCard() { + return card; + } + + public void setCard(Vasv1currencyconversionPaymentInformationCard card) { + this.card = card; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionPaymentInformation vasv1currencyconversionPaymentInformation = (Vasv1currencyconversionPaymentInformation) o; + return Objects.equals(this.card, vasv1currencyconversionPaymentInformation.card); + } + + @Override + public int hashCode() { + return Objects.hash(card); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionPaymentInformation {\n"); + + if (card != null) sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionPaymentInformationCard.java b/src/main/java/Model/Vasv1currencyconversionPaymentInformationCard.java new file mode 100644 index 000000000..a6798b983 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionPaymentInformationCard.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionPaymentInformationCard + */ + +public class Vasv1currencyconversionPaymentInformationCard { + @SerializedName("number") + private String number = null; + + public Vasv1currencyconversionPaymentInformationCard number(String number) { + this.number = number; + return this; + } + + /** + * First 11 digits of the card number for which an offer is being sought. Mandatory when type=DCC. + * @return number + **/ + @ApiModelProperty(value = "First 11 digits of the card number for which an offer is being sought. Mandatory when type=DCC.") + public String getNumber() { + return number; + } + + public void setNumber(String number) { + this.number = number; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionPaymentInformationCard vasv1currencyconversionPaymentInformationCard = (Vasv1currencyconversionPaymentInformationCard) o; + return Objects.equals(this.number, vasv1currencyconversionPaymentInformationCard.number); + } + + @Override + public int hashCode() { + return Objects.hash(number); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionPaymentInformationCard {\n"); + + if (number != null) sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Vasv1currencyconversionPointOfSaleInformation.java b/src/main/java/Model/Vasv1currencyconversionPointOfSaleInformation.java new file mode 100644 index 000000000..5ac0e6c77 --- /dev/null +++ b/src/main/java/Model/Vasv1currencyconversionPointOfSaleInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Vasv1currencyconversionPointOfSaleInformation + */ + +public class Vasv1currencyconversionPointOfSaleInformation { + @SerializedName("terminalId") + private String terminalId = null; + + @SerializedName("entryMode") + private String entryMode = null; + + public Vasv1currencyconversionPointOfSaleInformation terminalId(String terminalId) { + this.terminalId = terminalId; + return this; + } + + /** + * Identifier for the terminal used by the merchant's to process the transaction. + * @return terminalId + **/ + @ApiModelProperty(value = "Identifier for the terminal used by the merchant's to process the transaction.") + public String getTerminalId() { + return terminalId; + } + + public void setTerminalId(String terminalId) { + this.terminalId = terminalId; + } + + public Vasv1currencyconversionPointOfSaleInformation entryMode(String entryMode) { + this.entryMode = entryMode; + return this; + } + + /** + * Valid Values: - 'KEYED' - 'SWIPED' - 'CONTACT' - 'CONTACTLESS' How the transaction information was captured. Optional. `KEYED` can refer to MOTO on a terminal, MOTO on a virtual terminal, or eCommerce. All other options refer to card holder present transactions. Optional. + * @return entryMode + **/ + @ApiModelProperty(value = "Valid Values: - 'KEYED' - 'SWIPED' - 'CONTACT' - 'CONTACTLESS' How the transaction information was captured. Optional. `KEYED` can refer to MOTO on a terminal, MOTO on a virtual terminal, or eCommerce. All other options refer to card holder present transactions. Optional. ") + public String getEntryMode() { + return entryMode; + } + + public void setEntryMode(String entryMode) { + this.entryMode = entryMode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Vasv1currencyconversionPointOfSaleInformation vasv1currencyconversionPointOfSaleInformation = (Vasv1currencyconversionPointOfSaleInformation) o; + return Objects.equals(this.terminalId, vasv1currencyconversionPointOfSaleInformation.terminalId) && + Objects.equals(this.entryMode, vasv1currencyconversionPointOfSaleInformation.entryMode); + } + + @Override + public int hashCode() { + return Objects.hash(terminalId, entryMode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Vasv1currencyconversionPointOfSaleInformation {\n"); + + if (terminalId != null) sb.append(" terminalId: ").append(toIndentedString(terminalId)).append("\n"); + if (entryMode != null) sb.append(" entryMode: ").append(toIndentedString(entryMode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + // return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/test/java/Api/MerchantDefinedFieldsApiTest.java b/src/test/java/Api/MerchantDefinedFieldsApiTest.java index 1cf70b3f9..87293923b 100644 --- a/src/test/java/Api/MerchantDefinedFieldsApiTest.java +++ b/src/test/java/Api/MerchantDefinedFieldsApiTest.java @@ -53,7 +53,7 @@ public void createMerchantDefinedFieldDefinitionTest() throws Exception { } /** - * Get all merchant defined fields for a given reference type + * Delete a MerchantDefinedField by ID * * * @@ -61,15 +61,16 @@ public void createMerchantDefinedFieldDefinitionTest() throws Exception { * if the Api call fails */ @Test - public void getMerchantDefinedFieldsDefinitionsTest() throws Exception { + public void deleteMerchantDefinedFieldsDefinitionsTest() throws Exception { String referenceType = null; - List response = api.getMerchantDefinedFieldsDefinitions(referenceType); + Long id = null; + api.deleteMerchantDefinedFieldsDefinitions(referenceType, id); // TODO: test validations } /** - * Delete a MerchantDefinedField by ID + * Get all merchant defined fields for a given reference type * * * @@ -77,10 +78,9 @@ public void getMerchantDefinedFieldsDefinitionsTest() throws Exception { * if the Api call fails */ @Test - public void invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteTest() throws Exception { + public void getMerchantDefinedFieldsDefinitionsTest() throws Exception { String referenceType = null; - Long id = null; - api.invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete(referenceType, id); + List response = api.getMerchantDefinedFieldsDefinitions(referenceType); // TODO: test validations } @@ -94,11 +94,11 @@ public void invoicingV2ReferenceTypeMerchantDefinedFieldsIdDeleteTest() throws E * if the Api call fails */ @Test - public void invoicingV2ReferenceTypeMerchantDefinedFieldsIdPutTest() throws Exception { + public void putMerchantDefinedFieldsDefinitionsTest() throws Exception { String referenceType = null; Long id = null; MerchantDefinedFieldCore merchantDefinedFieldCore = null; - List response = api.invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut(referenceType, id, merchantDefinedFieldCore); + List response = api.putMerchantDefinedFieldsDefinitions(referenceType, id, merchantDefinedFieldCore); // TODO: test validations } diff --git a/src/test/java/Api/OffersApiTest.java b/src/test/java/Api/OffersApiTest.java new file mode 100644 index 000000000..3937d9305 --- /dev/null +++ b/src/test/java/Api/OffersApiTest.java @@ -0,0 +1,81 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Model.InlineResponse20014; +import Model.InlineResponse2018; +import Model.InlineResponse40010; +import Model.InlineResponse5022; +import Model.OfferRequest; +import org.junit.Test; +import org.junit.Ignore; + + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for OffersApi + */ +@Ignore +public class OffersApiTest { + + private final OffersApi api = new OffersApi(); + + + /** + * Create an Offer + * + * Creates an offer record on the provider system. + * + * @throws Exception + * if the Api call fails + */ + @Test + public void createOfferTest() throws Exception { + String contentType = null; + String xRequestid = null; + String vCMerchantId = null; + String vCCorrelationId = null; + String vCOrganizationId = null; + OfferRequest offerRequest = null; + InlineResponse2018 response = api.createOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, offerRequest); + + // TODO: test validations + } + + /** + * Retrieve an Offer + * + * Retrieves an offer record from the system. + * + * @throws Exception + * if the Api call fails + */ + @Test + public void getOfferTest() throws Exception { + String contentType = null; + String xRequestid = null; + String vCMerchantId = null; + String vCCorrelationId = null; + String vCOrganizationId = null; + String id = null; + InlineResponse20014 response = api.getOffer(contentType, xRequestid, vCMerchantId, vCCorrelationId, vCOrganizationId, id); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/TokenApiTest.java b/src/test/java/Api/TokenApiTest.java index 94de7a984..67f1e923f 100644 --- a/src/test/java/Api/TokenApiTest.java +++ b/src/test/java/Api/TokenApiTest.java @@ -59,7 +59,7 @@ public void getCardArtAssetTest() throws Exception { /** * Generate Payment Credentials for a TMS Token * - * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. + * | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. * * @throws Exception * if the Api call fails diff --git a/src/test/java/Api/TokenizedCardApiTest.java b/src/test/java/Api/TokenizedCardApiTest.java index 0258c6b25..9f487dbd3 100644 --- a/src/test/java/Api/TokenizedCardApiTest.java +++ b/src/test/java/Api/TokenizedCardApiTest.java @@ -19,7 +19,6 @@ import Model.InlineResponse410; import Model.InlineResponse424; import Model.InlineResponse500; -import Model.PostIssuerLifeCycleSimulationRequest; import Model.TokenizedcardRequest; import org.junit.Test; import org.junit.Ignore; @@ -59,7 +58,7 @@ public void deleteTokenizedCardTest() throws Exception { /** * Retrieve a Tokenized Card * - * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + * | | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. * * @throws Exception * if the Api call fails @@ -73,24 +72,6 @@ public void getTokenizedCardTest() throws Exception { // TODO: test validations } - /** - * Simulate Issuer Life Cycle Management Events - * - * **Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment. - * - * @throws Exception - * if the Api call fails - */ - @Test - public void postIssuerLifeCycleSimulationTest() throws Exception { - String profileId = null; - String tokenizedCardId = null; - PostIssuerLifeCycleSimulationRequest postIssuerLifeCycleSimulationRequest = null; - api.postIssuerLifeCycleSimulation(profileId, tokenizedCardId, postIssuerLifeCycleSimulationRequest); - - // TODO: test validations - } - /** * Create a Tokenized Card *