From fa499e259ceb5dd9203b087752df27fd3c0b1c31 Mon Sep 17 00:00:00 2001 From: monkumar Date: Thu, 20 Jun 2024 12:17:39 +0530 Subject: [PATCH 1/2] api spec changes --- ...nsResponseOrderInformationAmountDetails.md | 2 +- ...et200ResponseInvoiceSettingsInformation.md | 2 +- ...cesAllGet200ResponseCustomerInformation.md | 2 +- ...00ResponseOrderInformationAmountDetails.md | 4 +- ...nvoicesGet200ResponseTransactionDetails.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...voiceSettingsInvoiceSettingsInformation.md | 2 +- .../Invoicingv2invoicesCustomerInformation.md | 4 +- ...ingv2invoicesCustomerInformationCompany.md | 2 +- ...v2invoicesOrderInformationAmountDetails.md | 4 +- ...cesOrderInformationAmountDetailsFreight.md | 2 +- .../Kmsv2keyssymClientReferenceInformation.md | 2 +- docs/PatchInstrumentIdentifierRequest.md | 4 +- ...stInstrumentIdentifierEnrollmentRequest.md | 4 +- docs/PostInstrumentIdentifierRequest.md | 4 +- ...editsPost201ResponseCreditAmountDetails.md | 2 +- ...rocessingInformationBankTransferOptions.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...eBuyerInformationPersonalIdentification.md | 4 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...sPost201Response1OrderInformationBillTo.md | 2 +- ...1Response2OrderInformationAmountDetails.md | 2 +- ...PaymentsPost201ResponseBuyerInformation.md | 6 +- ...sponseConsumerAuthenticationInformation.md | 6 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...ymentsPost201ResponsePaymentInformation.md | 10 +- ...tsPost201ResponsePaymentInformationBank.md | 2 +- ...01ResponsePaymentInformationBankAccount.md | 2 +- ...rocessingInformationBankTransferOptions.md | 4 +- ...onseProcessorInformationAchVerification.md | 4 +- ...nseProcessorInformationCardVerification.md | 2 +- ...nformationElectronicVerificationResults.md | 10 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...efundPost201ResponseRefundAmountDetails.md | 2 +- ...alsPost201ResponseReversalAmountDetails.md | 2 +- ...tsVoidsPost201ResponseVoidAmountDetails.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...1pushfundstransferAggregatorInformation.md | 10 - ...ransferAggregatorInformationSubMerchant.md | 16 - ...fundstransferMerchantDefinedInformation.md | 9 - ...sv1pushfundstransferMerchantInformation.md | 11 - ...erMerchantInformationMerchantDescriptor.md | 14 - .../Ptsv1pushfundstransferOrderInformation.md | 2 - ...dstransferOrderInformationAmountDetails.md | 6 +- ...hfundstransferOrderInformationSurcharge.md | 8 - ...hfundstransferPointOfServiceInformation.md | 12 - ...1pushfundstransferProcessingInformation.md | 8 +- ...sferProcessingInformationPayoutsOptions.md | 4 +- ...erProcessingInformationRecurringOptions.md | 8 - ...Ptsv1pushfundstransferProcessingOptions.md | 8 - ...transferProcessingOptionsFundingOptions.md | 8 - ...rocessingOptionsFundingOptionsInitiator.md | 8 - ...v1pushfundstransferRecipientInformation.md | 18 +- ...ipientInformationPaymentInformationCard.md | 2 +- ...ipientInformationPersonalIdentification.md | 5 +- ...Ptsv1pushfundstransferSenderInformation.md | 17 +- ...shfundstransferSenderInformationAccount.md | 2 +- ...SenderInformationPaymentInformationCard.md | 10 +- ...SenderInformationPersonalIdentification.md | 5 +- ...2billingagreementsAggregatorInformation.md | 2 +- .../Ptsv2billingagreementsBuyerInformation.md | 2 +- ...ingagreementsClientReferenceInformation.md | 2 +- ...billingagreementsOrderInformationBillTo.md | 2 +- ...tsv2billingagreementsidBuyerInformation.md | 2 +- docs/Ptsv2creditsProcessingInformation.md | 6 +- ...rocessingInformationBankTransferOptions.md | 6 +- .../Ptsv2paymentreferencesBuyerInformation.md | 2 +- ...referencesOrderInformationAmountDetails.md | 6 +- ...paymentreferencesPaymentInformationBank.md | 2 +- ...referencesPaymentInformationBankAccount.md | 2 +- docs/Ptsv2paymentsAggregatorInformation.md | 4 +- docs/Ptsv2paymentsBuyerInformation.md | 8 +- ...sBuyerInformationPersonalIdentification.md | 6 +- ...Ptsv2paymentsClientReferenceInformation.md | 2 +- ...ymentsConsumerAuthenticationInformation.md | 14 +- ...Ptsv2paymentsMerchantDefinedInformation.md | 4 +- ...v2paymentsOrderInformationAmountDetails.md | 10 +- ...ationAmountDetailsAmexAdditionalAmounts.md | 2 +- docs/Ptsv2paymentsOrderInformationBillTo.md | 2 +- ...v2paymentsOrderInformationBillToCompany.md | 2 +- docs/Ptsv2paymentsPaymentInformationBank.md | 6 +- ...v2paymentsPaymentInformationBankAccount.md | 4 +- ...Ptsv2paymentsPaymentInformationCustomer.md | 2 +- docs/Ptsv2paymentsProcessingInformation.md | 10 +- ...ocessingInformationAuthorizationOptions.md | 4 +- ...nformationAuthorizationOptionsInitiator.md | 2 +- ...nsInitiatorMerchantInitiatedTransaction.md | 4 +- ...rocessingInformationBankTransferOptions.md | 10 +- docs/Ptsv2paymentsTokenInformation.md | 1 + ...nformationTokenProvisioningInformation.md} | 2 +- ...paymentsidOrderInformationAmountDetails.md | 2 +- ...paymentsidcapturesAggregatorInformation.md | 4 +- ...Ptsv2paymentsidcapturesBuyerInformation.md | 6 +- ...sBuyerInformationPersonalIdentification.md | 2 +- ...idcapturesOrderInformationAmountDetails.md | 10 +- ...aymentsidcapturesOrderInformationBillTo.md | 2 +- ...paymentsidcapturesProcessingInformation.md | 4 +- ...ocessingInformationAuthorizationOptions.md | 4 +- ...entsidrefundsClientReferenceInformation.md | 2 +- ...paymentsidrefundsPaymentInformationBank.md | 6 +- ...sidrefundsPaymentInformationBankAccount.md | 2 +- ...2paymentsidrefundsProcessingInformation.md | 4 +- ...tsidreversalsClientReferenceInformation.md | 2 +- ...aymentsidreversalsProcessingInformation.md | 4 +- ...versalsReversalInformationAmountDetails.md | 4 +- ...sv2payoutsOrderInformationAmountDetails.md | 4 +- docs/Ptsv2payoutsRecipientInformation.md | 2 - ...ymentstatusidPaymentInformationCustomer.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...ushFunds201ResponseProcessorInformation.md | 6 +- docs/PushFunds400Response.md | 2 +- docs/PushFundsRequest.md | 7 +- ...Rbsv1plansOrderInformationAmountDetails.md | 2 +- ...1ResponseAddressVerificationInformation.md | 2 +- ...sponseConsumerAuthenticationInformation.md | 6 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...isionsPost201ResponsePaymentInformation.md | 10 +- ...ionresultsOrderInformationAmountDetails.md | 4 +- docs/Riskv1authenticationsBuyerInformation.md | 2 +- ...nticationsOrderInformationAmountDetails.md | 4 +- ...v1authenticationsOrderInformationBillTo.md | 2 +- docs/Riskv1decisionsBuyerInformation.md | 6 +- ...isionsConsumerAuthenticationInformation.md | 2 +- ...1decisionsOrderInformationAmountDetails.md | 2 +- docs/Riskv1decisionsOrderInformationBillTo.md | 2 +- ...onsProcessorInformationCardVerification.md | 2 +- ...mplianceinquiriesOrderInformationBillTo.md | 2 +- ...1liststypeentriesOrderInformationBillTo.md | 2 +- docs/TmsEmbeddedInstrumentIdentifier.md | 4 +- ...beddedInstrumentIdentifierTokenizedCard.md | 1 + docs/TransactionBatchesApi.md | 4 +- ...nsactionsGet200ResponseBuyerInformation.md | 4 +- ...sponseConsumerAuthenticationInformation.md | 4 +- ...00ResponseOrderInformationAmountDetails.md | 6 +- ...onsGet200ResponseOrderInformationBillTo.md | 4 +- ...onsGet200ResponsePaymentInformationBank.md | 10 +- ...00ResponsePaymentInformationBankAccount.md | 4 +- ...et200ResponsePaymentInformationCustomer.md | 2 +- ...ionsGet200ResponseProcessingInformation.md | 6 +- ...ocessingInformationAuthorizationOptions.md | 2 +- ...nformationElectronicVerificationResults.md | 8 +- ...Post201ResponseEmbeddedBuyerInformation.md | 2 +- ...beddedConsumerAuthenticationInformation.md | 4 +- ...1ResponseEmbeddedOrderInformationBillTo.md | 2 +- ...01ResponseEmbeddedProcessingInformation.md | 6 +- ...asV2TaxVoid200ResponseVoidAmountDetails.md | 2 +- docs/Vasv2taxBuyerInformation.md | 2 +- docs/Vasv2taxClientReferenceInformation.md | 2 +- docs/Vasv2taxidClientReferenceInformation.md | 2 +- generator/cybersource-rest-spec.json | 1734 +++++++---------- src/api/TransactionBatchesApi.js | 4 +- src/index.js | 71 +- ...nsResponseOrderInformationAmountDetails.js | 2 +- ...et200ResponseInvoiceSettingsInformation.js | 2 +- ...cesAllGet200ResponseCustomerInformation.js | 2 +- ...00ResponseOrderInformationAmountDetails.js | 4 +- ...nvoicesGet200ResponseTransactionDetails.js | 2 +- ...01ResponseOrderInformationAmountDetails.js | 4 +- ...voiceSettingsInvoiceSettingsInformation.js | 2 +- .../Invoicingv2invoicesCustomerInformation.js | 4 +- ...ingv2invoicesCustomerInformationCompany.js | 2 +- ...v2invoicesOrderInformationAmountDetails.js | 4 +- ...cesOrderInformationAmountDetailsFreight.js | 2 +- .../Kmsv2keyssymClientReferenceInformation.js | 2 +- src/model/PatchInstrumentIdentifierRequest.js | 14 +- ...stInstrumentIdentifierEnrollmentRequest.js | 14 +- src/model/PostInstrumentIdentifierRequest.js | 14 +- ...editsPost201ResponseCreditAmountDetails.js | 2 +- ...rocessingInformationBankTransferOptions.js | 2 +- ...01ResponseOrderInformationAmountDetails.js | 2 +- ...eBuyerInformationPersonalIdentification.js | 4 +- ...01ResponseOrderInformationAmountDetails.js | 2 +- ...sPost201Response1OrderInformationBillTo.js | 2 +- ...1Response2OrderInformationAmountDetails.js | 2 +- ...PaymentsPost201ResponseBuyerInformation.js | 6 +- ...sponseConsumerAuthenticationInformation.js | 6 +- ...01ResponseOrderInformationAmountDetails.js | 4 +- ...ymentsPost201ResponsePaymentInformation.js | 10 +- ...tsPost201ResponsePaymentInformationBank.js | 2 +- ...01ResponsePaymentInformationBankAccount.js | 2 +- ...rocessingInformationBankTransferOptions.js | 4 +- ...onseProcessorInformationAchVerification.js | 4 +- ...nseProcessorInformationCardVerification.js | 2 +- ...nformationElectronicVerificationResults.js | 10 +- ...01ResponseOrderInformationAmountDetails.js | 4 +- ...efundPost201ResponseRefundAmountDetails.js | 2 +- ...alsPost201ResponseReversalAmountDetails.js | 2 +- ...tsVoidsPost201ResponseVoidAmountDetails.js | 2 +- ...01ResponseOrderInformationAmountDetails.js | 4 +- ...1pushfundstransferAggregatorInformation.js | 99 - ...ransferAggregatorInformationSubMerchant.js | 154 -- ...fundstransferMerchantDefinedInformation.js | 91 - ...sv1pushfundstransferMerchantInformation.js | 108 - ...erMerchantInformationMerchantDescriptor.js | 136 -- .../Ptsv1pushfundstransferOrderInformation.js | 25 +- ...dstransferOrderInformationAmountDetails.js | 26 +- ...hfundstransferOrderInformationSurcharge.js | 82 - ...hfundstransferPointOfServiceInformation.js | 118 -- ...1pushfundstransferProcessingInformation.js | 66 +- ...sferProcessingInformationPayoutsOptions.js | 20 +- ...erProcessingInformationRecurringOptions.js | 82 - ...Ptsv1pushfundstransferProcessingOptions.js | 81 - ...transferProcessingOptionsFundingOptions.js | 81 - ...rocessingOptionsFundingOptionsInitiator.js | 82 - ...v1pushfundstransferRecipientInformation.js | 34 +- ...ipientInformationPaymentInformationCard.js | 2 +- ...ipientInformationPersonalIdentification.js | 13 +- ...Ptsv1pushfundstransferSenderInformation.js | 25 +- ...shfundstransferSenderInformationAccount.js | 2 +- ...SenderInformationPaymentInformationCard.js | 10 +- ...SenderInformationPersonalIdentification.js | 13 +- ...2billingagreementsAggregatorInformation.js | 2 +- .../Ptsv2billingagreementsBuyerInformation.js | 2 +- ...ingagreementsClientReferenceInformation.js | 2 +- ...billingagreementsOrderInformationBillTo.js | 2 +- ...tsv2billingagreementsidBuyerInformation.js | 2 +- .../Ptsv2creditsProcessingInformation.js | 6 +- ...rocessingInformationBankTransferOptions.js | 6 +- .../Ptsv2paymentreferencesBuyerInformation.js | 2 +- ...referencesOrderInformationAmountDetails.js | 6 +- ...paymentreferencesPaymentInformationBank.js | 2 +- ...referencesPaymentInformationBankAccount.js | 2 +- .../Ptsv2paymentsAggregatorInformation.js | 4 +- src/model/Ptsv2paymentsBuyerInformation.js | 8 +- ...sBuyerInformationPersonalIdentification.js | 6 +- ...Ptsv2paymentsClientReferenceInformation.js | 2 +- ...ymentsConsumerAuthenticationInformation.js | 14 +- ...Ptsv2paymentsMerchantDefinedInformation.js | 4 +- ...v2paymentsOrderInformationAmountDetails.js | 10 +- ...ationAmountDetailsAmexAdditionalAmounts.js | 2 +- .../Ptsv2paymentsOrderInformationBillTo.js | 2 +- ...v2paymentsOrderInformationBillToCompany.js | 2 +- .../Ptsv2paymentsPaymentInformationBank.js | 6 +- ...v2paymentsPaymentInformationBankAccount.js | 4 +- ...Ptsv2paymentsPaymentInformationCustomer.js | 2 +- .../Ptsv2paymentsProcessingInformation.js | 10 +- ...ocessingInformationAuthorizationOptions.js | 4 +- ...nformationAuthorizationOptionsInitiator.js | 2 +- ...nsInitiatorMerchantInitiatedTransaction.js | 4 +- ...rocessingInformationBankTransferOptions.js | 10 +- src/model/Ptsv2paymentsTokenInformation.js | 16 +- ...nformationTokenProvisioningInformation.js} | 16 +- ...paymentsidOrderInformationAmountDetails.js | 2 +- ...paymentsidcapturesAggregatorInformation.js | 4 +- ...Ptsv2paymentsidcapturesBuyerInformation.js | 6 +- ...sBuyerInformationPersonalIdentification.js | 2 +- ...idcapturesOrderInformationAmountDetails.js | 10 +- ...aymentsidcapturesOrderInformationBillTo.js | 2 +- ...paymentsidcapturesProcessingInformation.js | 4 +- ...ocessingInformationAuthorizationOptions.js | 4 +- ...entsidrefundsClientReferenceInformation.js | 2 +- ...paymentsidrefundsPaymentInformationBank.js | 6 +- ...sidrefundsPaymentInformationBankAccount.js | 2 +- ...2paymentsidrefundsProcessingInformation.js | 4 +- ...tsidreversalsClientReferenceInformation.js | 2 +- ...aymentsidreversalsProcessingInformation.js | 4 +- ...versalsReversalInformationAmountDetails.js | 4 +- ...sv2payoutsOrderInformationAmountDetails.js | 4 +- src/model/Ptsv2payoutsRecipientInformation.js | 18 - ...ymentstatusidPaymentInformationCustomer.js | 2 +- ...01ResponseOrderInformationAmountDetails.js | 2 +- ...ushFunds201ResponseProcessorInformation.js | 22 +- src/model/PushFunds400Response.js | 2 +- src/model/PushFundsRequest.js | 51 +- ...Rbsv1plansOrderInformationAmountDetails.js | 4 +- ...1ResponseAddressVerificationInformation.js | 2 +- ...sponseConsumerAuthenticationInformation.js | 6 +- ...01ResponseOrderInformationAmountDetails.js | 2 +- ...isionsPost201ResponsePaymentInformation.js | 10 +- ...ionresultsOrderInformationAmountDetails.js | 4 +- .../Riskv1authenticationsBuyerInformation.js | 2 +- ...nticationsOrderInformationAmountDetails.js | 8 +- ...v1authenticationsOrderInformationBillTo.js | 4 +- src/model/Riskv1decisionsBuyerInformation.js | 6 +- ...isionsConsumerAuthenticationInformation.js | 2 +- ...1decisionsOrderInformationAmountDetails.js | 4 +- .../Riskv1decisionsOrderInformationBillTo.js | 2 +- ...onsProcessorInformationCardVerification.js | 2 +- ...mplianceinquiriesOrderInformationBillTo.js | 4 +- ...1liststypeentriesOrderInformationBillTo.js | 2 +- src/model/TmsEmbeddedInstrumentIdentifier.js | 14 +- ...beddedInstrumentIdentifierTokenizedCard.js | 9 + ...nsactionsGet200ResponseBuyerInformation.js | 4 +- ...sponseConsumerAuthenticationInformation.js | 4 +- ...00ResponseOrderInformationAmountDetails.js | 6 +- ...onsGet200ResponseOrderInformationBillTo.js | 4 +- ...onsGet200ResponsePaymentInformationBank.js | 10 +- ...00ResponsePaymentInformationBankAccount.js | 4 +- ...et200ResponsePaymentInformationCustomer.js | 2 +- ...ionsGet200ResponseProcessingInformation.js | 6 +- ...ocessingInformationAuthorizationOptions.js | 2 +- ...nformationElectronicVerificationResults.js | 8 +- ...Post201ResponseEmbeddedBuyerInformation.js | 2 +- ...beddedConsumerAuthenticationInformation.js | 4 +- ...1ResponseEmbeddedOrderInformationBillTo.js | 2 +- ...01ResponseEmbeddedProcessingInformation.js | 6 +- ...asV2TaxVoid200ResponseVoidAmountDetails.js | 2 +- src/model/Vasv2taxBuyerInformation.js | 2 +- .../Vasv2taxClientReferenceInformation.js | 2 +- .../Vasv2taxidClientReferenceInformation.js | 2 +- ...fundstransferAggregatorInformation.spec.js | 79 - ...erAggregatorInformationSubMerchant.spec.js | 115 -- ...transferMerchantDefinedInformation.spec.js | 73 - ...shfundstransferMerchantInformation.spec.js | 85 - ...chantInformationMerchantDescriptor.spec.js | 103 - ...1pushfundstransferOrderInformation.spec.js | 12 - ...nsferOrderInformationAmountDetails.spec.js | 12 + ...stransferOrderInformationSurcharge.spec.js | 67 - ...stransferPointOfServiceInformation.spec.js | 91 - ...fundstransferProcessingInformation.spec.js | 36 - ...rocessingInformationPayoutsOptions.spec.js | 8 +- ...cessingInformationRecurringOptions.spec.js | 67 - ...pushfundstransferProcessingOptions.spec.js | 67 - ...ferProcessingOptionsFundingOptions.spec.js | 67 - ...singOptionsFundingOptionsInitiator.spec.js | 67 - ...hfundstransferRecipientInformation.spec.js | 12 - ...tInformationPersonalIdentification.spec.js | 6 + ...pushfundstransferSenderInformation.spec.js | 6 - ...rInformationPersonalIdentification.spec.js | 6 + .../Ptsv2paymentsTokenInformation.spec.js | 6 + ...ationTokenProvisioningInformation.spec.js} | 16 +- .../Ptsv2payoutsRecipientInformation.spec.js | 12 - ...nds201ResponseProcessorInformation.spec.js | 12 - test/model/PushFundsRequest.spec.js | 30 - ...dInstrumentIdentifierTokenizedCard.spec.js | 6 + 325 files changed, 1459 insertions(+), 4059 deletions(-) delete mode 100644 docs/Ptsv1pushfundstransferAggregatorInformation.md delete mode 100644 docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md delete mode 100644 docs/Ptsv1pushfundstransferMerchantDefinedInformation.md delete mode 100644 docs/Ptsv1pushfundstransferMerchantInformation.md delete mode 100644 docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md delete mode 100644 docs/Ptsv1pushfundstransferOrderInformationSurcharge.md delete mode 100644 docs/Ptsv1pushfundstransferPointOfServiceInformation.md delete mode 100644 docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md delete mode 100644 docs/Ptsv1pushfundstransferProcessingOptions.md delete mode 100644 docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md delete mode 100644 docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md rename docs/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md => Ptsv2paymentsTokenInformationTokenProvisioningInformation.md} (92%) delete mode 100644 src/model/Ptsv1pushfundstransferAggregatorInformation.js delete mode 100644 src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js delete mode 100644 src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js delete mode 100644 src/model/Ptsv1pushfundstransferMerchantInformation.js delete mode 100644 src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js delete mode 100644 src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js delete mode 100644 src/model/Ptsv1pushfundstransferPointOfServiceInformation.js delete mode 100644 src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js delete mode 100644 src/model/Ptsv1pushfundstransferProcessingOptions.js delete mode 100644 src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js delete mode 100644 src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js rename src/model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.js => Ptsv2paymentsTokenInformationTokenProvisioningInformation.js} (74%) delete mode 100644 test/model/Ptsv1pushfundstransferAggregatorInformation.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferMerchantDefinedInformation.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferMerchantInformation.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferOrderInformationSurcharge.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferPointOfServiceInformation.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferProcessingOptions.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.spec.js delete mode 100644 test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.spec.js rename test/model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.spec.js => Ptsv2paymentsTokenInformationTokenProvisioningInformation.spec.js} (70%) diff --git a/docs/GetAllPlansResponseOrderInformationAmountDetails.md b/docs/GetAllPlansResponseOrderInformationAmountDetails.md index 3bc3fc88..3ad8a7fc 100644 --- a/docs/GetAllPlansResponseOrderInformationAmountDetails.md +++ b/docs/GetAllPlansResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **billingAmount** | **String** | Billing amount for the billing period. | [optional] **setupFee** | **String** | Subscription setup fee | [optional] diff --git a/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md b/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md index 7b41f928..7fe61694 100644 --- a/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md +++ b/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **enableReminders** | **Boolean** | Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due. | [optional] **headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional] **deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional] -**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **payerAuthentication3DSVersion** | **Boolean** | The 3D Secure payer authentication status for a merchant's invoice payments. | [optional] [default to false] **showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false] **vatRegistrationNumber** | **String** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional] diff --git a/docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md b/docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md index 78c7bb34..ff7bb0a1 100644 --- a/docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md +++ b/docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Payer name for the invoice. | [optional] -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] diff --git a/docs/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md b/docs/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md index 16b1f074..c070b3ae 100644 --- a/docs/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md +++ b/docs/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/InvoicingV2InvoicesGet200ResponseTransactionDetails.md b/docs/InvoicingV2InvoicesGet200ResponseTransactionDetails.md index 145685a3..7cdd7bfb 100644 --- a/docs/InvoicingV2InvoicesGet200ResponseTransactionDetails.md +++ b/docs/InvoicingV2InvoicesGet200ResponseTransactionDetails.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionId** | **String** | Payer auth Transaction identifier. | [optional] -**amount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**amount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] diff --git a/docs/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md b/docs/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md index e43940c9..ba50b0be 100644 --- a/docs/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md +++ b/docs/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **balanceAmount** | **String** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] **discountAmount** | **String** | Total discount amount applied to the order. | [optional] **discountPercent** | **Number** | The total discount percentage applied to the invoice. | [optional] diff --git a/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md b/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md index 4a5722db..0eb759e1 100644 --- a/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md +++ b/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **enableReminders** | **Boolean** | Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due. | [optional] **headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional] **deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional] -**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **payerAuthenticationInInvoicing** | **String** | For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: - `enable` - `update` - `disable` | [optional] **showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false] **vatRegistrationNumber** | **String** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional] diff --git a/docs/Invoicingv2invoicesCustomerInformation.md b/docs/Invoicingv2invoicesCustomerInformation.md index dbeea769..5b7e127e 100644 --- a/docs/Invoicingv2invoicesCustomerInformation.md +++ b/docs/Invoicingv2invoicesCustomerInformation.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Payer name for the invoice. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **company** | [**Invoicingv2invoicesCustomerInformationCompany**](Invoicingv2invoicesCustomerInformationCompany.md) | | [optional] diff --git a/docs/Invoicingv2invoicesCustomerInformationCompany.md b/docs/Invoicingv2invoicesCustomerInformationCompany.md index d0ded151..52536b4e 100644 --- a/docs/Invoicingv2invoicesCustomerInformationCompany.md +++ b/docs/Invoicingv2invoicesCustomerInformationCompany.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**name** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] diff --git a/docs/Invoicingv2invoicesOrderInformationAmountDetails.md b/docs/Invoicingv2invoicesOrderInformationAmountDetails.md index c19c266c..d7bbb0ca 100644 --- a/docs/Invoicingv2invoicesOrderInformationAmountDetails.md +++ b/docs/Invoicingv2invoicesOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **String** | Total discount amount applied to the order. | [optional] **discountPercent** | **Number** | The total discount percentage applied to the invoice. | [optional] **subAmount** | **Number** | Sub-amount of the invoice. | [optional] diff --git a/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md b/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md index 14b2f361..fa50e6de 100644 --- a/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md +++ b/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**amount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] **taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false** | [optional] **taxRate** | **String** | Shipping Tax rate applied to the freight amount. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] diff --git a/docs/Kmsv2keyssymClientReferenceInformation.md b/docs/Kmsv2keyssymClientReferenceInformation.md index f8e7a251..f920ae18 100644 --- a/docs/Kmsv2keyssymClientReferenceInformation.md +++ b/docs/Kmsv2keyssymClientReferenceInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] diff --git a/docs/PatchInstrumentIdentifierRequest.md b/docs/PatchInstrumentIdentifierRequest.md index 6daf5858..b7a80e80 100644 --- a/docs/PatchInstrumentIdentifierRequest.md +++ b/docs/PatchInstrumentIdentifierRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **String** | The Id of the Instrument Identifier Token. | [optional] **_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 | [optional] -**tokenProvisioningInformation** | [**TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/PostInstrumentIdentifierEnrollmentRequest.md b/docs/PostInstrumentIdentifierEnrollmentRequest.md index cef71069..32b19f63 100644 --- a/docs/PostInstrumentIdentifierEnrollmentRequest.md +++ b/docs/PostInstrumentIdentifierEnrollmentRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **String** | The Id of the Instrument Identifier Token. | [optional] **_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 | [optional] -**tokenProvisioningInformation** | [**TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/PostInstrumentIdentifierRequest.md b/docs/PostInstrumentIdentifierRequest.md index a0b0ee0d..c9aff930 100644 --- a/docs/PostInstrumentIdentifierRequest.md +++ b/docs/PostInstrumentIdentifierRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **String** | The Id of the Instrument Identifier Token. | [optional] **_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 | [optional] -**tokenProvisioningInformation** | [**TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/PtsV2CreditsPost201ResponseCreditAmountDetails.md b/docs/PtsV2CreditsPost201ResponseCreditAmountDetails.md index 3e71183d..c47aa042 100644 --- a/docs/PtsV2CreditsPost201ResponseCreditAmountDetails.md +++ b/docs/PtsV2CreditsPost201ResponseCreditAmountDetails.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **creditAmount** | **String** | Amount that was credited to the cardholder's account. Returned by PIN debit credit. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md b/docs/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md index 0476200e..ccb4c562 100644 --- a/docs/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md +++ b/docs/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] diff --git a/docs/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md index 511d87ae..2faa91a4 100644 --- a/docs/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalAmount** | **String** | Amount you requested for the capture. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **processorTransactionFee** | **String** | The fee decided by the PSP/Processor per transaction. | [optional] diff --git a/docs/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md b/docs/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md index f90ec871..9cf7f81b 100644 --- a/docs/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md +++ b/docs/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**type** | **String** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. | [optional] +**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] diff --git a/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md index d84f6854..d6a50f5d 100644 --- a/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] **currency** | **String** | Currency used for the order | [optional] diff --git a/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md b/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md index eedd506c..abad6e45 100644 --- a/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md +++ b/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **administrativeArea** | **String** | 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **verificationStatus** | **String** | Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED | [optional] diff --git a/docs/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md b/docs/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md index 194f9bc2..5ea1e0cf 100644 --- a/docs/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md +++ b/docs/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseBuyerInformation.md b/docs/PtsV2PaymentsPost201ResponseBuyerInformation.md index b159f7b5..8af55b8a 100644 --- a/docs/PtsV2PaymentsPost201ResponseBuyerInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseBuyerInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] +**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] **personalIdentification** | [**[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] **taxId** | **String** | The description for this field is not available. | [optional] **loginId** | **String** | The buyer's Alipay login Id, the id might be an email or mobile number. The id is partially masked for privacy. cao***@126.com or 186***22156 | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md index e2442b0c..833616fe 100644 --- a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **acsRenderingType** | **String** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] **acsTransactionId** | **String** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] **acsUrl** | **String** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] -**authenticationPath** | **String** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**authenticationPath** | **String** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. | [optional] **authorizationPayload** | **String** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] **authenticationTransactionId** | **String** | Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. | [optional] **cardholderMessage** | **String** | Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder. For example, \"Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\". The Issuing Bank can optionally support this value. | [optional] @@ -27,7 +27,7 @@ Name | Type | Description | Notes **networkScore** | **String** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] **pareq** | **String** | Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64. | [optional] **paresStatus** | **String** | Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated. | [optional] -**proofXml** | **String** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] +**proofXml** | **String** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] **proxyPan** | **String** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdkTransactionId** | **String** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signedParesStatusReason** | **String** | Provides additional information as to why the PAResStatus has a specific value. | [optional] @@ -36,7 +36,7 @@ Name | Type | Description | Notes **threeDSServerTransactionId** | **String** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucafAuthenticationData** | **String** | AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request. | [optional] **ucafCollectionIndicator** | **String** | For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication. | [optional] -**veresEnrolled** | **String** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**veresEnrolled** | **String** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. | [optional] **whiteListStatusSource** | **String** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] **xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional] **directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md index 08257112..44a8a83d 100644 --- a/docs/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalAmount** | **String** | Amount you requested for the payment or capture. This value is returned for partial authorizations. This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations. | [optional] -**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **originalAmount** | **String** | Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md index 4dc83eda..f19232c0 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **paymentInstrument** | [**Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional] **instrumentIdentifier** | [**PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier**](PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] **shippingAddress** | [**Ptsv2paymentsPaymentInformationShippingAddress**](Ptsv2paymentsPaymentInformationShippingAddress.md) | | [optional] -**scheme** | **String** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bin** | **String** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**issuer** | **String** | Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**binCountry** | **String** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**scheme** | **String** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. | [optional] +**bin** | **String** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. | [optional] +**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **String** | Name of the bank or entity that issued the card account. | [optional] +**binCountry** | **String** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. | [optional] **eWallet** | [**PtsV2PaymentsPost201ResponsePaymentInformationEWallet**](PtsV2PaymentsPost201ResponsePaymentInformationEWallet.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationBank.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationBank.md index cac4fbd7..eb8d15ff 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationBank.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationBank.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**PtsV2PaymentsPost201ResponsePaymentInformationBankAccount**](PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md) | | [optional] -**correctedRoutingNumber** | **String** | Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**correctedRoutingNumber** | **String** | Corrected account number from the ACH verification service. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md index 39974b6e..04e1c90d 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**correctedAccountNumber** | **String** | Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**correctedAccountNumber** | **String** | Corrected account number from the ACH verification service. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md b/docs/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md index 39a4a143..15f6c407 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**fraudScreeningLevel** | **String** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] +**fraudScreeningLevel** | **String** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md index 236dfa30..3db9caf0 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **String** | Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] -**resultCodeRaw** | **String** | Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**resultCode** | **String** | Results from the ACH verification service. | [optional] +**resultCodeRaw** | **String** | Raw results from the ACH verification service. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md index f666843c..05e17c92 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**resultCode** | **String** | CVN result code. | [optional] **resultCodeRaw** | **String** | CVN result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md index fc97c7da..c5c4f5c5 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Mapped Electronic Verification response code for the customer's name. For details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**code** | **String** | Mapped Electronic Verification response code for the customer's name. | [optional] **codeRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's last name | [optional] -**email** | **String** | Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**email** | **String** | Mapped Electronic Verification response code for the customer's email address. | [optional] **emailRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] -**phoneNumber** | **String** | Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**phoneNumber** | **String** | Mapped Electronic Verification response code for the customer's phone number. | [optional] **phoneNumberRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] -**postalCode** | **String** | Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**postalCode** | **String** | Mapped Electronic Verification response code for the customer's postal code. | [optional] **postalCodeRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's postal code. | [optional] -**street** | **String** | Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**street** | **String** | Mapped Electronic Verification response code for the customer's street address. | [optional] **streetRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] **name** | **String** | #### Visa Platform Connect Mapped Electronic Verification response code for the customer's name. Valid values : 'Y' Yes, the data Matches 'N' No Match 'O' Partial Match | [optional] **nameRaw** | **String** | #### Visa Platform Connect Raw Electronic Verification response code from the processor for the customer's name. Valid values : '01' Match '50' Partial Match '99' No Match | [optional] diff --git a/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md index 08563db0..9ec4e925 100644 --- a/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) | [optional] -**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] +**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] diff --git a/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md b/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md index 620daabc..3d514bc7 100644 --- a/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md +++ b/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **refundAmount** | **String** | Total amount of the refund. | [optional] **creditAmount** | **String** | Amount that was credited to the cardholder's account. Returned by PIN debit credit. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md b/docs/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md index c38e9da1..0c98de39 100644 --- a/docs/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md +++ b/docs/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reversedAmount** | **String** | Total reversed amount. Returned by authorization reversal. | [optional] **originalTransactionAmount** | **String** | Amount of the original transaction. Returned by authorization reversal and void. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md b/docs/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md index f0272f3b..e43c3d58 100644 --- a/docs/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md +++ b/docs/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **voidAmount** | **String** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] **originalTransactionAmount** | **String** | Amount of the original transaction. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md index d2967adc..853399f9 100644 --- a/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/Ptsv1pushfundstransferAggregatorInformation.md b/docs/Ptsv1pushfundstransferAggregatorInformation.md deleted file mode 100644 index 62c2ef4b..00000000 --- a/docs/Ptsv1pushfundstransferAggregatorInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferAggregatorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. FDC Compass This value must consist of uppercase letters. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - `Record`: CP01 TCR6 - `Position`: 95-105 - `Field`: Market Identifier / Payment Facilitator ID | [optional] -**name** | **String** | Your payment aggregator business name. Visa Platform COnnect With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API. | [optional] -**subMerchant** | [**Ptsv1pushfundstransferAggregatorInformationSubMerchant**](Ptsv1pushfundstransferAggregatorInformationSubMerchant.md) | | [optional] - - diff --git a/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md b/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md deleted file mode 100644 index 4c44e28e..00000000 --- a/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md +++ /dev/null @@ -1,16 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | The ID you assigned to your sub-merchant. FDC Compass: This value must consist of uppercase characters. Visa Platform Connect with Mastercard: String (15) FDC Compass: String (20) | [optional] -**name** | **String** | Sub-merchant's business name. Visa Platform Connect With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**address1** | **String** | First line of the sub-merchant's street address. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **String** | Sub-merchant's city. For processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**administrativeArea** | **String** | Sub-merchant's state or province. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional] -**postalCode** | **String** | Partial postal code for the sub-merchant's address. For processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **String** | Sub-merchant's country. Use the ISO Standard numeric Country Codes. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional] -**email** | **String** | Sub-merchant's email address. CyberSource through VisaNet | With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address - Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**phoneNumber** | **String** | Sub-merchant's telephone number. Maximum length for procesors Visa Platform Connect: 20 FDC Compass: 13 FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA | [optional] - - diff --git a/docs/Ptsv1pushfundstransferMerchantDefinedInformation.md b/docs/Ptsv1pushfundstransferMerchantDefinedInformation.md deleted file mode 100644 index f1457ed6..00000000 --- a/docs/Ptsv1pushfundstransferMerchantDefinedInformation.md +++ /dev/null @@ -1,9 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key. For Mastercard Send: Name to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report. | [optional] -**value** | **String** | The value you assign for your merchant-defined data field. For details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. For Mastercard Send: Value to be displayed in the reconciliation report for this disbursement. | [optional] - - diff --git a/docs/Ptsv1pushfundstransferMerchantInformation.md b/docs/Ptsv1pushfundstransferMerchantInformation.md deleted file mode 100644 index 51a33bef..00000000 --- a/docs/Ptsv1pushfundstransferMerchantInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categoryCode** | **Number** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR4 Position: 150-153 Field: Merchant Category Code | [optional] -**submitLocalDateTime** | **String** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. Visa Platform Connect: max length is 20 | [optional] -**merchantDescriptor** | [**Ptsv1pushfundstransferMerchantInformationMerchantDescriptor**](Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md) | | [optional] - - diff --git a/docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md b/docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md deleted file mode 100644 index 90849c92..00000000 --- a/docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,14 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **String** | The state where the merchant is located. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Note This field is supported only for businesses located in the U.S. or Canada. | [optional] -**contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: FDC Compass (13) Chase Paymentech (13). | [optional] -**country** | **String** | Merchant's country. Country code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea. | [optional] -**locality** | **String** | Merchant's City. City for your business location. This value might be displayed on the cardholder's statement. | [optional] -**name** | **String** | Merchant's business name. This name is displayed on the cardholder's statement. Chase Paymentech, Visa Platform Connect: length 22 | [optional] -**storeId** | **String** | The unique id of the merchant's shop which assigned by the merchant. | [optional] -**postalCode** | **String** | Merchant's postal code. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3 | [optional] - - diff --git a/docs/Ptsv1pushfundstransferOrderInformation.md b/docs/Ptsv1pushfundstransferOrderInformation.md index 96630b4f..cb08061e 100644 --- a/docs/Ptsv1pushfundstransferOrderInformation.md +++ b/docs/Ptsv1pushfundstransferOrderInformation.md @@ -4,7 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **amountDetails** | [**Ptsv1pushfundstransferOrderInformationAmountDetails**](Ptsv1pushfundstransferOrderInformationAmountDetails.md) | | -**isCryptocurrencyPurchase** | **String** | This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false | [optional] -**surcharge** | [**Ptsv1pushfundstransferOrderInformationSurcharge**](Ptsv1pushfundstransferOrderInformationSurcharge.md) | | [optional] diff --git a/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md b/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md index caafd734..1134e0c5 100644 --- a/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md +++ b/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md @@ -3,7 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 | -**currency** | **String** | Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. | +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. | +**currency** | **String** | Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. | +**sourceCurrency** | **String** | Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] +**destinationCurrency** | **String** | Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf NOTE: This field is supported only for Visa Platform Connect | [optional] diff --git a/docs/Ptsv1pushfundstransferOrderInformationSurcharge.md b/docs/Ptsv1pushfundstransferOrderInformationSurcharge.md deleted file mode 100644 index b7381c0f..00000000 --- a/docs/Ptsv1pushfundstransferOrderInformationSurcharge.md +++ /dev/null @@ -1,8 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. NOTE: This field is supported only for Visa Platform Connect | [optional] - - diff --git a/docs/Ptsv1pushfundstransferPointOfServiceInformation.md b/docs/Ptsv1pushfundstransferPointOfServiceInformation.md deleted file mode 100644 index 9e50a750..00000000 --- a/docs/Ptsv1pushfundstransferPointOfServiceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferPointOfServiceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. Visa Platform Connect A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. Used by Authorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel. | [optional] -**catLevel** | **Number** | Type of cardholder-activated terminal. Possible values: - `1`: Automated dispensing machine - `2`: Self-service terminal - `3`: Limited amount terminal - `4`: In-flight commerce (IFC) terminal - `5`: Radio frequency device - `6`: Mobile acceptance terminal - `7`: Electronic cash register - `8`: E-commerce device at your location - `9`: Terminal or cash register that uses a dialup connection to connect to the transaction processing network Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if pointOfSaleInformation.terminalID is included in the request; otherwise, optional. Visa Platform COnnect Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. Nonnegative integer. | [optional] -**entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. | [optional] -**pinEntryCapability** | **Number** | PIN Entry Capability - 0 Unknown. - 1 Indicates terminal can accept and forward online PINs. - 2 Indicates terminal cannot accept and forward online PINs. - 8 Terminal PIN pad down. - 9 Reserved for future use. | [optional] -**terminalCapability** | **Number** | integer [ 1 .. 5 ] POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be 4 or 5. Used by Authorization Required for the following processors: Chase Paymentech Solutions Optional for the following processors: Visa Platform Connect | [optional] - - diff --git a/docs/Ptsv1pushfundstransferProcessingInformation.md b/docs/Ptsv1pushfundstransferProcessingInformation.md index daa889f6..a2a7abcd 100644 --- a/docs/Ptsv1pushfundstransferProcessingInformation.md +++ b/docs/Ptsv1pushfundstransferProcessingInformation.md @@ -3,13 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**businessApplicationId** | **String** | Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - `AA`: Account to account. - `CP`: Card bill payment - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. - `TU`: Top-up for enhanced prepaid loads. Mastercard Send: - `BB`: Business to business. - `BD`: Business Disbursement - `CP`: Card bill payment - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `OG`: Online gambling payout. Chase Paymentech Solutions: - `AA`: Account to account. - `FD`: Funds disbursement (general) - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. FDC Compass: - `BB`: Business to business. - `BI`: Bank-initiated money transfer. - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `GP`: Gambling Payment - `LO`: Loyalty Offers - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `MI`: Merchant initated money transfer - `OG`: Online gambling payout. - `PD`: Payroll pension disbursement. - `PP`: Person to person. - `WT`: Wallet transfer. | [optional] -**commerceIndicator** | **String** | Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. | -**networkRoutingOrder** | **String** | Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the network_order field description in BIN Lookup Service Using the SCMP API. | [optional] +**businessApplicationId** | **String** | Payouts transaction type. Business Application ID: - `PP`: Person to person. - `FD`: Funds disbursement (general) | [optional] **payoutsOptions** | [**Ptsv1pushfundstransferProcessingInformationPayoutsOptions**](Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md) | | [optional] -**purposeOfPayment** | **String** | This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country. Mastercard Send: - `00`: Family Support - `01`: Regular Labor Transfers (expatriates), - `02`: Travel & Tourism - `03`: Education - `04`: Hospitalization & Medical Treatment, - `05`: Emergency Need - `06`: Savings - `07`: Gifts - `08`: Other - `09`: Salary - `10`: Crowd lending - `11`: Crypto currency - `12`: Refund to original card - `13`: Refund to new card | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. For Payouts: max length for FDCCompass is String (22). | [optional] -**recurringOptions** | [**Ptsv1pushfundstransferProcessingInformationRecurringOptions**](Ptsv1pushfundstransferProcessingInformationRecurringOptions.md) | | [optional] -**transactionReason** | **String** | Transaction reason code. This field applies only to Visa Platform Connect | [optional] diff --git a/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md b/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md index 5e5371e1..e21ec3a3 100644 --- a/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md +++ b/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accountFundingReferenceId** | **String** | Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. Applicable only for Visa Platform Connect | [optional] -**retrievalReferenceNumber** | **String** | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant Applicable only for Visa Platform Connect | [optional] +**sourceCurrency** | **String** | Use a 3-character alpha currency code for source currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] +**destinationCurrency** | **String** | Use a 3-character alpha currency code for destination currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] diff --git a/docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md b/docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md deleted file mode 100644 index edc456a1..00000000 --- a/docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md +++ /dev/null @@ -1,8 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loanPayment** | **Boolean** | boolean Default: false Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: true: Loan payment false: (default) Not a loan payment This field applies only to FDC Compass | [optional] - - diff --git a/docs/Ptsv1pushfundstransferProcessingOptions.md b/docs/Ptsv1pushfundstransferProcessingOptions.md deleted file mode 100644 index 42012c2b..00000000 --- a/docs/Ptsv1pushfundstransferProcessingOptions.md +++ /dev/null @@ -1,8 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferProcessingOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fundingOptions** | [**Ptsv1pushfundstransferProcessingOptionsFundingOptions**](Ptsv1pushfundstransferProcessingOptionsFundingOptions.md) | | [optional] - - diff --git a/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md b/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md deleted file mode 100644 index df3bdf41..00000000 --- a/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md +++ /dev/null @@ -1,8 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator**](Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md) | | [optional] - - diff --git a/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md b/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md deleted file mode 100644 index c52e01db..00000000 --- a/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md +++ /dev/null @@ -1,8 +0,0 @@ -# CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: - `S` (Payer (sender)) - `R` (Payee (recipient)) This field applies only to Visa Platform Connect | [optional] - - diff --git a/docs/Ptsv1pushfundstransferRecipientInformation.md b/docs/Ptsv1pushfundstransferRecipientInformation.md index 9428a450..83363fd2 100644 --- a/docs/Ptsv1pushfundstransferRecipientInformation.md +++ b/docs/Ptsv1pushfundstransferRecipientInformation.md @@ -4,17 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentInformation** | [**Ptsv1pushfundstransferRecipientInformationPaymentInformation**](Ptsv1pushfundstransferRecipientInformationPaymentInformation.md) | | [optional] -**address1** | **String** | First line of the recipient's address. Required for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional] -**address2** | **String** | Second line of the recipient's address Optional for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional] -**locality** | **String** | Recipient city. Required for Mastercard Send. | [optional] -**postalCode** | **String** | Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mastercard Send: Required for recipients in Canada and Canadian issued cards. | [optional] -**administrativeArea** | **String** | The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. Required only for FDCCompass. This field is not supported for Visa Platform Connect. | [optional] -**country** | **String** | Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Required for Mastercard Send. | [optional] -**firstName** | **String** | First name of recipient. Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional] +**address1** | **String** | First line of the recipient's address. Required for card payments | [optional] +**address2** | **String** | Second line of the recipient's address | [optional] +**locality** | **String** | Recipient city. | [optional] +**postalCode** | **String** | Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mandatory for card payments. | [optional] +**administrativeArea** | **String** | The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Required for card payments. | [optional] +**country** | **String** | Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf | [optional] +**firstName** | **String** | First name of recipient. | [optional] **middleName** | **String** | Sender's middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**middleInitial** | **String** | Middle Initial of recipient. This field is supported by FDC Compass. | [optional] -**lastName** | **String** | Last name of recipient. Visa Platform Connect (14) Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional] -**dateOfBirth** | **String** | Recipient date of birth in YYYYMMDD format. | [optional] +**lastName** | **String** | Last name of recipient. | [optional] **phoneNumber** | **String** | Recipient phone number. This field is supported by FDC Compass. Mastercard Send: Max length is 15 with no dashes or spaces. | [optional] **personalIdentification** | [**Ptsv1pushfundstransferRecipientInformationPersonalIdentification**](Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md) | | [optional] diff --git a/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md b/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md index eacfe1b8..64b539d2 100644 --- a/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md +++ b/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | Three-digit value that indicates the card type. Mandatory if not present in a token. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. | [optional] +**type** | **String** | Three-digit value that indicates the card type. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Yellow Pepper: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `005`: Diners Club - `033`: Visa Electron - `024`: Intl Maestro | [optional] **securityCode** | **String** | 3-digit value that indicates the cardCvv2Value. Values can be 0-9. | [optional] **_number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). Conditional: this field is required if not using tokens. | [optional] **expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. | [optional] diff --git a/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md b/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md index cece532b..dbf2b996 100644 --- a/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md +++ b/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md @@ -3,7 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The ID number/value. Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) | [optional] -**type** | **String** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) | [optional] +**id** | **String** | The ID number/value. Processor(35) | [optional] +**type** | **String** | This tag will contain the type of sender identification. | [optional] +**issuingCountry** | **String** | Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. | [optional] diff --git a/docs/Ptsv1pushfundstransferSenderInformation.md b/docs/Ptsv1pushfundstransferSenderInformation.md index 24159391..9bb1191b 100644 --- a/docs/Ptsv1pushfundstransferSenderInformation.md +++ b/docs/Ptsv1pushfundstransferSenderInformation.md @@ -4,16 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Name of sender. Funds Disbursement This value is the name of the originator sending the funds disbursement. | [optional] -**firstName** | **String** | This field contains the first name of the entity funding the transaction. | [optional] -**lastName** | **String** | This field contains the last name of the entity funding the transaction. | [optional] -**middleName** | **String** | Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction | [optional] +**firstName** | **String** | This field contains the first name of the entity funding the transaction Mandatory for card payments | [optional] +**lastName** | **String** | This field contains the last name of the entity funding the transaction Mandatory for card payments | [optional] +**middleName** | **String** | This field contains the middle name of the entity funding the transaction | [optional] **postalCode** | **String** | Sender's postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Required for FDCCompass. | [optional] -**address1** | **String** | Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. | [optional] -**address2** | **String** | Used for additional address information. For example: Attention: Accounts Payable Optional field. This field is supported for only Mastercard Send. | [optional] -**locality** | **String** | The sender's city Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. | [optional] -**administrativeArea** | **String** | Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf | [optional] -**country** | **String** | Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. Required for Mastercard Send | [optional] -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. | [optional] +**address1** | **String** | Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Required for card transactions | [optional] +**address2** | **String** | Used for additional address information. For example: Attention: Accounts Payable Optional field. | [optional] +**locality** | **String** | The sender's city Mandatory for card payments | [optional] +**administrativeArea** | **String** | Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Mandatory for card payments | [optional] +**country** | **String** | Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf | [optional] **dateOfBirth** | **String** | Sender's date of birth in YYYYMMDD format. | [optional] **phoneNumber** | **String** | Sender's phone number. | [optional] **paymentInformation** | [**Ptsv1pushfundstransferSenderInformationPaymentInformation**](Ptsv1pushfundstransferSenderInformationPaymentInformation.md) | | [optional] diff --git a/docs/Ptsv1pushfundstransferSenderInformationAccount.md b/docs/Ptsv1pushfundstransferSenderInformationAccount.md index ce631161..59ee51de 100644 --- a/docs/Ptsv1pushfundstransferSenderInformationAccount.md +++ b/docs/Ptsv1pushfundstransferSenderInformationAccount.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fundsSource** | **String** | Source of funds. Possible values: Chase Paymentech, FDC Compass, Visa Platform Connect: - `01`: Credit card - `02`: Debit card - `03`: Prepaid card Chase Paymentech, Visa Platform Connect: - `04`: Cash - `05`: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards. - `06`: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit. FDC Compass: - `04`: Deposit Account Funds Disbursement This value is most likely 05 to identify that the originator used a deposit account to fund the disbursement. Credit Card Bill Payment This value must be 02, 03, 04, or 05. | [optional] -**_number** | **String** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: FDC Compass (<= 19) Chase Paymentech (<= 16) | [optional] +**_number** | **String** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: | [optional] diff --git a/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md b/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md index d3f01146..1561ed0f 100644 --- a/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md +++ b/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Three-digit value that indicates the card type. IMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value 001 for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. | [optional] -**securityCode** | **String** | 3-digit value that indicates the card Cvv2Value. Values can be 0-9. This field is supported in Mastercard Send. | [optional] -**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Valid values for Visa Platform Connect: - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account Valid values for Mastercard Send: - `00`: Other, - `01`: RTN + Bank Account, - `02`: IBAN, - `03`: Card Account, - `04`: Email, - `05`: Phone Number, - `06`: Bank account number (BAN) + Bank Identification Сode (BIC), - `07`: Wallet ID, - `08`: Social Network ID. Numeric, 2 characters. This field is supported in Mastercard Send. | [optional] -**_number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). This field is supported in Mastercard Send. | [optional] -**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. This field is supported for Mastercard Send. | [optional] -**expirationYear** | **String** | Four-digit year in which the payment card expires. This field is supported for Mastercard Send. | [optional] +**securityCode** | **String** | 3-digit value that indicates the card Cvv2Value. Values can be 0-9. | [optional] +**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. | [optional] +**_number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. | [optional] +**expirationYear** | **String** | Four-digit year in which the payment card expires. | [optional] diff --git a/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md b/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md index b86fe149..5bbf80d3 100644 --- a/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md +++ b/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Visa Platform Connect(35) This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) | [optional] +**id** | **String** | Processor(35) | [optional] **personalIdType** | **String** | Visa Platform Connect This tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification). The valid values are: • B (Business) • I (Individual) | [optional] -**type** | **String** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) | [optional] +**type** | **String** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) | [optional] +**issuingCountry** | **String** | Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. | [optional] diff --git a/docs/Ptsv2billingagreementsAggregatorInformation.md b/docs/Ptsv2billingagreementsAggregatorInformation.md index 2c291136..e7aee55c 100644 --- a/docs/Ptsv2billingagreementsAggregatorInformation.md +++ b/docs/Ptsv2billingagreementsAggregatorInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. | [optional] **subMerchant** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional] diff --git a/docs/Ptsv2billingagreementsBuyerInformation.md b/docs/Ptsv2billingagreementsBuyerInformation.md index 9e39e3d7..b0dfeb9e 100644 --- a/docs/Ptsv2billingagreementsBuyerInformation.md +++ b/docs/Ptsv2billingagreementsBuyerInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **gender** | **String** | Customer's gender. Possible values are F (female), M (male), O (other). | [optional] **language** | **String** | language setting of the user | [optional] diff --git a/docs/Ptsv2billingagreementsClientReferenceInformation.md b/docs/Ptsv2billingagreementsClientReferenceInformation.md index 5ae2869b..c63e0eee 100644 --- a/docs/Ptsv2billingagreementsClientReferenceInformation.md +++ b/docs/Ptsv2billingagreementsClientReferenceInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional] **pausedRequestId** | **String** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **String** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [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] diff --git a/docs/Ptsv2billingagreementsOrderInformationBillTo.md b/docs/Ptsv2billingagreementsOrderInformationBillTo.md index 63f9bfdf..d88d3690 100644 --- a/docs/Ptsv2billingagreementsOrderInformationBillTo.md +++ b/docs/Ptsv2billingagreementsOrderInformationBillTo.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **county** | **String** | U.S. county if available. | [optional] **district** | **String** | Customer's neighborhood, community, or region within the city or municipality. #### SEPA/BACS When you include this field in a request, the value for this field must be the same as the value for the billTo_state field. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **middleName** | **String** | Customer's middle name. | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/Ptsv2billingagreementsidBuyerInformation.md b/docs/Ptsv2billingagreementsidBuyerInformation.md index df422d09..2cb2562b 100644 --- a/docs/Ptsv2billingagreementsidBuyerInformation.md +++ b/docs/Ptsv2billingagreementsidBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **gender** | **String** | Customer's gender. Possible values are F (female), M (male), O (other). | [optional] **language** | **String** | language setting of the user | [optional] diff --git a/docs/Ptsv2creditsProcessingInformation.md b/docs/Ptsv2creditsProcessingInformation.md index 3f0ba70e..7f9f4faf 100644 --- a/docs/Ptsv2creditsProcessingInformation.md +++ b/docs/Ptsv2creditsProcessingInformation.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] **processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional] **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional] diff --git a/docs/Ptsv2creditsProcessingInformationBankTransferOptions.md b/docs/Ptsv2creditsProcessingInformationBankTransferOptions.md index 1ac4681f..5de58865 100644 --- a/docs/Ptsv2creditsProcessingInformationBankTransferOptions.md +++ b/docs/Ptsv2creditsProcessingInformationBankTransferOptions.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **customerMemo** | **String** | Payment related information. This information is included on the customer's statement. | [optional] -**secCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**secCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] **terminalCity** | **String** | City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **terminalState** | **String** | State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **effectiveDate** | **String** | Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service. | [optional] -**partialPaymentId** | **String** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**partialPaymentId** | **String** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. | [optional] +**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] diff --git a/docs/Ptsv2paymentreferencesBuyerInformation.md b/docs/Ptsv2paymentreferencesBuyerInformation.md index 69306d7f..a834e96c 100644 --- a/docs/Ptsv2paymentreferencesBuyerInformation.md +++ b/docs/Ptsv2paymentreferencesBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **gender** | **String** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **String** | language setting of the user | [optional] **noteToSeller** | **String** | Note to the recipient of the funds in this transaction | [optional] diff --git a/docs/Ptsv2paymentreferencesOrderInformationAmountDetails.md b/docs/Ptsv2paymentreferencesOrderInformationAmountDetails.md index ee893ab8..db3ea210 100644 --- a/docs/Ptsv2paymentreferencesOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentreferencesOrderInformationAmountDetails.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **String** | Total discount amount applied to the order. | [optional] **taxAmount** | **String** | Total tax amount for all the items in the order. | [optional] **dutyAmount** | **String** | Total charges for any import or export duties included in the order. | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) | [optional] +**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **String** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **giftwrapAmount** | **String** | giftwrap amount (RFU). | [optional] diff --git a/docs/Ptsv2paymentreferencesPaymentInformationBank.md b/docs/Ptsv2paymentreferencesPaymentInformationBank.md index c9aa0ab9..27e92b1c 100644 --- a/docs/Ptsv2paymentreferencesPaymentInformationBank.md +++ b/docs/Ptsv2paymentreferencesPaymentInformationBank.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] **account** | [**Ptsv2paymentreferencesPaymentInformationBankAccount**](Ptsv2paymentreferencesPaymentInformationBankAccount.md) | | [optional] diff --git a/docs/Ptsv2paymentreferencesPaymentInformationBankAccount.md b/docs/Ptsv2paymentreferencesPaymentInformationBankAccount.md index f81e13c8..1ed1b6bc 100644 --- a/docs/Ptsv2paymentreferencesPaymentInformationBankAccount.md +++ b/docs/Ptsv2paymentreferencesPaymentInformationBankAccount.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_number** | **String** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] diff --git a/docs/Ptsv2paymentsAggregatorInformation.md b/docs/Ptsv2paymentsAggregatorInformation.md index 287d574d..b1daad00 100644 --- a/docs/Ptsv2paymentsAggregatorInformation.md +++ b/docs/Ptsv2paymentsAggregatorInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. | [optional] +**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. | [optional] **subMerchant** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional] diff --git a/docs/Ptsv2paymentsBuyerInformation.md b/docs/Ptsv2paymentsBuyerInformation.md index bdc2f15b..d11cb79d 100644 --- a/docs/Ptsv2paymentsBuyerInformation.md +++ b/docs/Ptsv2paymentsBuyerInformation.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] +**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] **companyTaxId** | **String** | Company's tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. | [optional] **personalIdentification** | [**[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] -**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] **gender** | **String** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **String** | language setting of the user | [optional] **noteToSeller** | **String** | Note to the recipient of the funds in this transaction | [optional] diff --git a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md index 8f502cf0..59119dfb 100644 --- a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md +++ b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] -**issuedBy** | **String** | The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**type** | **String** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. | [optional] +**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**issuedBy** | **String** | The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. | [optional] **verificationResults** | **String** | Verification results received from Issuer or Card Network for verification transactions. Response Only Field. | [optional] diff --git a/docs/Ptsv2paymentsClientReferenceInformation.md b/docs/Ptsv2paymentsClientReferenceInformation.md index ddad4a6b..13f23847 100644 --- a/docs/Ptsv2paymentsClientReferenceInformation.md +++ b/docs/Ptsv2paymentsClientReferenceInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional] **pausedRequestId** | **String** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **String** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [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] diff --git a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md index 065fb8c8..7b569bfa 100644 --- a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md +++ b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes **cavv** | **String** | Cardholder authentication verification value (CAVV). | [optional] **transactionFlowIndicator** | **String** | This field details out the type of transaction. Below are the possible values. 08:GC- Guest Checkout. | [optional] **cavvAlgorithm** | **String** | Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check. | [optional] -**eciRaw** | **String** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**paresStatus** | **String** | Payer authentication response status. For details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**veresEnrolled** | **String** | Verification response enrollment status. For details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**xid** | **String** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**ucafCollectionIndicator** | **String** | Universal cardholder authentication field (UCAF) collection indicator. For details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator | [optional] -**ucafAuthenticationData** | **String** | Universal cardholder authentication field (UCAF) data. For details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **String** | Raw electronic commerce indicator (ECI). | [optional] +**paresStatus** | **String** | Payer authentication response status. | [optional] +**veresEnrolled** | **String** | Verification response enrollment status. | [optional] +**xid** | **String** | Transaction identifier. | [optional] +**ucafCollectionIndicator** | **String** | Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator | [optional] +**ucafAuthenticationData** | **String** | Universal cardholder authentication field (UCAF) data. | [optional] **strongAuthentication** | [**Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication**](Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] **directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional] **paSpecificationVersion** | **String** | This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0)) For Cybersource connection through Visanet, below are additional values to be supported. - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) | [optional] @@ -25,7 +25,7 @@ Name | Type | Description | Notes **authenticationDate** | **String** | The date/time of the authentication at the 3DS servers. RISK update authorization service in auth request payload with value returned in `consumerAuthenticationInformation.alternateAuthenticationData` if merchant calls via CYBS or field can be provided by merchant in authorization request if calling an external 3DS provider. This field is supported for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC. Format: YYYYMMDDHHMMSS | [optional] **authenticationTransactionId** | **String** | Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. **Note**: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service. | [optional] **challengeCancelCode** | **String** | An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK | [optional] -**challengeCode** | **String** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) | [optional] +**challengeCode** | **String** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. | [optional] **challengeStatus** | **String** | The `consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used. | [optional] **customerCardAlias** | **String** | An alias that uniquely identifies the customer's account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings. | [optional] **decoupledAuthenticationIndicator** | **String** | Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N | [optional] diff --git a/docs/Ptsv2paymentsMerchantDefinedInformation.md b/docs/Ptsv2paymentsMerchantDefinedInformation.md index f1a3a267..225cc0fd 100644 --- a/docs/Ptsv2paymentsMerchantDefinedInformation.md +++ b/docs/Ptsv2paymentsMerchantDefinedInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**value** | **String** | The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 | [optional] +**key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. | [optional] +**value** | **String** | The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetails.md b/docs/Ptsv2paymentsOrderInformationAmountDetails.md index 34af4da8..d5190206 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetails.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **giftWrapAmount** | **String** | Amount being charged as gift wrap fee. | [optional] -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] **subTotalAmount** | **String** | Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **String** | Total discount amount applied to the order. | [optional] **dutyAmount** | **String** | Total charges for any import or export duties included in the order. | [optional] **gratuityAmount** | **String** | Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present. | [optional] @@ -15,10 +15,10 @@ Name | Type | Description | Notes **taxAppliedAfterDiscount** | **String** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total | [optional] **taxAppliedLevel** | **String** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction | [optional] **taxTypeCode** | **String** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] +**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) | [optional] +**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **String** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **surcharge** | [**Ptsv2paymentsOrderInformationAmountDetailsSurcharge**](Ptsv2paymentsOrderInformationAmountDetailsSurcharge.md) | | [optional] **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md b/docs/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md index de720add..477eb929 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type0` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**code** | **String** | Additional amount type. This field is supported only for **American Express Direct**. | [optional] **amount** | **String** | Additional amount. This field is supported only for **American Express Direct**. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationBillTo.md b/docs/Ptsv2paymentsOrderInformationBillTo.md index b892c599..0ab05475 100644 --- a/docs/Ptsv2paymentsOrderInformationBillTo.md +++ b/docs/Ptsv2paymentsOrderInformationBillTo.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **district** | **String** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. | [optional] **buildingNumber** | **String** | Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **emailDomain** | **String** | Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneType** | **String** | Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationBillToCompany.md b/docs/Ptsv2paymentsOrderInformationBillToCompany.md index 256e7e1c..7cc035fe 100644 --- a/docs/Ptsv2paymentsOrderInformationBillToCompany.md +++ b/docs/Ptsv2paymentsOrderInformationBillToCompany.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**name** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] **address1** | **String** | First line in the street address of the company purchasing the product. | [optional] **address2** | **String** | Additional address information for the company purchasing the product. | [optional] **locality** | **String** | City in the address of the company purchasing the product. | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationBank.md b/docs/Ptsv2paymentsPaymentInformationBank.md index 8deebca3..18af3733 100644 --- a/docs/Ptsv2paymentsPaymentInformationBank.md +++ b/docs/Ptsv2paymentsPaymentInformationBank.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**Ptsv2paymentsPaymentInformationBankAccount**](Ptsv2paymentsPaymentInformationBankAccount.md) | | [optional] -**routingNumber** | **String** | Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **String** | Bank routing number. This is also called the _transit number_. | [optional] +**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] **code** | **String** | Bank code of the consumer's account | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationBankAccount.md b/docs/Ptsv2paymentsPaymentInformationBankAccount.md index 5ccb2cc4..3eecc0ae 100644 --- a/docs/Ptsv2paymentsPaymentInformationBankAccount.md +++ b/docs/Ptsv2paymentsPaymentInformationBankAccount.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **_number** | **String** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] **checkNumber** | **String** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **checkImageReferenceNumber** | **String** | Image reference number associated with the check. You cannot include any special characters. | [optional] -**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationCustomer.md b/docs/Ptsv2paymentsPaymentInformationCustomer.md index 6ef4bf23..0880bcf5 100644 --- a/docs/Ptsv2paymentsPaymentInformationCustomer.md +++ b/docs/Ptsv2paymentsPaymentInformationCustomer.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] **id** | **String** | Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md index acab15be..34b48da8 100644 --- a/docs/Ptsv2paymentsProcessingInformation.md +++ b/docs/Ptsv2paymentsProcessingInformation.md @@ -9,17 +9,17 @@ Name | Type | Description | Notes **binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] **capture** | **Boolean** | Indicates whether to also include a capture in the submitted authorization request or not. Possible values: - `true`: Include a capture with an authorization request. - `false`: (default) Do not include a capture with an authorization request. #### Used by **Authorization and Capture** Optional field. | [optional] [default to false] **processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional] -**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] +**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **transactionTimeout** | **Number** | The time-out limit in seconds for the transaction. The time-out limit starts when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is 99999 (about 27 hours). When the transaction times out, the payment system changes the status to abandoned. | [optional] **intentsId** | **String** | Set to the value of the requestID field returned in the order service response. | [optional] **paymentId** | **String** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional] **authorizationOptions** | [**Ptsv2paymentsProcessingInformationAuthorizationOptions**](Ptsv2paymentsProcessingInformationAuthorizationOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md index 6d6a42c0..50d2ebdd 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. | [optional] **panReturnIndicator** | **String** | #### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is  1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request | [optional] -**verbalAuthCode** | **String** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**verbalAuthCode** | **String** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. | [optional] **verbalAuthTransactionId** | **String** | Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). | [optional] **authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. | [optional] **partialAuthIndicator** | **Boolean** | Flag that indicates whether the transaction is enabled for partial authorization. When the request includes this field, this value overrides the information in your account. Possible values: - `true`: Enable the transaction for partial authorization. - `false`: Do not enable the transaction for partial authorization. #### PIN debit Required field for partial authorizations that use PIN debit purchase; otherwise, not used. #### Used by **Authorization** Optional field. #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md index 7fc78886..05d51c9f 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] -**credentialStoredOnFile** | **Boolean** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] +**credentialStoredOnFile** | **Boolean** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] **storedCredentialUsed** | **Boolean** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **true** means the merchant-initiated transaction came from a card that was already stored on file. - **false** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] **merchantInitiatedTransaction** | [**Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md index 516a3dfe..c9ba3660 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | **String** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**reason** | **String** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code | [optional] **previousTransactionId** | **String** | Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] -**originalAuthorizedAmount** | **String** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**originalAuthorizedAmount** | **String** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md b/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md index 0002b468..ff2db31c 100644 --- a/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declineAvsFlags** | **String** | Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member's name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member's name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member's name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member's name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member's name, street address, and postal code do not match.| |O|Partial match: card member's name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member's name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member's name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] -**secCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**secCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] **terminalCity** | **String** | City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **terminalState** | **String** | State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **effectiveDate** | **String** | Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service. | [optional] -**partialPaymentId** | **String** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**partialPaymentId** | **String** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. | [optional] **customerMemo** | **String** | Payment related information. This information is included on the customer's statement. | [optional] -**paymentCategoryCode** | **String** | Flag that indicates whether to process the payment. Use with deferred payments. For details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. | [optional] -**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**fraudScreeningLevel** | **String** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**paymentCategoryCode** | **String** | Flag that indicates whether to process the payment. Use with deferred payments. Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. | [optional] +**settlementMethod** | **String** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] +**fraudScreeningLevel** | **String** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification | [optional] **customerPresent** | **String** | Indicates whether a customer is physically present and whether the customer is enrolling in CyberSource Recurring Billing. Possible values: - `1`: Customer is present and not enrolling. - `2`: Customer is not present and not enrolling. - `3`: Customer is present and enrolling. - `4`: Customer is not present and enrolling. | [optional] diff --git a/docs/Ptsv2paymentsTokenInformation.md b/docs/Ptsv2paymentsTokenInformation.md index c616ff68..fd80aab6 100644 --- a/docs/Ptsv2paymentsTokenInformation.md +++ b/docs/Ptsv2paymentsTokenInformation.md @@ -8,5 +8,6 @@ Name | Type | Description | Notes **paymentInstrument** | [**Ptsv2paymentsTokenInformationPaymentInstrument**](Ptsv2paymentsTokenInformationPaymentInstrument.md) | | [optional] **shippingAddress** | [**Ptsv2paymentsTokenInformationShippingAddress**](Ptsv2paymentsTokenInformationShippingAddress.md) | | [optional] **networkTokenOption** | **String** | Indicates whether a payment network token associated with a TMS token should be used for authorization. This field can contain one of following values: - `ignore`: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token. - `prefer`: (Default) Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number. | [optional] +**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] diff --git a/docs/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md b/docs/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md similarity index 92% rename from docs/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md rename to docs/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md index 9af0995f..fad7ec1b 100644 --- a/docs/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md +++ b/docs/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md @@ -1,4 +1,4 @@ -# CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation +# CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Ptsv2paymentsidOrderInformationAmountDetails.md b/docs/Ptsv2paymentsidOrderInformationAmountDetails.md index 0b7e0f73..9c6354c2 100644 --- a/docs/Ptsv2paymentsidOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsidOrderInformationAmountDetails.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **additionalAmount** | **String** | Additional charges that have to be authorized against a lodging or auto-rental order. This value cannot be negative. You can include a decimal point (.), but no other special characters. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesAggregatorInformation.md b/docs/Ptsv2paymentsidcapturesAggregatorInformation.md index 2c788eca..7ebc9002 100644 --- a/docs/Ptsv2paymentsidcapturesAggregatorInformation.md +++ b/docs/Ptsv2paymentsidcapturesAggregatorInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. | [optional] +**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. | [optional] **subMerchant** | [**Ptsv2paymentsidcapturesAggregatorInformationSubMerchant**](Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesBuyerInformation.md b/docs/Ptsv2paymentsidcapturesBuyerInformation.md index 40b7abdc..136a57be 100644 --- a/docs/Ptsv2paymentsidcapturesBuyerInformation.md +++ b/docs/Ptsv2paymentsidcapturesBuyerInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **gender** | **String** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **String** | language setting of the user | [optional] **personalIdentification** | [**[Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification]**](Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md b/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md index b8a2b9b7..5446815e 100644 --- a/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md +++ b/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**id** | **String** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md b/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md index 95fe93fc..adc5fd30 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **String** | Total discount amount applied to the order. | [optional] **dutyAmount** | **String** | Total charges for any import or export duties included in the order. | [optional] **gratuityAmount** | **String** | Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present. | [optional] @@ -13,10 +13,10 @@ Name | Type | Description | Notes **taxAppliedAfterDiscount** | **String** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total | [optional] **taxAppliedLevel** | **String** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction | [optional] **taxTypeCode** | **String** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] +**foreignAmount** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **String** | Set this field to the converted amount that was returned by the DCC provider. | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) | [optional] +**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **String** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **amexAdditionalAmounts** | [**[Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts]**](Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md) | | [optional] **taxDetails** | [**[Ptsv2paymentsOrderInformationAmountDetailsTaxDetails]**](Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md b/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md index 62f91819..948eae56 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] **county** | **String** | U.S. county if available. | [optional] **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformation.md b/docs/Ptsv2paymentsidcapturesProcessingInformation.md index 82ab58fd..844bbb6f 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformation.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformation.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md b/docs/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md index fe574b53..1ecaa963 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] -**verbalAuthCode** | **String** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. | [optional] +**verbalAuthCode** | **String** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. | [optional] **verbalAuthTransactionId** | **String** | Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). | [optional] diff --git a/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md b/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md index 78717ca9..6001fc9b 100644 --- a/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md +++ b/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **returnReconciliationId** | **String** | A new ID which is created for refund | [optional] **pausedRequestId** | **String** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **String** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [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] diff --git a/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md b/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md index a0f6d611..6c48593f 100644 --- a/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md +++ b/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**Ptsv2paymentsidrefundsPaymentInformationBankAccount**](Ptsv2paymentsidrefundsPaymentInformationBankAccount.md) | | [optional] -**routingNumber** | **String** | Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **String** | Bank routing number. This is also called the _transit number_. | [optional] +**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md b/docs/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md index 1208570e..1c86cecb 100644 --- a/docs/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md +++ b/docs/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **_number** | **String** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] **checkNumber** | **String** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **checkImageReferenceNumber** | **String** | Image reference number associated with the check. You cannot include any special characters. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsProcessingInformation.md b/docs/Ptsv2paymentsidrefundsProcessingInformation.md index 6217aad4..a2ce46ff 100644 --- a/docs/Ptsv2paymentsidrefundsProcessingInformation.md +++ b/docs/Ptsv2paymentsidrefundsProcessingInformation.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes **actionList** | **[String]** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment status. Possible values are one or more of follows: - `AP_REFUND`: Use this when Alternative Payment Refund service is requested. | [optional] **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **recurringOptions** | [**Ptsv2paymentsidrefundsProcessingInformationRecurringOptions**](Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md b/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md index 5fefaf87..b22a0206 100644 --- a/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md +++ b/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md @@ -5,7 +5,7 @@ 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. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **pausedRequestId** | **String** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Ptsv2paymentsidreversalsClientReferenceInformationPartner**](Ptsv2paymentsidreversalsClientReferenceInformationPartner.md) | | [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] diff --git a/docs/Ptsv2paymentsidreversalsProcessingInformation.md b/docs/Ptsv2paymentsidreversalsProcessingInformation.md index e8a47f77..b611350d 100644 --- a/docs/Ptsv2paymentsidreversalsProcessingInformation.md +++ b/docs/Ptsv2paymentsidreversalsProcessingInformation.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **issuer** | [**Ptsv2paymentsIssuerInformation**](Ptsv2paymentsIssuerInformation.md) | | [optional] **actionList** | **[String]** | Array of actions (one or more) to be included in the reversal Possible value: - `AP_AUTH_REVERSAL`: Use this when you want to reverse an Alternative Payment Authorization. | [optional] diff --git a/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md b/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md index e9ea33f4..5f467d49 100644 --- a/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md +++ b/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationAmountDetails.md b/docs/Ptsv2payoutsOrderInformationAmountDetails.md index 1e92a103..a573b034 100644 --- a/docs/Ptsv2payoutsOrderInformationAmountDetails.md +++ b/docs/Ptsv2payoutsOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **surcharge** | [**Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] diff --git a/docs/Ptsv2payoutsRecipientInformation.md b/docs/Ptsv2payoutsRecipientInformation.md index 3759df63..d9a9a190 100644 --- a/docs/Ptsv2payoutsRecipientInformation.md +++ b/docs/Ptsv2payoutsRecipientInformation.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **firstName** | **String** | First name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**middleInitial** | **String** | Middle Initial of recipient. Required only for FDCCompass. | [optional] **middleName** | **String** | Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **lastName** | **String** | Last name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] **address1** | **String** | Recipient address information. Required only for FDCCompass. | [optional] @@ -13,6 +12,5 @@ Name | Type | Description | Notes **country** | **String** | Recipient country code. Required only for FDCCompass. | [optional] **postalCode** | **String** | Recipient postal code. Required only for FDCCompass. | [optional] **phoneNumber** | **String** | Recipient phone number. Required only for FDCCompass. | [optional] -**dateOfBirth** | **String** | Recipient date of birth in YYYYMMDD format. Required only for FDCCompass. | [optional] diff --git a/docs/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md b/docs/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md index 2aaef312..1b2bc594 100644 --- a/docs/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md +++ b/docs/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] diff --git a/docs/PushFunds201ResponseOrderInformationAmountDetails.md b/docs/PushFunds201ResponseOrderInformationAmountDetails.md index 8e4e7e26..a9b96279 100644 --- a/docs/PushFunds201ResponseOrderInformationAmountDetails.md +++ b/docs/PushFunds201ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.994 Chase Paymentech: .01-9999999999.99 | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. | [optional] **currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes | **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/PushFunds201ResponseProcessorInformation.md b/docs/PushFunds201ResponseProcessorInformation.md index 6b740f2e..82c676e1 100644 --- a/docs/PushFunds201ResponseProcessorInformation.md +++ b/docs/PushFunds201ResponseProcessorInformation.md @@ -5,9 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionId** | **Number** | Network transaction identifier (TID). This value can be used to identify a specific transaction when you are discussing the transaction with your processor. | [optional] **responseCode** | **String** | Transaction status from the processor. | [optional] -**approvalCode** | **String** | Issuer-generated approval code for the transaction. | [optional] -**systemTraceAuditNumber** | **String** | System audit number. Returned by authorization and incremental authorization services. Visa Platform Connect 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] -**retrievalReferenceNumber** | **String** | Unique reference number returned by the processor that identifies the transaction at the network. Supported by Mastercard Send | [optional] +**systemTraceAuditNumber** | **String** | System audit number. Returned by authorization and incremental authorization services. | [optional] +**retrievalReferenceNumber** | **String** | Unique reference number returned by the processor that identifies the transaction at the network. | [optional] diff --git a/docs/PushFunds400Response.md b/docs/PushFunds400Response.md index 2f8e0bc5..07459acb 100644 --- a/docs/PushFunds400Response.md +++ b/docs/PushFunds400Response.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | **String** | Possible values: - INVALID_REQUEST | [optional] **reason** | **String** | The reason of the status. Possible values: - INVALID_DATA - MISSING_FIELD - INVALID_MERCHANT_CONFIGURATION - INVALID_REQUEST - INVALID_PAYMENT_ID | [optional] -**message** | **String** | The detail message related to the status and reason listed above. Possible values: - Declined - One or more fields in the request contains invalid data - Declined - The request is missing one or more fields - Declined - There is a problem with your CyberSource merchant configuration. | [optional] +**message** | **String** | The detail message related to the status and reason listed above. Possible values: - One or more fields in the request contains invalid data. - The request is missing one or more required fields. - Declined - There is a problem with your CyberSource merchant configuration. | [optional] **details** | [**[PushFunds400ResponseDetails]**](PushFunds400ResponseDetails.md) | | [optional] diff --git a/docs/PushFundsRequest.md b/docs/PushFundsRequest.md index e814e910..cfd3992d 100644 --- a/docs/PushFundsRequest.md +++ b/docs/PushFundsRequest.md @@ -6,12 +6,7 @@ Name | Type | Description | Notes **clientReferenceInformation** | [**Ptsv1pushfundstransferClientReferenceInformation**](Ptsv1pushfundstransferClientReferenceInformation.md) | | [optional] **orderInformation** | [**Ptsv1pushfundstransferOrderInformation**](Ptsv1pushfundstransferOrderInformation.md) | | **processingInformation** | [**Ptsv1pushfundstransferProcessingInformation**](Ptsv1pushfundstransferProcessingInformation.md) | | -**processingOptions** | [**Ptsv1pushfundstransferProcessingOptions**](Ptsv1pushfundstransferProcessingOptions.md) | | [optional] **recipientInformation** | [**Ptsv1pushfundstransferRecipientInformation**](Ptsv1pushfundstransferRecipientInformation.md) | | [optional] -**senderInformation** | [**Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | -**aggregatorInformation** | [**Ptsv1pushfundstransferAggregatorInformation**](Ptsv1pushfundstransferAggregatorInformation.md) | | [optional] -**merchantDefinedInformation** | [**Ptsv1pushfundstransferMerchantDefinedInformation**](Ptsv1pushfundstransferMerchantDefinedInformation.md) | | [optional] -**merchantInformation** | [**Ptsv1pushfundstransferMerchantInformation**](Ptsv1pushfundstransferMerchantInformation.md) | | [optional] -**pointOfServiceInformation** | [**Ptsv1pushfundstransferPointOfServiceInformation**](Ptsv1pushfundstransferPointOfServiceInformation.md) | | [optional] +**senderInformation** | [**Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | [optional] diff --git a/docs/Rbsv1plansOrderInformationAmountDetails.md b/docs/Rbsv1plansOrderInformationAmountDetails.md index 1f978d23..3201bb3f 100644 --- a/docs/Rbsv1plansOrderInformationAmountDetails.md +++ b/docs/Rbsv1plansOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | **billingAmount** | **String** | Billing amount for the billing period. | **setupFee** | **String** | Subscription setup fee | [optional] diff --git a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md index 9795b77c..c940e8af 100644 --- a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md +++ b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**addressType** | **String** | Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/) #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. | [optional] +**addressType** | **String** | Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. | [optional] **barCode** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md) | | [optional] **applicableRegion** | **String** | Value can be - Canada - US - International The values of errorCode and statusCode mean different things depending on the applicable region. Refer to the guide for more info. | [optional] **errorCode** | **String** | Four-character error code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion. | [optional] diff --git a/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md index bd2f9b96..39291740 100644 --- a/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **acsRenderingType** | **String** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] **acsTransactionId** | **String** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] **acsUrl** | **String** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] -**authenticationPath** | **String** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**authenticationPath** | **String** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. | [optional] **authorizationPayload** | **String** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] **authenticationType** | **String** | Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled 20 - OTP hosted at merchant end. (Rupay S2S flow) **NOTE**: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time. | [optional] **authenticationTransactionId** | **String** | Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. | [optional] @@ -30,7 +30,7 @@ Name | Type | Description | Notes **networkScore** | **String** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] **pareq** | **String** | Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64. | [optional] **paresStatus** | **String** | Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated. | [optional] -**proofXml** | **String** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] +**proofXml** | **String** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] **proxyPan** | **String** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdkTransactionId** | **String** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signedParesStatusReason** | **String** | Provides additional information as to why the PAResStatus has a specific value. | [optional] @@ -39,7 +39,7 @@ Name | Type | Description | Notes **threeDSServerTransactionId** | **String** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucafAuthenticationData** | **String** | AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request. | [optional] **ucafCollectionIndicator** | **String** | For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication. | [optional] -**veresEnrolled** | **String** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**veresEnrolled** | **String** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. | [optional] **whiteListStatusSource** | **String** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] **xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional] **directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional] diff --git a/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md b/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md index 71e89744..c7570eb4 100644 --- a/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md b/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md index 3ae0dd65..ed82cf02 100644 --- a/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md +++ b/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**binCountry** | **String** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**issuer** | **String** | Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**scheme** | **String** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bin** | **String** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**binCountry** | **String** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. | [optional] +**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **String** | Name of the bank or entity that issued the card account. | [optional] +**scheme** | **String** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. | [optional] +**bin** | **String** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. | [optional] diff --git a/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md b/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md index 3d3a169d..9355b80d 100644 --- a/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md +++ b/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] diff --git a/docs/Riskv1authenticationsBuyerInformation.md b/docs/Riskv1authenticationsBuyerInformation.md index e2bc0cee..d64dabdb 100644 --- a/docs/Riskv1authenticationsBuyerInformation.md +++ b/docs/Riskv1authenticationsBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **personalIdentification** | [**[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | This array contains detailed information about the buyer's form of persoanl identification. | [optional] **mobilePhone** | **Number** | Cardholder's mobile phone number. **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | **workPhone** | **Number** | Cardholder's work phone number. | [optional] diff --git a/docs/Riskv1authenticationsOrderInformationAmountDetails.md b/docs/Riskv1authenticationsOrderInformationAmountDetails.md index 1172152d..bb924ed9 100644 --- a/docs/Riskv1authenticationsOrderInformationAmountDetails.md +++ b/docs/Riskv1authenticationsOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | diff --git a/docs/Riskv1authenticationsOrderInformationBillTo.md b/docs/Riskv1authenticationsOrderInformationBillTo.md index 017702f8..b9aa47d8 100644 --- a/docs/Riskv1authenticationsOrderInformationBillTo.md +++ b/docs/Riskv1authenticationsOrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | diff --git a/docs/Riskv1decisionsBuyerInformation.md b/docs/Riskv1decisionsBuyerInformation.md index b29732b4..e67b51fe 100644 --- a/docs/Riskv1decisionsBuyerInformation.md +++ b/docs/Riskv1decisionsBuyerInformation.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **username** | **String** | Specifies the customer account user name. | [optional] -**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] +**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **personalIdentification** | [**[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] diff --git a/docs/Riskv1decisionsConsumerAuthenticationInformation.md b/docs/Riskv1decisionsConsumerAuthenticationInformation.md index cf243a95..01eca0a1 100644 --- a/docs/Riskv1decisionsConsumerAuthenticationInformation.md +++ b/docs/Riskv1decisionsConsumerAuthenticationInformation.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **authenticationTransactionId** | **String** | Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. **Note**: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service. | [optional] **transactionFlowIndicator** | **Number** | This field is only applicable to Rupay and is optional. Merchant will have to pass a valid value from 01 through 07 which indicates the transaction flow. Below are the possible values. 01:NW- Transaction performed at domestic merchant. 02:TW- Transaction performed at domestic merchant along with Token provisioning. 03:IT- Transaction performed at International merchant. 04:AT- Authentication Transaction Only. 05:AW- Authentication transaction for provisioning. 06:DI- Domestic InApp Transaction. 07:II- International InApp transaction. 08:GC- Guest Checkout 09:ST- SI Authentication Transaction only 10:SW- SI Authorization along with token provisioning | [optional] **challengeCancelCode** | **String** | An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK | [optional] -**challengeCode** | **String** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) | [optional] +**challengeCode** | **String** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. | [optional] **challengeStatus** | **String** | The `consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used. | [optional] **customerCardAlias** | **String** | An alias that uniquely identifies the customer's account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings. | [optional] **decoupledAuthenticationIndicator** | **String** | Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N | [optional] diff --git a/docs/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md index fe43e3b0..299e8b4f 100644 --- a/docs/Riskv1decisionsOrderInformationAmountDetails.md +++ b/docs/Riskv1decisionsOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | **totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] diff --git a/docs/Riskv1decisionsOrderInformationBillTo.md b/docs/Riskv1decisionsOrderInformationBillTo.md index 9ab182b3..17c3a1f3 100644 --- a/docs/Riskv1decisionsOrderInformationBillTo.md +++ b/docs/Riskv1decisionsOrderInformationBillTo.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] diff --git a/docs/Riskv1decisionsProcessorInformationCardVerification.md b/docs/Riskv1decisionsProcessorInformationCardVerification.md index cc852f76..38a1f464 100644 --- a/docs/Riskv1decisionsProcessorInformationCardVerification.md +++ b/docs/Riskv1decisionsProcessorInformationCardVerification.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**resultCode** | **String** | CVN result code. | [optional] diff --git a/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md index 64745e06..ba95e8b1 100644 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md @@ -14,6 +14,6 @@ Name | Type | Description | Notes **company** | [**Riskv1exportcomplianceinquiriesOrderInformationBillToCompany**](Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md) | | [optional] **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | diff --git a/docs/Riskv1liststypeentriesOrderInformationBillTo.md b/docs/Riskv1liststypeentriesOrderInformationBillTo.md index aaa1b4fa..ed2a17a0 100644 --- a/docs/Riskv1liststypeentriesOrderInformationBillTo.md +++ b/docs/Riskv1liststypeentriesOrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **emailDomain** | **String** | Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. | [optional] diff --git a/docs/TmsEmbeddedInstrumentIdentifier.md b/docs/TmsEmbeddedInstrumentIdentifier.md index fe7a38f6..8692283d 100644 --- a/docs/TmsEmbeddedInstrumentIdentifier.md +++ b/docs/TmsEmbeddedInstrumentIdentifier.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **String** | The Id of the Instrument Identifier Token. | [optional] **_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 | [optional] -**tokenProvisioningInformation** | [**TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/TmsEmbeddedInstrumentIdentifierTokenizedCard.md b/docs/TmsEmbeddedInstrumentIdentifierTokenizedCard.md index 577f4f6b..a0f4b871 100644 --- a/docs/TmsEmbeddedInstrumentIdentifierTokenizedCard.md +++ b/docs/TmsEmbeddedInstrumentIdentifierTokenizedCard.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | The network token card association brand Possible Values: - visa - mastercard - americanexpress | [optional] +**source** | **String** | This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data. Possible Values: - TOKEN - ISSUER - ONFILE | [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 provision was unsuccessful. | [optional] **enrollmentId** | **String** | Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully. | [optional] **tokenReferenceId** | **String** | Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully. | [optional] diff --git a/docs/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md index 516d6d01..166c00fb 100644 --- a/docs/TransactionBatchesApi.md +++ b/docs/TransactionBatchesApi.md @@ -67,7 +67,7 @@ No authorization required Get Individual Batch File -Provide the search range +This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id ### Example ```javascript @@ -113,7 +113,7 @@ No authorization required Get a List of Batch Files -Provide the search range +Provide the date and time search range to get a list of Batch Files ready for settlement ### Example ```javascript diff --git a/docs/TssV2TransactionsGet200ResponseBuyerInformation.md b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md index dbc27c07..ad1cf5bd 100644 --- a/docs/TssV2TransactionsGet200ResponseBuyerInformation.md +++ b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**hashedPassword** | **String** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md index e92e298f..e6b212f1 100644 --- a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md +++ b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**eciRaw** | **String** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **String** | Raw electronic commerce indicator (ECI). | [optional] **cavv** | **String** | Cardholder authentication verification value (CAVV). | [optional] -**xid** | **String** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**xid** | **String** | Transaction identifier. | [optional] **transactionId** | **String** | Payer auth Transaction identifier. | [optional] **strongAuthentication** | [**TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md index ac10800a..d34fba58 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **taxAmount** | **String** | Total tax amount for all the items in the order. | [optional] -**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. | [optional] +**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **surcharge** | [**Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md index 1b8e4e6f..17d8fa20 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **locality** | **String** | Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **administrativeArea** | **String** | 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] -**company** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**company** | **String** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **title** | **String** | Title. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md index 0a287735..0a1db62f 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**routingNumber** | **String** | Bank routing number. This is also called the transit number. For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**branchCode** | **String** | Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. For all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bankCode** | **String** | Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **String** | Bank routing number. This is also called the transit number. | [optional] +**branchCode** | **String** | Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **String** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] +**bankCode** | **String** | Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. | [optional] +**iban** | **String** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] **account** | [**TssV2TransactionsGet200ResponsePaymentInformationBankAccount**](TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md) | | [optional] **mandate** | [**TssV2TransactionsGet200ResponsePaymentInformationBankMandate**](TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md index 14826fc2..e58662bf 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **checkNumber** | **String** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **type** | **String** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **name** | **String** | Name used on the bank account. You can use this field only when scoring a direct debit transaction | [optional] -**checkDigit** | **String** | Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. For all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**checkDigit** | **String** | Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. | [optional] +**encoderId** | **String** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md index 8d169fcc..99c7526c 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] **id** | **String** | Unique identifier for the Customer token that was created as part of a bundled TOKEN_CREATE action. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformation.md b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md index f8d5fda3..b8507298 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes **binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional] **paymentSolution** | **String** | Type of digital payment solution for the transaction. | [optional] -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] +**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] +**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] **authorizationOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] **bankTransferOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional] **captureOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions**](TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md index d1e30172..b78cc26c 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. | [optional] **authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. | [optional] **extendAuthIndicator** | **String** | Flag that indicates whether the transaction is an extended authorization. | [optional] **cardVerificationIndicator** | **Boolean** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md index fe5ecbbb..37cc7841 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**email** | **String** | Mapped Electronic Verification response code for the customer's email address. | [optional] **emailRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] **name** | **String** | #### Visa Platform Connect Mapped Electronic Verification response code for the customer's name. Valid values : 'Y' Yes, the data Matches 'N' No Match 'O' Partial Match | [optional] **nameRaw** | **String** | #### Visa Platform Connect Raw Electronic Verification response code from the processor for the customer's name. Valid values : '01' Match '50' Partial Match '99' No Match | [optional] -**phoneNumber** | **String** | Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**phoneNumber** | **String** | Mapped Electronic Verification response code for the customer's phone number. | [optional] **phoneNumberRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] -**street** | **String** | Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**street** | **String** | Mapped Electronic Verification response code for the customer's street address. | [optional] **streetRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] -**postalCode** | **String** | Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**postalCode** | **String** | Mapped Electronic Verification response code for the customer's postal code. | [optional] **postalCodeRaw** | **String** | Raw Electronic Verification response code from the processor for the customer's postal code. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md index 48bad0d5..bef0a3b0 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md index 041db6e3..9672e540 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**xid** | **String** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**xid** | **String** | Transaction identifier. | [optional] **transactionId** | **String** | Payer auth Transaction identifier. | [optional] -**eciRaw** | **String** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **String** | Raw electronic commerce indicator (ECI). | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md index d031c40c..3683ae00 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **firstName** | **String** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **String** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **address1** | **String** | Payment card billing street address as it appears on the credit card issuer's records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **String** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **String** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md index 84e7bace..309c0af5 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] -**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] +**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] diff --git a/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md b/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md index 39416db4..d06f9c31 100644 --- a/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md +++ b/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **voidAmount** | **String** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] diff --git a/docs/Vasv2taxBuyerInformation.md b/docs/Vasv2taxBuyerInformation.md index ec1b7fa1..4c40dd41 100644 --- a/docs/Vasv2taxBuyerInformation.md +++ b/docs/Vasv2taxBuyerInformation.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] diff --git a/docs/Vasv2taxClientReferenceInformation.md b/docs/Vasv2taxClientReferenceInformation.md index 9f2d223b..1ac6aeae 100644 --- a/docs/Vasv2taxClientReferenceInformation.md +++ b/docs/Vasv2taxClientReferenceInformation.md @@ -5,6 +5,6 @@ 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. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] diff --git a/docs/Vasv2taxidClientReferenceInformation.md b/docs/Vasv2taxidClientReferenceInformation.md index e064309c..5c60fe72 100644 --- a/docs/Vasv2taxidClientReferenceInformation.md +++ b/docs/Vasv2taxidClientReferenceInformation.md @@ -4,7 +4,7 @@ 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. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] -**comments** | **String** | Comments | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**Vasv2taxidClientReferenceInformationPartner**](Vasv2taxidClientReferenceInformationPartner.md) | | [optional] diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 324c0e9b..85d2f09b 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -97,11 +97,11 @@ "description": "REST APIs for Risk Services" }, { - "name": "Pull_Funds", + "name": "Pull Funds", "description": "Cybersource Payouts Funds Transfer REST API for Account Funding Transaction (AFT)\n" }, { - "name": "Push_Funds", + "name": "Push Funds", "description": "A payout enables an originator to send funds on behalf of itself, merchants, or customers to credit card\naccounts using an Original Credit Transaction (OCT). An originator is a merchant, government entity, or\ncorporation with a merchant account from an acquiring bank.\n" }, { @@ -407,7 +407,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -485,17 +485,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" }, "paymentSolution": { "type": "string", @@ -510,7 +510,7 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "purchaseLevel": { "type": "string", @@ -535,7 +535,7 @@ "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -553,7 +553,7 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "panReturnIndicator": { "type": "string", @@ -563,7 +563,7 @@ "verbalAuthCode": { "type": "string", "maxLength": 7, - "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n" }, "verbalAuthTransactionId": { "type": "string", @@ -613,7 +613,7 @@ }, "credentialStoredOnFile": { "type": "boolean", - "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" + "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" }, "storedCredentialUsed": { "type": "boolean", @@ -625,7 +625,7 @@ "reason": { "type": "string", "maxLength": 1, - "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n#### All Processors\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n" }, "previousTransactionId": { "type": "string", @@ -635,7 +635,7 @@ "originalAuthorizedAmount": { "type": "string", "maxLength": 61, - "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n\nSee \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization\nUsing the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n" } } } @@ -736,7 +736,7 @@ "secCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" }, "terminalCity": { "type": "string", @@ -756,7 +756,7 @@ "partialPaymentId": { "type": "string", "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\n" }, "customerMemo": { "type": "string", @@ -766,17 +766,17 @@ "paymentCategoryCode": { "type": "string", "maxLength": 1, - "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\nFor details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n\nPossible values:\n- `0`: Standard debit with immediate payment (default).\n- `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- `2`: For deferred payments, indicates notification to initiate payment.\n\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n" + "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\n\nPossible values:\n- `0`: Standard debit with immediate payment (default).\n- `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- `2`: For deferred payments, indicates notification to initiate payment.\n\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n" }, "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" }, "fraudScreeningLevel": { "type": "string", "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n" }, "customerPresent": { "type": "string", @@ -1153,7 +1153,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -1226,7 +1226,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -1241,23 +1241,23 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } }, "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "code": { "type": "string", @@ -1369,7 +1369,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "subTotalAmount": { "type": "string", @@ -1379,7 +1379,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -1424,12 +1424,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -1439,7 +1439,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -1478,7 +1478,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -1655,7 +1655,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -1747,7 +1747,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "emailDomain": { "type": "string", @@ -2290,17 +2290,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "companyTaxId": { "type": "string", @@ -2314,16 +2314,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -2335,7 +2335,7 @@ "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" }, "gender": { "type": "string", @@ -2729,12 +2729,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -2819,32 +2819,32 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" }, "paresStatus": { "type": "string", "maxLength": 1, - "description": "Payer authentication response status.\n\nFor details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Payer authentication response status.\n" }, "veresEnrolled": { "type": "string", "maxLength": 1, - "description": "Verification response enrollment status.\n\nFor details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Verification response enrollment status.\n" }, "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "ucafCollectionIndicator": { "type": "string", "maxLength": 1, - "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\nFor details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014UCAF Collection Indicator\n" + "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014UCAF Collection Indicator\n" }, "ucafAuthenticationData": { "type": "string", "maxLength": 32, - "description": "Universal cardholder authentication field (UCAF) data.\n\nFor details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Universal cardholder authentication field (UCAF) data.\n" }, "strongAuthentication": { "type": "object", @@ -2956,7 +2956,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -3317,12 +3317,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -4533,6 +4533,19 @@ "networkTokenOption": { "type": "string", "description": "Indicates whether a payment network token associated with a TMS token should be used for authorization. This field can contain one of following values:\n\n- `ignore`: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token.\n- `prefer`: (Default) Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number.\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } } } }, @@ -5093,12 +5106,12 @@ "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" }, "fraudScreeningLevel": { "type": "string", "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n" } } }, @@ -5191,7 +5204,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" }, "resultCodeRaw": { "type": "string", @@ -5226,7 +5239,7 @@ "code": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's name.\n\nFor details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's name.\n" }, "codeRaw": { "type": "string", @@ -5236,7 +5249,7 @@ "email": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's email address.\n\nFor details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's email address.\n" }, "emailRaw": { "type": "string", @@ -5246,7 +5259,7 @@ "phoneNumber": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's phone number.\n\nFor details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's phone number.\n" }, "phoneNumberRaw": { "type": "string", @@ -5256,7 +5269,7 @@ "postalCode": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's postal code.\n\nFor details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's postal code.\n" }, "postalCodeRaw": { "type": "string", @@ -5266,7 +5279,7 @@ "street": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's street address.\n\nFor details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's street address.\n" }, "streetRaw": { "type": "string", @@ -5321,12 +5334,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -5756,14 +5769,14 @@ "correctedAccountNumber": { "type": "string", "maxLength": 17, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, "correctedRoutingNumber": { "type": "string", "maxLength": 9, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, @@ -5772,7 +5785,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -5822,27 +5835,27 @@ "scheme": { "type": "string", "maxLength": 255, - "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n" }, "bin": { "type": "string", "maxLength": 255, - "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n" }, "accountType": { "type": "string", "maxLength": 255, - "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n" }, "issuer": { "type": "string", "maxLength": 255, - "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Name of the bank or entity that issued the card account.\n" }, "binCountry": { "type": "string", "maxLength": 255, - "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n" }, "eWallet": { "type": "object", @@ -5900,12 +5913,12 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -6354,17 +6367,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "personalIdentification": { "type": "array", @@ -6373,16 +6386,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -6779,7 +6792,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -6936,7 +6949,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -6976,7 +6989,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -10110,7 +10123,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -10343,12 +10356,12 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -10578,7 +10591,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -10633,12 +10646,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -10664,12 +10677,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -10868,7 +10881,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11168,7 +11181,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -11218,12 +11231,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11249,12 +11262,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -11439,7 +11452,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11679,7 +11692,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -11736,12 +11749,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -11774,12 +11787,12 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "verbalAuthCode": { "type": "string", "maxLength": 7, - "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n" }, "verbalAuthTransactionId": { "type": "string", @@ -11846,7 +11859,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -11896,12 +11909,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -11946,12 +11959,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -11961,7 +11974,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -11976,7 +11989,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -12073,7 +12086,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -12150,7 +12163,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "phoneNumber": { "type": "string", @@ -12510,17 +12523,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -12540,7 +12553,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -12691,12 +12704,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -12784,12 +12797,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -14251,7 +14264,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "processorTransactionFee": { "type": "string", @@ -14552,7 +14565,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -14616,12 +14629,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -14749,7 +14762,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -14766,16 +14779,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -14872,7 +14885,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -14969,12 +14982,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -15019,12 +15032,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -15034,7 +15047,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -15049,7 +15062,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -15146,7 +15159,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -15223,7 +15236,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "phoneNumber": { "type": "string", @@ -15471,17 +15484,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -15501,7 +15514,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -15632,12 +15645,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -15720,12 +15733,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -16888,7 +16901,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -16926,12 +16939,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -16965,12 +16978,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -17205,7 +17218,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -17269,12 +17282,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -17402,7 +17415,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -17419,16 +17432,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -17525,7 +17538,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -17622,12 +17635,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -17672,12 +17685,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -17687,7 +17700,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -17702,7 +17715,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -17799,7 +17812,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -17876,7 +17889,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "phoneNumber": { "type": "string", @@ -18124,17 +18137,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -18154,7 +18167,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -18285,12 +18298,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -18373,12 +18386,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -19541,7 +19554,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -19579,12 +19592,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -19618,12 +19631,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -19832,7 +19845,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -19879,7 +19892,7 @@ "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "processorId": { "type": "string", @@ -19899,12 +19912,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -19957,7 +19970,7 @@ "secCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" }, "terminalCity": { "type": "string", @@ -19977,12 +19990,12 @@ "partialPaymentId": { "type": "string", "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\n" }, "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" } } }, @@ -20132,7 +20145,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -20149,16 +20162,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -20255,7 +20268,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -20352,12 +20365,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -20402,12 +20415,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -20417,7 +20430,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -20432,7 +20445,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -20529,7 +20542,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -20606,7 +20619,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "phoneNumber": { "type": "string", @@ -20854,17 +20867,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -20884,7 +20897,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -21015,12 +21028,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -21267,12 +21280,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -22534,7 +22547,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -22547,7 +22560,7 @@ "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" } } }, @@ -22591,12 +22604,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -22623,14 +22636,14 @@ "correctedAccountNumber": { "type": "string", "maxLength": 17, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, "correctedRoutingNumber": { "type": "string", "maxLength": 9, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, @@ -22639,7 +22652,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -22707,12 +22720,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -23351,7 +23364,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -23433,12 +23446,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -23563,7 +23576,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -23816,7 +23829,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -23898,12 +23911,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24028,7 +24041,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -24210,7 +24223,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -24292,12 +24305,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24422,7 +24435,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -24604,7 +24617,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -24686,12 +24699,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24816,7 +24829,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -25018,7 +25031,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -25095,12 +25108,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -25196,7 +25209,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -25322,7 +25335,7 @@ "/pts/v1/transaction-batches": { "get": { "summary": "Get a List of Batch Files", - "description": "Provide the search range", + "description": "Provide the date and time search range to get a list of Batch Files ready for settlement", "tags": [ "TransactionBatches" ], @@ -25626,7 +25639,7 @@ "/pts/v1/transaction-batches/{id}": { "get": { "summary": "Get Individual Batch File", - "description": "Provide the search range", + "description": "This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id", "tags": [ "TransactionBatches" ], @@ -26222,7 +26235,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -26383,7 +26396,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -26457,7 +26470,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "verificationStatus": { "type": "string", @@ -26659,7 +26672,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -26706,7 +26719,7 @@ "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -26931,12 +26944,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -26986,7 +26999,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "firstName": { "type": "string", @@ -27169,7 +27182,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -27820,7 +27833,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -27867,7 +27880,7 @@ "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -28092,12 +28105,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -28147,7 +28160,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "firstName": { "type": "string", @@ -28325,7 +28338,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -29146,7 +29159,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -29304,12 +29317,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -29359,7 +29372,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "firstName": { "type": "string", @@ -30090,7 +30103,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", @@ -30156,12 +30169,12 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -30399,7 +30412,7 @@ "properties": { "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "account": { "type": "object", @@ -30412,7 +30425,7 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } } @@ -30580,12 +30593,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -30605,7 +30618,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -30740,7 +30753,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -30765,7 +30778,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -30969,12 +30982,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -31367,7 +31380,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -31544,7 +31557,7 @@ "properties": { "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "account": { "type": "object", @@ -31557,7 +31570,7 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } } @@ -31725,12 +31738,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -31750,7 +31763,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)\n" + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -31885,7 +31898,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -31910,7 +31923,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -32114,12 +32127,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -32519,7 +32532,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -33114,7 +33127,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -33180,6 +33193,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -34005,7 +34024,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -34071,6 +34090,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -35214,7 +35239,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -35280,6 +35305,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -36420,7 +36451,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -36486,6 +36517,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -37320,7 +37357,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -37386,6 +37423,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -41750,7 +41793,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -41816,6 +41859,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -42389,7 +42438,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -42455,6 +42504,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -43561,7 +43616,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -43627,6 +43682,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -44548,7 +44609,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -44614,6 +44675,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -45498,7 +45565,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -45564,6 +45631,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -46133,7 +46206,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -46199,6 +46272,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -47619,7 +47698,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -47685,6 +47764,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -48240,7 +48325,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -48306,6 +48391,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -49262,7 +49353,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -49328,6 +49419,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -50203,7 +50300,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -50269,6 +50366,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -50838,7 +50941,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -50904,6 +51007,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -51889,7 +51998,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -51955,6 +52064,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -52203,7 +52318,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -52269,6 +52384,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -52505,7 +52626,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -52571,6 +52692,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -53153,7 +53280,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -53219,6 +53346,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -53788,7 +53921,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -53854,6 +53987,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -54116,7 +54255,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -54182,6 +54321,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -55635,7 +55780,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -55701,6 +55846,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -56272,7 +56423,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -56338,6 +56489,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "type": "string", + "readOnly": true, + "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n", + "example": "ONFILE" + }, "state": { "type": "string", "readOnly": true, @@ -57594,7 +57751,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" } } } @@ -57682,7 +57839,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -57711,7 +57868,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -57726,23 +57883,23 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } }, "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "code": { "type": "string", @@ -57772,7 +57929,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", @@ -58072,7 +58229,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "postalCode": { "type": "string", @@ -58095,7 +58252,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "username": { "type": "string", @@ -58105,12 +58262,12 @@ "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "personalIdentification": { "type": "array", @@ -58119,16 +58276,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -58623,7 +58780,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -59312,27 +59469,27 @@ "binCountry": { "type": "string", "maxLength": 255, - "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n" }, "accountType": { "type": "string", "maxLength": 255, - "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n" }, "issuer": { "type": "string", "maxLength": 255, - "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Name of the bank or entity that issued the card account.\n" }, "scheme": { "type": "string", "maxLength": 255, - "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n" }, "bin": { "type": "string", "maxLength": 255, - "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n" } } }, @@ -59375,7 +59532,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -59404,7 +59561,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -59545,7 +59702,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -59585,7 +59742,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -61013,12 +61170,12 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } }, @@ -61322,7 +61479,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "postalCode": { "type": "string", @@ -61456,7 +61613,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -61506,7 +61663,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "personalIdentification": { "description": "This array contains detailed information about the buyer's form of persoanl identification.", @@ -61516,16 +61673,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -61790,7 +61947,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -62195,7 +62352,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -62224,7 +62381,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -62365,7 +62522,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -62405,7 +62562,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -62930,12 +63087,12 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -63031,7 +63188,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -63580,7 +63737,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "emailDomain": { "type": "string", @@ -63781,16 +63938,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -65293,7 +65450,7 @@ "addressType": { "type": "string", "maxLength": 255, - "description": "Contains the record type of the postal code with which the address was matched.\n\n#### U.S. Addresses\nDepending on the quantity and quality of the address information provided,\nthis field contains one or two characters:\n\n- One character: sufficient correct information was provided to result in accurate matching.\n- Two characters: standardization would provide a better address if more or better\ninput address information were available. The second character is D (default).\n\nBlank fields are unassigned. When an address cannot be standardized, how the input\ndata was parsed determines the address type. In this case, standardization may indicate a street, rural route,\nhighway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n#### All Other Countries\nThis field contains one of the following values:\n- P: Post.\n- S: Street.\n- x: Unknown.\n" + "description": "Contains the record type of the postal code with which the address was matched.\n\n#### U.S. Addresses\nDepending on the quantity and quality of the address information provided,\nthis field contains one or two characters:\n\n- One character: sufficient correct information was provided to result in accurate matching.\n- Two characters: standardization would provide a better address if more or better\ninput address information were available. The second character is D (default).\n\nBlank fields are unassigned. When an address cannot be standardized, how the input\ndata was parsed determines the address type. In this case, standardization may indicate a street, rural route,\nhighway contract, general delivery, or PO box. \n\n#### All Other Countries\nThis field contains one of the following values:\n- P: Post.\n- S: Street.\n- x: Unknown.\n" }, "barCode": { "type": "object", @@ -66016,7 +66173,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" } } }, @@ -66790,12 +66947,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "surcharge": { "type": "object", @@ -66934,11 +67091,6 @@ "maxLength": 35, "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "description": "Middle Initial of recipient. Required only for FDCCompass.\n" - }, "middleName": { "type": "string", "maxLength": 35, @@ -66967,6 +67119,7 @@ "country": { "type": "string", "maxLength": 2, + "minLength": 2, "description": "Recipient country code. Required only for FDCCompass." }, "postalCode": { @@ -66978,12 +67131,6 @@ "type": "string", "maxLength": 20, "description": "Recipient phone number. Required only for FDCCompass." - }, - "dateOfBirth": { - "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass." } } }, @@ -67211,7 +67358,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -67531,12 +67678,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -67862,7 +68009,7 @@ "summary": "Process a Push Funds Transfer", "description": "Receive funds using an Original Credit Transaction (OCT).\n", "tags": [ - "Push_Funds" + "Push Funds" ], "operationId": "createPushFundsTransfer", "x-devcenter-metaData": { @@ -67881,8 +68028,7 @@ "type": "object", "required": [ "orderInformation", - "processingInformation", - "senderInformation" + "processingInformation" ], "properties": { "clientReferenceInformation": { @@ -67892,21 +68038,25 @@ "code": { "type": "string", "maxLength": 50, + "x-nullable": true, "description": "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.\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.\n" }, "applicationVersion": { "type": "string", "maxLength": 50, + "x-nullable": true, "description": "Version of the CyberSource application or integration used for a transaction.\n" }, "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.\n" } } @@ -67927,27 +68077,24 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n\nThe disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant\u202fcurrency\u202fexponent. For example, a US Dollar $53 amount is a value of 5300.\n\nProcessor Amount Ranges:\nVisa Platform Connect: .01-9999999999.99\n\nMastercard Send: 1-9999999999.99\n\nFDC Compass: .01- 9999999999.99\n\nChase Paymentech: .01-9999999999.99\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n" }, "currency": { "type": "string", - "maxLength": 3, - "description": "Use a 3-character alpha currency code for currency of the sender.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n\nCurrency must be supported by the processor.\n" - } - } - }, - "isCryptocurrencyPurchase": { - "type": "string", - "maxLength": 5, - "description": "This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false\n" - }, - "surcharge": { - "type": "object", - "properties": { - "amount": { + "pattern": "^(\\s{0,3}|.{3})$", + "description": "Use a 3-character alpha currency code for currency of the funds transfer.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n\nCurrency must be supported by the processor.\n" + }, + "sourceCurrency": { "type": "string", - "maxLength": 8, - "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer.\n\nNOTE: This field is supported only for Visa Platform Connect\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" + }, + "destinationCurrency": { + "type": "string", + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\nNOTE: This field is supported only for Visa Platform Connect\n" } } } @@ -67955,82 +68102,27 @@ }, "processingInformation": { "type": "object", - "required": [ - "commerceIndicator" - ], "properties": { "businessApplicationId": { "type": "string", - "maxLength": 2, - "description": "\nPayouts transaction type.\nRequired for Mastercard Send.\n\nValid Values-\nVisa Platform Connect:\n- `AA`: Account to account.\n- `CP`: Card bill payment\n- `FD`: Funds disbursement (general)\n- `GD`: Government disbursement\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `PP`: Person to person.\n- `TU`: Top-up for enhanced prepaid loads.\n\n\nMastercard Send:\n- `BB`: Business to business.\n- `BD`: Business Disbursement\n- `CP`: Card bill payment\n- `GD`: Government disbursement\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `OG`: Online gambling payout.\n\n\nChase Paymentech Solutions:\n- `AA`: Account to account.\n- `FD`: Funds disbursement (general)\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `PP`: Person to person.\n\n\nFDC Compass:\n- `BB`: Business to business.\n- `BI`: Bank-initiated money transfer.\n- `FD`: Funds disbursement (general)\n- `GD`: Government disbursement\n- `GP`: Gambling Payment\n- `LO`: Loyalty Offers\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `MI`: Merchant initated money transfer\n- `OG`: Online gambling payout.\n- `PD`: Payroll pension disbursement.\n- `PP`: Person to person.\n- `WT`: Wallet transfer.\n" - }, - "commerceIndicator": { - "type": "string", - "maxLength": 13, - "description": "Type of transaction.\n\nValue for an OCT transaction:\ninternet\n\nFor details, see the e_commerce_indicator field description in Payouts Using the SCMP API.\n" - }, - "networkRoutingOrder": { - "type": "string", - "maxLength": 30, - "description": "Visa Platform Connect\nThis field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities.\n\nFor details, see the network_order field description in BIN Lookup Service Using the SCMP API.\n" + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Payouts transaction type.\n\nBusiness Application ID:\n- `PP`: Person to person.\n- `FD`: Funds disbursement (general)\n" }, "payoutsOptions": { "type": "object", "properties": { - "accountFundingReferenceId": { + "sourceCurrency": { "type": "string", - "maxLength": 15, - "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n\nApplicable only for Visa Platform Connect\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for source currency of the funds transfer.\n\nYellow Pepper\nSupported for cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" }, - "retrievalReferenceNumber": { + "destinationCurrency": { "type": "string", - "maxLength": 12, - "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n\nFormat: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 \u2013 366. Positions 5-12: A unique identification number generated by the merchant\n\nApplicable only for Visa Platform Connect\n" - } - } - }, - "purposeOfPayment": { - "type": "string", - "maxLength": 12, - "description": "This will send purpose of funds code for original credit transactions (OCTs).\n\nVisa Platform Connect (VPC)\nThis will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country.\n\nMastercard Send:\n- `00`: Family Support\n- `01`: Regular Labor Transfers (expatriates),\n- `02`: Travel & Tourism\n- `03`: Education\n- `04`: Hospitalization & Medical Treatment,\n- `05`: Emergency Need\n- `06`: Savings\n- `07`: Gifts\n- `08`: Other\n- `09`: Salary\n- `10`: Crowd lending\n- `11`: Crypto currency\n- `12`: Refund to original card\n- `13`: Refund to new card\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request.\n\nFor Payouts: max length for FDCCompass is String (22).\n" - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "maxLength": 1, - "description": "boolean\nDefault: false\nFlag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n\ntrue: Loan payment\nfalse: (default) Not a loan payment\n\nThis field applies only to FDC Compass\n" - } - } - }, - "transactionReason": { - "type": "string", - "maxLength": 4, - "description": "Transaction reason code.\n\nThis field applies only to Visa Platform Connect\n" - } - } - }, - "processingOptions": { - "type": "object", - "properties": { - "fundingOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Visa Platform Connect :\nThis API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient.\n\nThe valid values are:\n- `S` (Payer (sender))\n- `R` (Payee (recipient))\n\nThis field applies only to Visa Platform Connect\n" - } - } + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for destination currency of the funds transfer.\n\nYellow Pepper\nSupported for cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" } } } @@ -68047,19 +68139,19 @@ "properties": { "type": { "type": "string", - "maxLength": 3, - "description": "Three-digit value that indicates the card type. Mandatory if not present in a token.\n\nPossible values:\n\nVisa Platform Connect\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `033`: Visa Electron\n- `024`: Maestro\n\nMastercard Send:\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nFDC Compass:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nChase Paymentech:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Three-digit value that indicates the card type.\n\nPossible values:\n\nVisa Platform Connect\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `033`: Visa Electron\n- `024`: Maestro\n\nMastercard Send:\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nFDC Compass:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nChase Paymentech:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nYellow Pepper:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `005`: Diners Club\n- `033`: Visa Electron\n- `024`: Intl Maestro\n" }, "securityCode": { "type": "string", - "maxLength": 3, + "pattern": "^(\\s{0,3}|.{3})$", "x-nullable": true, "description": "3-digit value that indicates the cardCvv2Value. Values can be 0-9.\n" }, "number": { "type": "string", - "minLength": 13, - "maxLength": 19, + "pattern": "^(\\s{0,19}|.{13,19})$", "x-nullable": true, "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nConditional: this field is required if not using tokens.\n" }, @@ -68080,6 +68172,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional.\n" } @@ -68090,6 +68183,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Payment Instrument token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional.\n" } @@ -68100,6 +68194,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Instrument Identifier token used in the transaction. When you include this value in your request, many of the fields that can be supplied for an authorization or credit become optional.\n" } @@ -68112,39 +68207,44 @@ "address1": { "type": "string", "maxLength": 50, - "description": "First line of the recipient's address.\n\nRequired for Mastercard Send. This field is not supported for Visa Platform Connect.\n" + "x-nullable": true, + "description": "First line of the recipient's address.\nRequired for card payments\n" }, "address2": { "type": "string", "maxLength": 50, "x-nullable": true, - "description": "Second line of the recipient's address\n\nOptional for Mastercard Send. This field is not supported for Visa Platform Connect.\n" + "description": "Second line of the recipient's address\n" }, "locality": { "type": "string", "maxLength": 25, - "description": "Recipient city.\n\nRequired for Mastercard Send.\n" + "x-nullable": true, + "description": "Recipient city.\n" }, "postalCode": { "type": "string", + "x-nullable": true, "maxLength": 10, - "description": "Recipient postal code.\n\nFor USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nMastercard Send: Required for recipients in Canada and Canadian issued cards.\n" + "description": "Recipient postal code. \n\nFor USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nMandatory for card payments.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, "x-nullable": true, - "description": "The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.\n\nRequired only for FDCCompass.\n\nThis field is not supported for Visa Platform Connect.\n" + "description": "The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nRequired for card payments.\n" }, "country": { "type": "string", - "maxLength": 2, - "description": "Recipient country code. Use the ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nRequired for Mastercard Send.\n" + "pattern": "^(\\s{0,2}|.{2})$", + "x-nullable": true, + "description": "Recipient country code. Use the ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n" }, "firstName": { "type": "string", "maxLength": 40, - "description": "First name of recipient.\n\nVisa Platform Connect (14)\nChase Paymentech (30)\nMastercard Send (40)\n\nThis field is required for Mastercard Send.\n" + "x-nullable": true, + "description": "First name of recipient.\n" }, "middleName": { "type": "string", @@ -68152,43 +68252,39 @@ "x-nullable": true, "description": "Sender's middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.\n" }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "x-nullable": true, - "description": "Middle Initial of recipient.\n\nThis field is supported by FDC Compass.\n" - }, "lastName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "Last name of recipient.\n\nVisa Platform Connect (14)\nPaymentech (30)\nMastercard Send (40)\n\nThis field is required for Mastercard Send.\n" - }, - "dateOfBirth": { - "type": "string", - "maxLength": 8, - "x-nullable": true, - "description": "Recipient date of birth in YYYYMMDD format.\n" + "description": "Last name of recipient.\n" }, "phoneNumber": { "type": "string", + "x-nullable": true, "maxLength": 20, "description": "Recipient phone number.\n\nThis field is supported by FDC Compass.\n\nMastercard Send: Max length is 15 with no dashes or spaces.\n" }, "personalIdentification": { "type": "object", + "x-nullable": true, "properties": { "id": { "type": "string", "x-nullable": true, "maxLength": 80, - "description": "The ID number/value.\n\nVisa Platform Connect\nThis tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender.\n\nMastercard Send(80)\n" + "description": "The ID number/value.\nProcessor(35)\n" }, "type": { "type": "string", "x-nullable": true, "maxLength": 4, - "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n\nMastercard Send:\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `EIDN`: (Employer Identification Number)\n- `IDNB`: (Identity Card Number)\n" + "description": "This tag will contain the type of sender identification.\n" + }, + "issuingCountry": { + "type": "string", + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Issuing country of the identification.\nThe field format should be a 2 character ISO 3166-1 alpha-2 country code.\n" } } } @@ -68207,19 +68303,19 @@ "type": "string", "maxLength": 40, "x-nullable": true, - "description": "This field contains the first name of the entity funding the transaction.\n" + "description": "This field contains the first name of the entity funding the transaction\nMandatory for card payments\n" }, "lastName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "This field contains the last name of the entity funding the transaction.\n" + "description": "This field contains the last name of the entity funding the transaction\nMandatory for card payments\n" }, "middleName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction\n" + "description": "This field contains the middle name of the entity funding the transaction\n" }, "postalCode": { "type": "string", @@ -68231,40 +68327,36 @@ "type": "string", "maxLength": 60, "x-nullable": true, - "description": "Street address of sender.\n\nFunds Disbursement\n\nThis value is the address of the originator sending the funds disbursement.\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n" + "description": "Street address of sender.\n\nFunds Disbursement\n\nThis value is the address of the originator sending the funds disbursement.\n\nRequired for card transactions\n" }, "address2": { "type": "string", "maxLength": 60, "x-nullable": true, - "description": "Used for additional address information. For example: Attention: Accounts Payable Optional field.\n\nThis field is supported for only Mastercard Send.\n" + "description": "Used for additional address information. For example: Attention: Accounts Payable \nOptional field.\n" }, "locality": { "type": "string", "maxLength": 25, "x-nullable": true, - "description": "The sender's city\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n" + "description": "The sender's city\nMandatory for card payments\n" }, "administrativeArea": { "type": "string", "maxLength": 3, "x-nullable": true, - "description": "Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n" + "description": "Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nMandatory for card payments\n" }, "country": { "type": "string", - "maxLength": 2, + "pattern": "^(\\s{0,2}|.{2})$", "x-nullable": true, - "description": "Sender's country code. Use ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n\nRequired for Mastercard Send\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n" + "description": "Sender's country code. Use ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n" }, "dateOfBirth": { "type": "string", - "maxLength": 8, + "x-nullable": true, + "pattern": "^(\\s{0,8}|.{8})$", "description": "Sender's date of birth in YYYYMMDD format.\n" }, "phoneNumber": { @@ -68281,33 +68373,39 @@ "properties": { "type": { "type": "string", - "maxLength": 3, + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, "description": "Three-digit value that indicates the card type.\n\nIMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type.\n\nPossible values:\n\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value 001 for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n" }, "securityCode": { "type": "string", - "maxLength": 3, - "description": "3-digit value that indicates the card Cvv2Value. Values can be 0-9.\n\nThis field is supported in Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,3}|.{3})$", + "description": "3-digit value that indicates the card Cvv2Value. Values can be 0-9.\n" }, "sourceAccountType": { "type": "string", + "x-nullable": true, "maxLength": 20, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process.\n\nValid values for Visa Platform Connect:\n- `CHECKING`: Checking account\n- `CREDIT`: Credit card account\n- `SAVING`: Saving account\n- `LINE_OF_CREDIT`: Line of credit or credit portion of combo card\n- `PREPAID`: Prepaid card account or prepaid portion of combo card\n- `UNIVERSAL`: Universal account\n\nValid values for Mastercard Send:\n- `00`: Other,\n- `01`: RTN + Bank Account,\n- `02`: IBAN,\n- `03`: Card Account,\n- `04`: Email,\n- `05`: Phone Number,\n- `06`: Bank account number (BAN) + Bank Identification \u0421ode (BIC),\n- `07`: Wallet ID,\n- `08`: Social Network ID. Numeric, 2 characters.\n\nThis field is supported in Mastercard Send.\n" + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process.\n" }, "number": { "type": "string", + "x-nullable": true, "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nThis field is supported in Mastercard Send.\n" + "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\nValid values: 01 through 12. Leading 0 is required.\n\nThis field is supported for Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Two-digit month in which the payment card expires.\n\nFormat: MM.\n\nValid values: 01 through 12. Leading 0 is required.\n" }, "expirationYear": { "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the payment card expires.\n\nThis field is supported for Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,4}|.{4})$", + "description": "Four-digit year in which the payment card expires.\n" } } } @@ -68325,13 +68423,15 @@ "properties": { "fundsSource": { "type": "string", - "maxLength": 2, + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", "description": "Source of funds. Possible values:\n\nChase Paymentech, FDC Compass, Visa Platform Connect:\n\n- `01`: Credit card\n- `02`: Debit card\n- `03`: Prepaid card\n\nChase Paymentech, Visa Platform Connect:\n\n- `04`: Cash\n- `05`: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards.\n- `06`: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit.\n\nFDC Compass:\n- `04`: Deposit Account\n\nFunds Disbursement\nThis value is most likely 05 to identify that the originator used a deposit account to fund the disbursement.\n\nCredit Card Bill Payment\nThis value must be 02, 03, 04, or 05.\n" }, "number": { "type": "string", + "x-nullable": true, "maxLength": 34, - "description": "The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n\nFDC Compass (<= 19)\nChase Paymentech (<= 16)\n" + "description": "The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n" } } }, @@ -68342,191 +68442,30 @@ "id": { "type": "string", "maxLength": 80, - "description": "Visa Platform Connect(35)\nThis tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender.\n\nMastercard Send(80)\n" + "x-nullable": true, + "description": "Processor(35)\n" }, "personalIdType": { "type": "string", "maxLength": 1, + "x-nullable": true, "description": "Visa Platform Connect\nThis tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification).\n\nThe valid values are: \u2022 B (Business) \u2022 I (Individual)\n" }, "type": { "type": "string", "maxLength": 4, - "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n\nMastercard Send:\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `EIDN`: (Employer Identification Number)\n- `IDNB`: (Identity Card Number)\n" - } - } - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator.\nGet this value from the processor.\n\nFDC Compass\nThis value must consist of uppercase letters.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- `Record`: CP01 TCR6\n- `Position`: 95-105\n- `Field`: Market Identifier / Payment Facilitator ID\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\nVisa Platform COnnect\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API.\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 20, - "description": "The ID you assigned to your sub-merchant.\n\nFDC Compass: This value must consist of uppercase characters.\n\nVisa Platform Connect with Mastercard: String (15)\nFDC Compass: String (20)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant's business name.\n\nVisa Platform Connect\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant's state or province.\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Sub-merchant's country. Use the ISO Standard numeric Country Codes.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant's email address.\n\nCyberSource through VisaNet |\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n- Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant's telephone number.\n\nMaximum length for procesors\n\nVisa Platform Connect: 20\nFDC Compass: 13\n\nFDC Compass\nThis value must consist of uppercase characters. Use one of these recommended formats:\nNNN-NNN-NNNN\nNNN-AAAAAAA\n" - } - } - } - } - }, - "merchantDefinedInformation": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key.\n\nFor Mastercard Send:\nName to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide.\n\nWarning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\nFor Mastercard Send:\nValue to be displayed in the reconciliation report for this disbursement.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "categoryCode": { - "type": "integer", - "maxLength": 4, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n\nRecord: CP01 TCR4\nPosition: 150-153\nField: Merchant Category Code\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 6, - "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nVisa Platform Connect: max length is 20\n" - }, - "merchantDescriptor": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "The state where the merchant is located.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nNote This field is supported only for businesses located in the U.S. or Canada.\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant.\n\nNote These are the maximum data lengths for the following payment processors:\n\nFDC Compass (13)\nChase Paymentech (13).\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Merchant's country.\n\nCountry code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nNote If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea.\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant's City.\n\nCity for your business location. This value might be displayed on the cardholder's statement.\n" - }, - "name": { - "type": "string", - "maxLength": 23, - "description": "Merchant's business name. This name is displayed on the cardholder's statement.\n\nChase Paymentech, Visa Platform Connect: length 22\n" - }, - "storeId": { - "type": "string", - "maxLength": 32, - "description": "The unique id of the merchant's shop which assigned by the merchant.\n" + "x-nullable": true, + "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n" }, - "postalCode": { + "issuingCountry": { + "x-nullable": true, "type": "string", - "maxLength": 14, - "description": "Merchant's postal code. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3\n" + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Issuing country of the identification.\nThe field format should be a 2 character ISO 3166-1 alpha-2 country code.\n" } } } } - }, - "pointOfServiceInformation": { - "type": "object", - "properties": { - "terminalId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.\n\nVisa Platform Connect\nA list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support.\n\n\nUsed by\nAuthorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used.\n\nChase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel.\n" - }, - "catLevel": { - "type": "integer", - "maxLength": 1, - "description": "Type of cardholder-activated terminal. Possible values:\n\n- `1`: Automated dispensing machine\n- `2`: Self-service terminal\n- `3`: Limited amount terminal\n- `4`: In-flight commerce (IFC) terminal\n- `5`: Radio frequency device\n- `6`: Mobile acceptance terminal\n- `7`: Electronic cash register\n- `8`: E-commerce device at your location\n- `9`: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n\nChase Paymentech Solutions\nOnly values 1, 2, and 3 are supported.\nRequired if pointOfSaleInformation.terminalID is included in the request; otherwise, optional.\n\nVisa Platform COnnect\nValues 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values.\nOptional field.\n\nNonnegative integer.\n" - }, - "entryMode": { - "type": "string", - "maxLength": 11, - "description": "Method of entering payment card information into the POS terminal. Possible values:\n\n- `contact`: Read from direct contact with chip card.\n- `contactless`: Read from a contactless interface using chip data.\n- `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct.\n- `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct.\n- `swiped`: Read from credit card magnetic stripe.\nThe contact, contactless, and msd values are supported only for EMV transactions.\n" - }, - "pinEntryCapability": { - "type": "integer", - "maxLength": 1, - "description": "PIN Entry Capability\n- 0 Unknown.\n- 1 Indicates terminal can accept and forward online PINs.\n- 2 Indicates terminal cannot accept and forward online PINs.\n- 8 Terminal PIN pad down.\n- 9 Reserved for future use.\n" - }, - "terminalCapability": { - "type": "integer", - "maxLength": 1, - "description": "integer [ 1 .. 5 ]\nPOS terminal's capability. Possible values:\n\n- `1`: Terminal has a magnetic stripe reader only.\n- `2`: Terminal has a magnetic stripe reader and manual entry capability.\n- `3`: Terminal has manual entry capability only.\n- `4`: Terminal can read chip cards.\n- `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards.\nFor an EMV transaction, the value of this field must be 4 or 5.\n\nUsed by\nAuthorization Required for the following processors:\nChase Paymentech Solutions\n\nOptional for the following processors:\nVisa Platform Connect\n" - } - } } }, "example": { @@ -68537,44 +68476,19 @@ "applicationUser": "example_user" }, "orderInformation": { - "isCryptocurrencyPurchase": "true", "amountDetails": { "totalAmount": "53.00", - "currency": "AED" - }, - "surcharge": { - "amount": "54.00" + "currency": "AED", + "settlementCurrency": "USD" } }, "processingInformation": { - "commerceIndicator": "INTERNET", "businessApplicationId": "WT", - "networkRoutingOrder": "test", - "purposeOfPayment": "test", - "reconciliationId": "1234", - "transactionReason": "test", "payoutsOptions": { - "accountFundingReferenceId": "1234", - "retrievalReferenceNumber": "1234" - }, - "recurringOptions": { - "loanPayment": true - } - }, - "processingOptions": { - "fundingOptions": { - "initiator": { - "type": "S" - } + "sourceCurrency": "USD", + "destinationCurrency": "USD" } }, - "pointOfServiceInformation": { - "entryMode": "contact", - "pinEntryCapability": "1", - "terminalCapability": "1", - "catLevel": "1", - "terminalId": "123" - }, "recipientInformation": { "paymentInformation": { "card": { @@ -68599,13 +68513,11 @@ "locality": "Austin", "postalCode": "78731", "administrativeArea": "CA", - "country": "USA", + "country": "US", "firstName": "Jennifer", "lastName": "Doe", "middleName": "A", - "middleInitial": "M", "phoneNumber": "123 123-1234", - "dateOfBirth": "2000-12-12", "personalIdentification": { "id": "!23132456", "type": "CUID" @@ -68621,7 +68533,6 @@ "address2": "Bluffstone Drive", "locality": "Foster City", "administrativeArea": "CA", - "vatRegistrationNumber": "PQRS123423456", "phoneNumber": "123 123-1234", "dateOfBirth": "20001212", "country": "US", @@ -68645,38 +68556,6 @@ "fundsSource": "01", "number": "1234567890" } - }, - "aggregatorInformation": { - "aggregatorId": "123456", - "name": "abc", - "subMerchant": { - "address1": "Paseo Padre Boulevard", - "administrativeArea": "840", - "country": "US", - "email": "abc@abc", - "id": "1234", - "locality": "Foster City", - "name": "John", - "phoneNumber": "123 123-1234", - "postalCode": "94440" - } - }, - "merchantDefinedInformation": { - "key": "123", - "value": "abc" - }, - "merchantInformation": { - "categoryCode": "1234", - "submitLocalDateTime": "2021-08-19T10:07:57Z", - "vatRegistrationNumber": "PQRS123423456", - "merchantDescriptor": { - "administrativeArea": "840", - "contact": "Example", - "country": "US", - "locality": "Foster City", - "name": "John", - "postalCode": "94440" - } } } } @@ -68757,6 +68636,7 @@ "submitLocalDateTime": { "type": "string", "maxLength": 14, + "minLength": 14, "description": "Date and time at your physical location.\n\nFormat: YYYYMMDDhhmmss, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" } } @@ -68852,25 +68732,15 @@ "maxLength": 15, "description": "Transaction status from the processor.\n" }, - "approvalCode": { - "type": "string", - "maxLength": 6, - "description": "Issuer-generated approval code for the transaction.\n" - }, "systemTraceAuditNumber": { "type": "string", "maxLength": 6, - "description": "System audit number. Returned by authorization and incremental authorization services.\n\nVisa Platform Connect\n\nSystem trace number that must be printed on the customer's receipt.\n" - }, - "responseCodeSource": { - "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" + "description": "System audit number. Returned by authorization and incremental authorization services.\n" }, "retrievalReferenceNumber": { "type": "string", "maxLength": 24, - "description": "Unique reference number returned by the processor that identifies the transaction at the network.\n\nSupported by Mastercard Send\n" + "description": "Unique reference number returned by the processor that identifies the transaction at the network.\n" } } }, @@ -68887,7 +68757,7 @@ "type": "string", "minLength": 1, "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n\nNote For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers.\n\nProcessor Amount Ranges:\nVisa Platform Connect: .01-9999999999.99\n\nMastercard Send: 1-9999999999.99\n\nFDC Compass: .01- 9999999999.994\n\nChase Paymentech: .01-9999999999.99\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n" }, "currency": { "type": "string", @@ -68993,9 +68863,7 @@ "processorInformation": { "transactionId": "1234567890", "responseCode": "1234567890", - "approvalCode": "123456", "systemTraceAuditNumber": "123456", - "responseCodeSource": "A", "retrievalReferenceNumber": "1234567890" }, "orderInformation": { @@ -69016,13 +68884,6 @@ "balance": "123", "currency": "USD" } - }, - "merchantInformation": { - "merchantDescriptor": { - "name": "John", - "locality": "Austin", - "country": "US" - } } } } @@ -69054,7 +68915,7 @@ }, "message": { "type": "string", - "description": "The detail message related to the status and reason listed above.\n\nPossible values:\n- Declined - One or more fields in the request contains invalid data\n- Declined - The request is missing one or more fields\n- Declined - There is a problem with your CyberSource merchant configuration.\n" + "description": "The detail message related to the status and reason listed above.\n\nPossible values:\n- One or more fields in the request contains invalid data.\n- The request is missing one or more required fields.\n- Declined - There is a problem with your CyberSource merchant configuration.\n" }, "details": { "type": "array", @@ -69176,43 +69037,14 @@ "applicationUser": "example_user" }, "orderInformation": { - "isCryptocurrencyPurchase": "true", "amountDetails": { "totalAmount": "53.00", - "currency": "AED" - }, - "surcharge": { - "amount": "54.00" + "currency": "USD", + "settlementCurrency": "USD" } }, "processingInformation": { - "commerceIndicator": "INTERNET", - "businessApplicationId": "WT", - "networkRoutingOrder": "test", - "purposeOfPayment": "test", - "reconciliationId": "1234", - "transactionReason": "test", - "payoutsOptions": { - "accountFundingReferenceId": "1234", - "retrievalReferenceNumber": "1234" - }, - "recurringOptions": { - "loanPayment": true - } - }, - "processingOptions": { - "fundingOptions": { - "initiator": { - "type": "S" - } - } - }, - "pointOfServiceInformation": { - "entryMode": "contact", - "pinEntryCapability": "1", - "terminalCapability": "1", - "catLevel": "1", - "terminalId": "123" + "businessApplicationId": "FT" }, "recipientInformation": { "paymentInformation": { @@ -69221,16 +69053,7 @@ "securityCode": "123", "number": "4111111111111111", "expirationMonth": "12", - "expirationYear": "2025", - "customer": { - "id": "40195947" - }, - "paymentInstrument": { - "id": "1234567783" - }, - "instrumentIdentifier": { - "id": "38792480110" - } + "expirationYear": "2025" } }, "address1": "8310 Capital of Texas Highwas North", @@ -69242,16 +69065,12 @@ "firstName": "Jennifer", "lastName": "Doe", "middleName": "A", - "middleInitial": "M", - "phoneNumber": "123 123-1234", - "dateOfBirth": "2000-12-12", "personalIdentification": { - "id": "!23132456", - "type": "CUID" + "id": "123132456", + "type": "EIDN" } }, "senderInformation": { - "name": "Tom", "firstName": "John", "lastName": "Doe", "middleName": "A", @@ -69260,9 +69079,6 @@ "address2": "Bluffstone Drive", "locality": "Foster City", "administrativeArea": "CA", - "vatRegistrationNumber": "PQRS123423456", - "phoneNumber": "123 123-1234", - "dateOfBirth": "20001212", "country": "US", "referenceNumber": "1234567890", "paymentInformation": { @@ -69277,44 +69093,10 @@ }, "personalIdentification": { "id": "123132456", - "personalIdType": "A", - "type": "BTHD" + "type": "CUID" }, "account": { - "fundsSource": "01", - "number": "1234567890" - } - }, - "aggregatorInformation": { - "aggregatorId": "123456", - "name": "abc", - "subMerchant": { - "address1": "Paseo Padre Boulevard", - "administrativeArea": "840", - "country": "US", - "email": "abc@abc", - "id": "1234", - "locality": "Foster City", - "name": "John", - "phoneNumber": "123 123-1234", - "postalCode": "94440" - } - }, - "merchantDefinedInformation": { - "key": "123", - "value": "abc" - }, - "merchantInformation": { - "categoryCode": "1234", - "submitLocalDateTime": "2021-08-19T10:07:57Z", - "vatRegistrationNumber": "PQRS123423456", - "merchantDescriptor": { - "administrativeArea": "840", - "contact": "Example", - "country": "US", - "locality": "Foster City", - "name": "John", - "postalCode": "94440" + "fundsSource": "02" } } } @@ -69454,7 +69236,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -69858,7 +69640,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -70068,7 +69850,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -70276,7 +70058,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -71246,7 +71028,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -71807,7 +71589,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -72110,7 +71892,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -73356,12 +73138,12 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" } } }, @@ -73413,7 +73195,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" }, "cavv": { "type": "string", @@ -73423,7 +73205,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -73565,12 +73347,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -73643,12 +73425,12 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "country": { "type": "string", @@ -73773,12 +73555,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "taxAmount": { "type": "string", @@ -73788,7 +73570,7 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "settlementAmount": { "type": "string", @@ -73863,7 +73645,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -74049,24 +73831,24 @@ "properties": { "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" }, "branchCode": { "type": "string", - "description": "Code used to identify the branch of the customer's bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n\nFor all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Code used to identify the branch of the customer's bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "bankCode": { "type": "string", - "description": "Country-specific code used to identify the customer's\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country-specific code used to identify the customer's\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "account": { "type": "object", @@ -74095,12 +73877,12 @@ }, "checkDigit": { "type": "string", - "description": "Code used to validate the customer's account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Code used to validate the customer's account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n" }, "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" } } }, @@ -74252,16 +74034,16 @@ "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "authorizationOptions": { "type": "object", @@ -74269,7 +74051,7 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "authIndicator": { "type": "string", @@ -74475,7 +74257,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" } } }, @@ -74485,12 +74267,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -74500,7 +74282,7 @@ "email": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's email address.\n\nFor details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's email address.\n" }, "emailRaw": { "type": "string", @@ -74520,7 +74302,7 @@ "phoneNumber": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's phone number.\n\nFor details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's phone number.\n" }, "phoneNumberRaw": { "type": "string", @@ -74530,7 +74312,7 @@ "street": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's street address.\n\nFor details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's street address.\n" }, "streetRaw": { "type": "string", @@ -74540,7 +74322,7 @@ "postalCode": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's postal code.\n\nFor details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's postal code.\n" }, "postalCodeRaw": { "type": "string", @@ -74841,7 +74623,7 @@ "solutionId": "89012345", "thirdPartyCertificationNumber": "123456789012" }, - "comments": "test comment" + "comments": "Test comment about this order - Expedited shipping" }, "consumerAuthenticationInformation": { "eciRaw": "02", @@ -75666,7 +75448,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -75704,7 +75486,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -75713,7 +75495,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" } } }, @@ -75754,12 +75536,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -75798,7 +75580,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "country": { "type": "string", @@ -75848,12 +75630,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -75880,7 +75662,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -75932,17 +75714,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" } } }, @@ -76507,7 +76289,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -76545,7 +76327,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -76554,7 +76336,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" } } }, @@ -76595,12 +76377,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" } } } @@ -76639,7 +76421,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "country": { "type": "string", @@ -76689,12 +76471,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -76721,7 +76503,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -76773,17 +76555,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" } } }, @@ -84000,12 +83782,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -84013,7 +83795,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -84063,12 +83845,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -84116,7 +83898,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -84332,12 +84114,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -84345,7 +84127,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -84395,12 +84177,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -84453,7 +84235,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -85182,7 +84964,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -85207,12 +84989,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -85673,12 +85455,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -85686,7 +85468,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -85736,12 +85518,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -85794,7 +85576,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -85893,7 +85675,7 @@ "amount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -86084,12 +85866,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -86097,7 +85879,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -86139,12 +85921,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -86192,7 +85974,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -86407,12 +86189,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -86420,7 +86202,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -86470,12 +86252,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -86528,7 +86310,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -86997,12 +86779,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -87010,7 +86792,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -87060,12 +86842,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -87118,7 +86900,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -87534,12 +87316,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -87547,7 +87329,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -87597,12 +87379,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -87655,7 +87437,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -88014,7 +87796,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthenticationInInvoicing": { "description": "For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: \n- `enable`\n- `update`\n- `disable` \n", @@ -88130,7 +87912,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthentication3DSVersion": { "description": "The 3D Secure payer authentication status for a merchant's invoice payments.", @@ -88356,7 +88138,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthentication3DSVersion": { "description": "The 3D Secure payer authentication status for a merchant's invoice payments.", @@ -88947,7 +88729,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." } } }, @@ -89003,7 +88785,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -89309,7 +89091,7 @@ "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" } } } @@ -89523,12 +89305,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -89877,7 +89659,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -89947,7 +89729,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -90079,7 +89861,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90147,7 +89929,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90478,7 +90260,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90551,7 +90333,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90714,7 +90496,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90787,7 +90569,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91262,7 +91044,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91331,7 +91113,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91505,7 +91287,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91582,7 +91364,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", diff --git a/src/api/TransactionBatchesApi.js b/src/api/TransactionBatchesApi.js index 6d11ce7c..e1c62bf0 100644 --- a/src/api/TransactionBatchesApi.js +++ b/src/api/TransactionBatchesApi.js @@ -113,7 +113,7 @@ /** * Get Individual Batch File - * Provide the search range + * This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id * @param {String} id The batch id assigned for the template. * @param {module:api/TransactionBatchesApi~getTransactionBatchIdCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link module:model/PtsV1TransactionBatchesIdGet200Response} @@ -162,7 +162,7 @@ /** * Get a List of Batch Files - * Provide the search range + * Provide the date and time search range to get a list of Batch Files ready for settlement * @param {Date} startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ * @param {Date} endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ * @param {module:api/TransactionBatchesApi~getTransactionBatchesCallback} callback The callback function, accepting three arguments: error, data, response diff --git a/src/index.js b/src/index.js index 3f55ae81..b21386f5 100644 --- a/src/index.js +++ b/src/index.js @@ -16,12 +16,12 @@ (function(factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Accountupdaterv1batchesIncluded', 'model/Accountupdaterv1batchesIncludedTokens', 'model/ActivateDeactivatePlanResponse', 'model/ActivateSubscriptionResponse', 'model/ActivateSubscriptionResponseSubscriptionInformation', 'model/AddNegativeListRequest', 'model/AuthReversalRequest', 'model/Boardingv1registrationsDocumentInformation', 'model/Boardingv1registrationsDocumentInformationSignedDocuments', 'model/Boardingv1registrationsIntegrationInformation', 'model/Boardingv1registrationsIntegrationInformationOauth2', 'model/Boardingv1registrationsIntegrationInformationTenantConfigurations', 'model/Boardingv1registrationsIntegrationInformationTenantInformation', 'model/Boardingv1registrationsOrganizationInformation', 'model/Boardingv1registrationsOrganizationInformationBusinessInformation', 'model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress', 'model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact', 'model/Boardingv1registrationsOrganizationInformationKYC', 'model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount', 'model/Boardingv1registrationsOrganizationInformationOwners', 'model/Boardingv1registrationsProductInformation', 'model/Boardingv1registrationsProductInformationSelectedProducts', 'model/Boardingv1registrationsRegistrationInformation', 'model/Body', 'model/CancelSubscriptionResponse', 'model/CancelSubscriptionResponseSubscriptionInformation', 'model/CapturePaymentRequest', 'model/CardProcessingConfig', 'model/CardProcessingConfigCommon', 'model/CardProcessingConfigCommonAcquirer', 'model/CardProcessingConfigCommonCurrencies', 'model/CardProcessingConfigCommonCurrencies1', 'model/CardProcessingConfigCommonMerchantDescriptorInformation', 'model/CardProcessingConfigCommonPaymentTypes', 'model/CardProcessingConfigCommonProcessors', 'model/CardProcessingConfigFeatures', 'model/CardProcessingConfigFeaturesCardNotPresent', 'model/CardProcessingConfigFeaturesCardNotPresentInstallment', 'model/CardProcessingConfigFeaturesCardNotPresentPayouts', 'model/CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies', 'model/CardProcessingConfigFeaturesCardNotPresentProcessors', 'model/CardProcessingConfigFeaturesCardPresent', 'model/CardProcessingConfigFeaturesCardPresentProcessors', 'model/CaseManagementActionsRequest', 'model/CaseManagementCommentsRequest', 'model/CheckPayerAuthEnrollmentRequest', 'model/CommerceSolutionsProducts', 'model/CommerceSolutionsProductsAccountUpdater', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformation', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa', 'model/CommerceSolutionsProductsBinLookup', 'model/CommerceSolutionsProductsBinLookupConfigurationInformation', 'model/CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations', 'model/CommerceSolutionsProductsTokenManagement', 'model/CommerceSolutionsProductsTokenManagementConfigurationInformation', 'model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations', 'model/CreateAdhocReportRequest', 'model/CreateBillingAgreement', 'model/CreateBundledDecisionManagerCaseRequest', 'model/CreateCreditRequest', 'model/CreateInvoiceRequest', 'model/CreateP12KeysRequest', 'model/CreatePaymentRequest', 'model/CreatePlanRequest', 'model/CreatePlanResponse', 'model/CreatePlanResponsePlanInformation', 'model/CreateReportSubscriptionRequest', 'model/CreateSearchRequest', 'model/CreateSessionReq', 'model/CreateSessionRequest', 'model/CreateSharedSecretKeysRequest', 'model/CreateSharedSecretKeysVerifiRequest', 'model/CreateSubscriptionRequest', 'model/CreateSubscriptionResponse', 'model/CreateSubscriptionResponseLinks', 'model/CreateSubscriptionResponseSubscriptionInformation', 'model/CreateWebhookRequest', 'model/DeleteBulkP12KeysRequest', 'model/DeleteBulkSymmetricKeysRequest', 'model/DeletePlanResponse', 'model/DmConfig', 'model/DmConfigOrganization', 'model/DmConfigPortfolioControls', 'model/DmConfigProcessingOptions', 'model/DmConfigThirdparty', 'model/DmConfigThirdpartyProvider', 'model/DmConfigThirdpartyProviderAccurint', 'model/DmConfigThirdpartyProviderAccurintCredentials', 'model/DmConfigThirdpartyProviderCredilink', 'model/DmConfigThirdpartyProviderCredilinkCredentials', 'model/DmConfigThirdpartyProviderEkata', 'model/DmConfigThirdpartyProviderEkataCredentials', 'model/DmConfigThirdpartyProviderEmailage', 'model/DmConfigThirdpartyProviderPerseuss', 'model/DmConfigThirdpartyProviderSignifyd', 'model/DmConfigThirdpartyProviderSignifydCredentials', 'model/DmConfigThirdpartyProviderTargus', 'model/DmConfigThirdpartyProviderTargusCredentials', 'model/ECheckConfig', 'model/ECheckConfigCommon', 'model/ECheckConfigCommonInternalOnly', 'model/ECheckConfigCommonInternalOnlyProcessors', 'model/ECheckConfigCommonProcessors', 'model/ECheckConfigFeatures', 'model/ECheckConfigFeaturesAccountValidationService', 'model/ECheckConfigFeaturesAccountValidationServiceInternalOnly', 'model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors', 'model/ECheckConfigFeaturesAccountValidationServiceProcessors', 'model/ECheckConfigUnderwriting', 'model/FraudMarkingActionRequest', 'model/GenerateCaptureContextRequest', 'model/GenerateUnifiedCheckoutCaptureContextRequest', 'model/GetAllPlansResponse', 'model/GetAllPlansResponseLinks', 'model/GetAllPlansResponseOrderInformation', 'model/GetAllPlansResponseOrderInformationAmountDetails', 'model/GetAllPlansResponsePlanInformation', 'model/GetAllPlansResponsePlanInformationBillingCycles', 'model/GetAllPlansResponsePlanInformationBillingPeriod', 'model/GetAllPlansResponsePlans', 'model/GetAllSubscriptionsResponse', 'model/GetAllSubscriptionsResponseLinks', 'model/GetAllSubscriptionsResponseOrderInformation', 'model/GetAllSubscriptionsResponseOrderInformationBillTo', 'model/GetAllSubscriptionsResponsePaymentInformation', 'model/GetAllSubscriptionsResponsePaymentInformationCustomer', 'model/GetAllSubscriptionsResponsePlanInformation', 'model/GetAllSubscriptionsResponsePlanInformationBillingCycles', 'model/GetAllSubscriptionsResponseSubscriptionInformation', 'model/GetAllSubscriptionsResponseSubscriptions', 'model/GetPlanCodeResponse', 'model/GetPlanResponse', 'model/GetSubscriptionCodeResponse', 'model/GetSubscriptionResponse', 'model/IncrementAuthRequest', 'model/InlineResponse200', 'model/InlineResponse2001', 'model/InlineResponse2001Keys', 'model/InlineResponse2002', 'model/InlineResponse2002IntegrationInformation', 'model/InlineResponse2002IntegrationInformationTenantConfigurations', 'model/InlineResponse2003', 'model/InlineResponse2004', 'model/InlineResponse2005', 'model/InlineResponse2006', 'model/InlineResponse2006Embedded', 'model/InlineResponse2006EmbeddedBatches', 'model/InlineResponse2006EmbeddedLinks', 'model/InlineResponse2006EmbeddedLinksReports', 'model/InlineResponse2006EmbeddedTotals', 'model/InlineResponse2006Links', 'model/InlineResponse2007', 'model/InlineResponse2007Billing', 'model/InlineResponse2007Links', 'model/InlineResponse2007LinksReport', 'model/InlineResponse2008', 'model/InlineResponse2008Records', 'model/InlineResponse2008ResponseRecord', 'model/InlineResponse2008ResponseRecordAdditionalUpdates', 'model/InlineResponse2008SourceRecord', 'model/InlineResponse200Embedded', 'model/InlineResponse200EmbeddedCapture', 'model/InlineResponse200EmbeddedCaptureLinks', 'model/InlineResponse200EmbeddedCaptureLinksSelf', 'model/InlineResponse200EmbeddedReversal', 'model/InlineResponse200EmbeddedReversalLinks', 'model/InlineResponse200EmbeddedReversalLinksSelf', 'model/InlineResponse201', 'model/InlineResponse2011', 'model/InlineResponse2011IntegrationInformation', 'model/InlineResponse2011IntegrationInformationTenantConfigurations', 'model/InlineResponse2011OrganizationInformation', 'model/InlineResponse2011ProductInformationSetups', 'model/InlineResponse2011RegistrationInformation', 'model/InlineResponse2011Setups', 'model/InlineResponse2011SetupsCommerceSolutions', 'model/InlineResponse2011SetupsPayments', 'model/InlineResponse2011SetupsPaymentsCardProcessing', 'model/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus', 'model/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus', 'model/InlineResponse2011SetupsPaymentsDigitalPayments', 'model/InlineResponse2011SetupsRisk', 'model/InlineResponse2011SetupsValueAddedServices', 'model/InlineResponse2012', 'model/InlineResponse2012KeyInformation', 'model/InlineResponse2012KeyInformationErrorInformation', 'model/InlineResponse2012KeyInformationErrorInformationDetails', 'model/InlineResponse2013', 'model/InlineResponse2014', 'model/InlineResponse202', 'model/InlineResponse202Links', 'model/InlineResponse202LinksStatus', 'model/InlineResponse400', 'model/InlineResponse4001', 'model/InlineResponse4002', 'model/InlineResponse4003', 'model/InlineResponse4004', 'model/InlineResponse4004Fields', 'model/InlineResponse4005', 'model/InlineResponse4006', 'model/InlineResponse4007', 'model/InlineResponse4007Details', 'model/InlineResponse4008', 'model/InlineResponse4008Details', 'model/InlineResponse400Details', 'model/InlineResponse400Errors', 'model/InlineResponse401', 'model/InlineResponse401Fields', 'model/InlineResponse401Links', 'model/InlineResponse401LinksSelf', 'model/InlineResponse403', 'model/InlineResponse4031', 'model/InlineResponse403Errors', 'model/InlineResponse404', 'model/InlineResponse4041', 'model/InlineResponse4042', 'model/InlineResponse4042Details', 'model/InlineResponse409', 'model/InlineResponse409Errors', 'model/InlineResponse410', 'model/InlineResponse410Errors', 'model/InlineResponse412', 'model/InlineResponse412Errors', 'model/InlineResponse422', 'model/InlineResponse4221', 'model/InlineResponse424', 'model/InlineResponse424Errors', 'model/InlineResponse500', 'model/InlineResponse5001', 'model/InlineResponse5002', 'model/InlineResponse5003', 'model/InlineResponse500Errors', 'model/InlineResponse502', 'model/InlineResponse5021', 'model/InlineResponse503', 'model/InlineResponseDefault', 'model/InlineResponseDefaultLinks', 'model/InlineResponseDefaultLinksNext', 'model/InlineResponseDefaultResponseStatus', 'model/InlineResponseDefaultResponseStatusDetails', 'model/IntimateBillingAgreement', 'model/InvoiceSettingsRequest', 'model/InvoicingV2InvoiceSettingsGet200Response', 'model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation', 'model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle', 'model/InvoicingV2InvoicesAllGet200Response', 'model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation', 'model/InvoicingV2InvoicesAllGet200ResponseInvoiceInformation', 'model/InvoicingV2InvoicesAllGet200ResponseInvoices', 'model/InvoicingV2InvoicesAllGet200ResponseLinks', 'model/InvoicingV2InvoicesAllGet200ResponseOrderInformation', 'model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails', 'model/InvoicingV2InvoicesAllGet400Response', 'model/InvoicingV2InvoicesAllGet404Response', 'model/InvoicingV2InvoicesAllGet502Response', 'model/InvoicingV2InvoicesGet200Response', 'model/InvoicingV2InvoicesGet200ResponseInvoiceHistory', 'model/InvoicingV2InvoicesGet200ResponseTransactionDetails', 'model/InvoicingV2InvoicesPost201Response', 'model/InvoicingV2InvoicesPost201ResponseInvoiceInformation', 'model/InvoicingV2InvoicesPost201ResponseOrderInformation', 'model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails', 'model/InvoicingV2InvoicesPost202Response', 'model/Invoicingv2invoiceSettingsInvoiceSettingsInformation', 'model/Invoicingv2invoicesCustomerInformation', 'model/Invoicingv2invoicesCustomerInformationCompany', 'model/Invoicingv2invoicesInvoiceInformation', 'model/Invoicingv2invoicesOrderInformation', 'model/Invoicingv2invoicesOrderInformationAmountDetails', 'model/Invoicingv2invoicesOrderInformationAmountDetailsFreight', 'model/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails', 'model/Invoicingv2invoicesOrderInformationLineItems', 'model/Invoicingv2invoicesidInvoiceInformation', 'model/KmsV2KeysAsymDeletesPost200Response', 'model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation', 'model/KmsV2KeysAsymGet200Response', 'model/KmsV2KeysAsymGet200ResponseKeyInformation', 'model/KmsV2KeysAsymPost201Response', 'model/KmsV2KeysAsymPost201ResponseCertificateInformation', 'model/KmsV2KeysAsymPost201ResponseKeyInformation', 'model/KmsV2KeysSymDeletesPost200Response', 'model/KmsV2KeysSymDeletesPost200ResponseKeyInformation', 'model/KmsV2KeysSymGet200Response', 'model/KmsV2KeysSymGet200ResponseKeyInformation', 'model/KmsV2KeysSymPost201Response', 'model/KmsV2KeysSymPost201ResponseErrorInformation', 'model/KmsV2KeysSymPost201ResponseKeyInformation', 'model/Kmsegressv2keysasymClientReferenceInformation', 'model/Kmsegressv2keysasymKeyInformation', 'model/Kmsegressv2keyssymClientReferenceInformation', 'model/Kmsegressv2keyssymKeyInformation', 'model/Kmsv2keysasymKeyInformation', 'model/Kmsv2keyssymClientReferenceInformation', 'model/Kmsv2keyssymKeyInformation', 'model/Kmsv2keyssymdeletesKeyInformation', 'model/Kmsv2keyssymverifiKeyInformation', 'model/MerchantInitiatedTransactionObject', 'model/Microformv2sessionsCheckoutApiInitialization', 'model/MitReversalRequest', 'model/MitVoidRequest', 'model/ModifyBillingAgreement', 'model/Notificationsubscriptionsv1productsorganizationIdEventTypes', 'model/Notificationsubscriptionsv1webhooksNotificationScope', 'model/Notificationsubscriptionsv1webhooksProducts', 'model/Notificationsubscriptionsv1webhooksRetryPolicy', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1Config', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig', 'model/Notificationsubscriptionsv1webhooksSecurityPolicyConfig', 'model/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus', 'model/OctCreatePaymentRequest', 'model/OrderPaymentRequest', 'model/PatchCustomerPaymentInstrumentRequest', 'model/PatchCustomerRequest', 'model/PatchCustomerShippingAddressRequest', 'model/PatchInstrumentIdentifierRequest', 'model/PatchPaymentInstrumentRequest', 'model/PayerAuthConfig', 'model/PayerAuthConfigCardTypes', 'model/PayerAuthConfigCardTypesCB', 'model/PayerAuthConfigCardTypesJCBJSecure', 'model/PayerAuthConfigCardTypesVerifiedByVisa', 'model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies', 'model/PayerAuthSetupRequest', 'model/PaymentInstrumentList', 'model/PaymentInstrumentList1', 'model/PaymentInstrumentList1Embedded', 'model/PaymentInstrumentList1EmbeddedEmbedded', 'model/PaymentInstrumentList1EmbeddedPaymentInstruments', 'model/PaymentInstrumentListEmbedded', 'model/PaymentInstrumentListLinks', 'model/PaymentInstrumentListLinksFirst', 'model/PaymentInstrumentListLinksLast', 'model/PaymentInstrumentListLinksNext', 'model/PaymentInstrumentListLinksPrev', 'model/PaymentInstrumentListLinksSelf', 'model/PaymentsProducts', 'model/PaymentsProductsCardPresentConnect', 'model/PaymentsProductsCardPresentConnectConfigurationInformation', 'model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations', 'model/PaymentsProductsCardPresentConnectSubscriptionInformation', 'model/PaymentsProductsCardProcessing', 'model/PaymentsProductsCardProcessingConfigurationInformation', 'model/PaymentsProductsCardProcessingSubscriptionInformation', 'model/PaymentsProductsCardProcessingSubscriptionInformationFeatures', 'model/PaymentsProductsCurrencyConversion', 'model/PaymentsProductsCurrencyConversionConfigurationInformation', 'model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurations', 'model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors', 'model/PaymentsProductsCybsReadyTerminal', 'model/PaymentsProductsDifferentialFee', 'model/PaymentsProductsDifferentialFeeSubscriptionInformation', 'model/PaymentsProductsDifferentialFeeSubscriptionInformationFeatures', 'model/PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge', 'model/PaymentsProductsDigitalPayments', 'model/PaymentsProductsDigitalPaymentsSubscriptionInformation', 'model/PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures', 'model/PaymentsProductsECheck', 'model/PaymentsProductsECheckConfigurationInformation', 'model/PaymentsProductsECheckSubscriptionInformation', 'model/PaymentsProductsPayerAuthentication', 'model/PaymentsProductsPayerAuthenticationConfigurationInformation', 'model/PaymentsProductsPayerAuthenticationSubscriptionInformation', 'model/PaymentsProductsPayouts', 'model/PaymentsProductsPayoutsConfigurationInformation', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurations', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds', 'model/PaymentsProductsSecureAcceptance', 'model/PaymentsProductsSecureAcceptanceConfigurationInformation', 'model/PaymentsProductsTax', 'model/PaymentsProductsVirtualTerminal', 'model/PaymentsProductsVirtualTerminalConfigurationInformation', 'model/PaymentsStrongAuthIssuerInformation', 'model/PostCustomerPaymentInstrumentRequest', 'model/PostCustomerRequest', 'model/PostCustomerShippingAddressRequest', 'model/PostInstrumentIdentifierEnrollmentRequest', 'model/PostInstrumentIdentifierRequest', 'model/PostPaymentCredentialsRequest', 'model/PostPaymentInstrumentRequest', 'model/PostRegistrationBody', 'model/PredefinedSubscriptionRequestBean', 'model/PtsV1TransactionBatchesGet200Response', 'model/PtsV1TransactionBatchesGet200ResponseLinks', 'model/PtsV1TransactionBatchesGet200ResponseLinksSelf', 'model/PtsV1TransactionBatchesGet200ResponseTransactionBatches', 'model/PtsV1TransactionBatchesGet400Response', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformation', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails', 'model/PtsV1TransactionBatchesGet500Response', 'model/PtsV1TransactionBatchesGet500ResponseErrorInformation', 'model/PtsV1TransactionBatchesIdGet200Response', 'model/PtsV1TransactionBatchesIdGet200ResponseLinks', 'model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions', 'model/PtsV2CreateBillingAgreementPost201Response', 'model/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseLinks', 'model/PtsV2CreateBillingAgreementPost201ResponseProcessorInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseRiskInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults', 'model/PtsV2CreateBillingAgreementPost400Response', 'model/PtsV2CreateBillingAgreementPost502Response', 'model/PtsV2CreditsPost201Response', 'model/PtsV2CreditsPost201Response1', 'model/PtsV2CreditsPost201Response1ProcessorInformation', 'model/PtsV2CreditsPost201ResponseCreditAmountDetails', 'model/PtsV2CreditsPost201ResponsePaymentInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2IncrementalAuthorizationPatch201Response', 'model/PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseLinks', 'model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails', 'model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures', 'model/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation', 'model/PtsV2IncrementalAuthorizationPatch400Response', 'model/PtsV2ModifyBillingAgreementPost201Response', 'model/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponseLinks', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsCapturesPost201Response', 'model/PtsV2PaymentsCapturesPost201ResponseLinks', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformation', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails', 'model/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation', 'model/PtsV2PaymentsCapturesPost201ResponseProcessingInformation', 'model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation', 'model/PtsV2PaymentsCapturesPost400Response', 'model/PtsV2PaymentsOrderPost201Response', 'model/PtsV2PaymentsOrderPost201ResponseBuyerInformation', 'model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformation', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails', 'model/PtsV2PaymentsOrderPost201ResponsePaymentInformation', 'model/PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsOrderPost201ResponseProcessingInformation', 'model/PtsV2PaymentsOrderPost201ResponseProcessorInformation', 'model/PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection', 'model/PtsV2PaymentsPost201Response', 'model/PtsV2PaymentsPost201Response1', 'model/PtsV2PaymentsPost201Response1OrderInformation', 'model/PtsV2PaymentsPost201Response1OrderInformationBillTo', 'model/PtsV2PaymentsPost201Response1OrderInformationShipTo', 'model/PtsV2PaymentsPost201Response1PaymentInformation', 'model/PtsV2PaymentsPost201Response1PaymentInformationBank', 'model/PtsV2PaymentsPost201Response1PaymentInformationBankAccount', 'model/PtsV2PaymentsPost201Response1PaymentInformationPaymentType', 'model/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod', 'model/PtsV2PaymentsPost201Response1ProcessorInformation', 'model/PtsV2PaymentsPost201Response1ProcessorInformationAvs', 'model/PtsV2PaymentsPost201Response2', 'model/PtsV2PaymentsPost201Response2OrderInformation', 'model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails', 'model/PtsV2PaymentsPost201Response2PaymentInformation', 'model/PtsV2PaymentsPost201Response2PaymentInformationEWallet', 'model/PtsV2PaymentsPost201Response2ProcessorInformation', 'model/PtsV2PaymentsPost201ResponseBuyerInformation', 'model/PtsV2PaymentsPost201ResponseClientReferenceInformation', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication', 'model/PtsV2PaymentsPost201ResponseEmbeddedActions', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING', 'model/PtsV2PaymentsPost201ResponseErrorInformation', 'model/PtsV2PaymentsPost201ResponseErrorInformationDetails', 'model/PtsV2PaymentsPost201ResponseInstallmentInformation', 'model/PtsV2PaymentsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsPost201ResponseLinks', 'model/PtsV2PaymentsPost201ResponseLinksSelf', 'model/PtsV2PaymentsPost201ResponseMerchantInformation', 'model/PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor', 'model/PtsV2PaymentsPost201ResponseOrderInformation', 'model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationBillTo', 'model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationShipTo', 'model/PtsV2PaymentsPost201ResponsePaymentAccountInformation', 'model/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard', 'model/PtsV2PaymentsPost201ResponsePaymentInformation', 'model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures', 'model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBank', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount', 'model/PtsV2PaymentsPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier', 'model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard', 'model/PtsV2PaymentsPost201ResponsePaymentInsightsInformation', 'model/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformation', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv', 'model/PtsV2PaymentsPost201ResponseProcessingInformation', 'model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2PaymentsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAvs', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer', 'model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults', 'model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice', 'model/PtsV2PaymentsPost201ResponseProcessorInformationRouting', 'model/PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection', 'model/PtsV2PaymentsPost201ResponseRiskInformation', 'model/PtsV2PaymentsPost201ResponseRiskInformationInfoCodes', 'model/PtsV2PaymentsPost201ResponseRiskInformationIpAddress', 'model/PtsV2PaymentsPost201ResponseRiskInformationProcessorResults', 'model/PtsV2PaymentsPost201ResponseRiskInformationProfile', 'model/PtsV2PaymentsPost201ResponseRiskInformationRules', 'model/PtsV2PaymentsPost201ResponseRiskInformationScore', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravel', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationVelocity', 'model/PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing', 'model/PtsV2PaymentsPost201ResponseTokenInformation', 'model/PtsV2PaymentsPost201ResponseTokenInformationCustomer', 'model/PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier', 'model/PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument', 'model/PtsV2PaymentsPost201ResponseTokenInformationShippingAddress', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformation', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches', 'model/PtsV2PaymentsPost400Response', 'model/PtsV2PaymentsPost502Response', 'model/PtsV2PaymentsRefundPost201Response', 'model/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation', 'model/PtsV2PaymentsRefundPost201ResponseLinks', 'model/PtsV2PaymentsRefundPost201ResponseOrderInformation', 'model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsRefundPost201ResponseProcessorInformation', 'model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails', 'model/PtsV2PaymentsRefundPost400Response', 'model/PtsV2PaymentsReversalsPost201Response', 'model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation', 'model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails', 'model/PtsV2PaymentsReversalsPost400Response', 'model/PtsV2PaymentsVoidsPost201Response', 'model/PtsV2PaymentsVoidsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails', 'model/PtsV2PaymentsVoidsPost400Response', 'model/PtsV2PayoutsPost201Response', 'model/PtsV2PayoutsPost201ResponseErrorInformation', 'model/PtsV2PayoutsPost201ResponseIssuerInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor', 'model/PtsV2PayoutsPost201ResponseOrderInformation', 'model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PayoutsPost201ResponseProcessorInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformationCard', 'model/PtsV2PayoutsPost400Response', 'model/Ptsv1pushfundstransferAggregatorInformation', 'model/Ptsv1pushfundstransferAggregatorInformationSubMerchant', 'model/Ptsv1pushfundstransferClientReferenceInformation', 'model/Ptsv1pushfundstransferMerchantDefinedInformation', 'model/Ptsv1pushfundstransferMerchantInformation', 'model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor', 'model/Ptsv1pushfundstransferOrderInformation', 'model/Ptsv1pushfundstransferOrderInformationAmountDetails', 'model/Ptsv1pushfundstransferOrderInformationSurcharge', 'model/Ptsv1pushfundstransferPointOfServiceInformation', 'model/Ptsv1pushfundstransferProcessingInformation', 'model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions', 'model/Ptsv1pushfundstransferProcessingInformationRecurringOptions', 'model/Ptsv1pushfundstransferProcessingOptions', 'model/Ptsv1pushfundstransferProcessingOptionsFundingOptions', 'model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator', 'model/Ptsv1pushfundstransferRecipientInformation', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformation', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument', 'model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification', 'model/Ptsv1pushfundstransferSenderInformation', 'model/Ptsv1pushfundstransferSenderInformationAccount', 'model/Ptsv1pushfundstransferSenderInformationPaymentInformation', 'model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard', 'model/Ptsv1pushfundstransferSenderInformationPersonalIdentification', 'model/Ptsv2billingagreementsAggregatorInformation', 'model/Ptsv2billingagreementsAgreementInformation', 'model/Ptsv2billingagreementsBuyerInformation', 'model/Ptsv2billingagreementsClientReferenceInformation', 'model/Ptsv2billingagreementsConsumerAuthenticationInformation', 'model/Ptsv2billingagreementsDeviceInformation', 'model/Ptsv2billingagreementsInstallmentInformation', 'model/Ptsv2billingagreementsMerchantInformation', 'model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor', 'model/Ptsv2billingagreementsOrderInformation', 'model/Ptsv2billingagreementsOrderInformationBillTo', 'model/Ptsv2billingagreementsPaymentInformation', 'model/Ptsv2billingagreementsPaymentInformationBank', 'model/Ptsv2billingagreementsPaymentInformationBankAccount', 'model/Ptsv2billingagreementsPaymentInformationCard', 'model/Ptsv2billingagreementsPaymentInformationPaymentType', 'model/Ptsv2billingagreementsPaymentInformationPaymentTypeMethod', 'model/Ptsv2billingagreementsPaymentInformationTokenizedCard', 'model/Ptsv2billingagreementsProcessingInformation', 'model/Ptsv2billingagreementsidAgreementInformation', 'model/Ptsv2billingagreementsidBuyerInformation', 'model/Ptsv2billingagreementsidProcessingInformation', 'model/Ptsv2creditsInstallmentInformation', 'model/Ptsv2creditsProcessingInformation', 'model/Ptsv2creditsProcessingInformationBankTransferOptions', 'model/Ptsv2creditsProcessingInformationElectronicBenefitsTransfer', 'model/Ptsv2creditsProcessingInformationJapanPaymentOptions', 'model/Ptsv2creditsProcessingInformationPurchaseOptions', 'model/Ptsv2creditsProcessingInformationRefundOptions', 'model/Ptsv2creditsRecipientInformation', 'model/Ptsv2creditsSenderInformation', 'model/Ptsv2creditsSenderInformationAccount', 'model/Ptsv2paymentreferencesAgreementInformation', 'model/Ptsv2paymentreferencesBuyerInformation', 'model/Ptsv2paymentreferencesDeviceInformation', 'model/Ptsv2paymentreferencesMerchantInformation', 'model/Ptsv2paymentreferencesOrderInformation', 'model/Ptsv2paymentreferencesOrderInformationAmountDetails', 'model/Ptsv2paymentreferencesOrderInformationBillTo', 'model/Ptsv2paymentreferencesOrderInformationInvoiceDetails', 'model/Ptsv2paymentreferencesOrderInformationLineItems', 'model/Ptsv2paymentreferencesOrderInformationShipTo', 'model/Ptsv2paymentreferencesPaymentInformation', 'model/Ptsv2paymentreferencesPaymentInformationBank', 'model/Ptsv2paymentreferencesPaymentInformationBankAccount', 'model/Ptsv2paymentreferencesPaymentInformationCard', 'model/Ptsv2paymentreferencesPaymentInformationEWallet', 'model/Ptsv2paymentreferencesPaymentInformationOptions', 'model/Ptsv2paymentreferencesProcessingInformation', 'model/Ptsv2paymentreferencesTravelInformation', 'model/Ptsv2paymentreferencesTravelInformationAutoRental', 'model/Ptsv2paymentreferencesUserInterface', 'model/Ptsv2paymentreferencesUserInterfaceColor', 'model/Ptsv2paymentreferencesidintentsOrderInformation', 'model/Ptsv2paymentreferencesidintentsPaymentInformation', 'model/Ptsv2paymentreferencesidintentsPaymentInformationEWallet', 'model/Ptsv2paymentreferencesidintentsProcessingInformation', 'model/Ptsv2paymentsAcquirerInformation', 'model/Ptsv2paymentsAggregatorInformation', 'model/Ptsv2paymentsAggregatorInformationSubMerchant', 'model/Ptsv2paymentsAgreementInformation', 'model/Ptsv2paymentsBuyerInformation', 'model/Ptsv2paymentsBuyerInformationPersonalIdentification', 'model/Ptsv2paymentsClientReferenceInformation', 'model/Ptsv2paymentsClientReferenceInformationPartner', 'model/Ptsv2paymentsConsumerAuthenticationInformation', 'model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication', 'model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation', 'model/Ptsv2paymentsDeviceInformation', 'model/Ptsv2paymentsDeviceInformationRawData', 'model/Ptsv2paymentsHealthCareInformation', 'model/Ptsv2paymentsHealthCareInformationAmountDetails', 'model/Ptsv2paymentsHostedPaymentInformation', 'model/Ptsv2paymentsHostedPaymentInformationUserAgent', 'model/Ptsv2paymentsInstallmentInformation', 'model/Ptsv2paymentsInvoiceDetails', 'model/Ptsv2paymentsIssuerInformation', 'model/Ptsv2paymentsMerchantDefinedInformation', 'model/Ptsv2paymentsMerchantDefinedSecureInformation', 'model/Ptsv2paymentsMerchantInformation', 'model/Ptsv2paymentsMerchantInformationMerchantDescriptor', 'model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor', 'model/Ptsv2paymentsMerchantInformationServiceLocation', 'model/Ptsv2paymentsOrderInformation', 'model/Ptsv2paymentsOrderInformationAmountDetails', 'model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts', 'model/Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion', 'model/Ptsv2paymentsOrderInformationAmountDetailsOrder', 'model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails', 'model/Ptsv2paymentsOrderInformationBillTo', 'model/Ptsv2paymentsOrderInformationBillToCompany', 'model/Ptsv2paymentsOrderInformationInvoiceDetails', 'model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum', 'model/Ptsv2paymentsOrderInformationLineItems', 'model/Ptsv2paymentsOrderInformationPassenger', 'model/Ptsv2paymentsOrderInformationShipTo', 'model/Ptsv2paymentsOrderInformationShippingDetails', 'model/Ptsv2paymentsPaymentInformation', 'model/Ptsv2paymentsPaymentInformationBank', 'model/Ptsv2paymentsPaymentInformationBankAccount', 'model/Ptsv2paymentsPaymentInformationCard', 'model/Ptsv2paymentsPaymentInformationCustomer', 'model/Ptsv2paymentsPaymentInformationDirectDebit', 'model/Ptsv2paymentsPaymentInformationDirectDebitMandate', 'model/Ptsv2paymentsPaymentInformationEWallet', 'model/Ptsv2paymentsPaymentInformationFluidData', 'model/Ptsv2paymentsPaymentInformationInstrumentIdentifier', 'model/Ptsv2paymentsPaymentInformationLegacyToken', 'model/Ptsv2paymentsPaymentInformationOptions', 'model/Ptsv2paymentsPaymentInformationPaymentInstrument', 'model/Ptsv2paymentsPaymentInformationPaymentType', 'model/Ptsv2paymentsPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsPaymentInformationSepa', 'model/Ptsv2paymentsPaymentInformationSepaDirectDebit', 'model/Ptsv2paymentsPaymentInformationShippingAddress', 'model/Ptsv2paymentsPaymentInformationTokenizedCard', 'model/Ptsv2paymentsPointOfSaleInformation', 'model/Ptsv2paymentsPointOfSaleInformationEmv', 'model/Ptsv2paymentsProcessingInformation', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/Ptsv2paymentsProcessingInformationBankTransferOptions', 'model/Ptsv2paymentsProcessingInformationCaptureOptions', 'model/Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer', 'model/Ptsv2paymentsProcessingInformationJapanPaymentOptions', 'model/Ptsv2paymentsProcessingInformationLoanOptions', 'model/Ptsv2paymentsProcessingInformationPurchaseOptions', 'model/Ptsv2paymentsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsProcessorInformation', 'model/Ptsv2paymentsProcessorInformationAuthorizationOptions', 'model/Ptsv2paymentsProcessorInformationReversal', 'model/Ptsv2paymentsPromotionInformation', 'model/Ptsv2paymentsRecipientInformation', 'model/Ptsv2paymentsRecurringPaymentInformation', 'model/Ptsv2paymentsRiskInformation', 'model/Ptsv2paymentsRiskInformationAuxiliaryData', 'model/Ptsv2paymentsRiskInformationBuyerHistory', 'model/Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory', 'model/Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount', 'model/Ptsv2paymentsRiskInformationProfile', 'model/Ptsv2paymentsTokenInformation', 'model/Ptsv2paymentsTokenInformationPaymentInstrument', 'model/Ptsv2paymentsTokenInformationShippingAddress', 'model/Ptsv2paymentsTravelInformation', 'model/Ptsv2paymentsTravelInformationAgency', 'model/Ptsv2paymentsTravelInformationAutoRental', 'model/Ptsv2paymentsTravelInformationAutoRentalRentalAddress', 'model/Ptsv2paymentsTravelInformationAutoRentalReturnAddress', 'model/Ptsv2paymentsTravelInformationAutoRentalTaxDetails', 'model/Ptsv2paymentsTravelInformationLodging', 'model/Ptsv2paymentsTravelInformationLodgingRoom', 'model/Ptsv2paymentsTravelInformationTransit', 'model/Ptsv2paymentsTravelInformationTransitAirline', 'model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation', 'model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService', 'model/Ptsv2paymentsTravelInformationTransitAirlineLegs', 'model/Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer', 'model/Ptsv2paymentsTravelInformationVehicleData', 'model/Ptsv2paymentsWatchlistScreeningInformation', 'model/Ptsv2paymentsWatchlistScreeningInformationWeights', 'model/Ptsv2paymentsidClientReferenceInformation', 'model/Ptsv2paymentsidClientReferenceInformationPartner', 'model/Ptsv2paymentsidMerchantInformation', 'model/Ptsv2paymentsidOrderInformation', 'model/Ptsv2paymentsidOrderInformationAmountDetails', 'model/Ptsv2paymentsidProcessingInformation', 'model/Ptsv2paymentsidProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator', 'model/Ptsv2paymentsidTravelInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant', 'model/Ptsv2paymentsidcapturesBuyerInformation', 'model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification', 'model/Ptsv2paymentsidcapturesDeviceInformation', 'model/Ptsv2paymentsidcapturesInstallmentInformation', 'model/Ptsv2paymentsidcapturesMerchantInformation', 'model/Ptsv2paymentsidcapturesOrderInformation', 'model/Ptsv2paymentsidcapturesOrderInformationAmountDetails', 'model/Ptsv2paymentsidcapturesOrderInformationBillTo', 'model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails', 'model/Ptsv2paymentsidcapturesOrderInformationShipTo', 'model/Ptsv2paymentsidcapturesOrderInformationShippingDetails', 'model/Ptsv2paymentsidcapturesPaymentInformation', 'model/Ptsv2paymentsidcapturesPaymentInformationCard', 'model/Ptsv2paymentsidcapturesPaymentInformationPaymentType', 'model/Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsidcapturesPointOfSaleInformation', 'model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv', 'model/Ptsv2paymentsidcapturesProcessingInformation', 'model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions', 'model/Ptsv2paymentsidrefundsClientReferenceInformation', 'model/Ptsv2paymentsidrefundsMerchantInformation', 'model/Ptsv2paymentsidrefundsOrderInformation', 'model/Ptsv2paymentsidrefundsOrderInformationLineItems', 'model/Ptsv2paymentsidrefundsPaymentInformation', 'model/Ptsv2paymentsidrefundsPaymentInformationBank', 'model/Ptsv2paymentsidrefundsPaymentInformationBankAccount', 'model/Ptsv2paymentsidrefundsPaymentInformationCard', 'model/Ptsv2paymentsidrefundsPaymentInformationEWallet', 'model/Ptsv2paymentsidrefundsPaymentInformationPaymentType', 'model/Ptsv2paymentsidrefundsPointOfSaleInformation', 'model/Ptsv2paymentsidrefundsProcessingInformation', 'model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsidrefundsProcessingInformationRefundOptions', 'model/Ptsv2paymentsidreversalsClientReferenceInformation', 'model/Ptsv2paymentsidreversalsClientReferenceInformationPartner', 'model/Ptsv2paymentsidreversalsOrderInformation', 'model/Ptsv2paymentsidreversalsOrderInformationAmountDetails', 'model/Ptsv2paymentsidreversalsOrderInformationLineItems', 'model/Ptsv2paymentsidreversalsPaymentInformation', 'model/Ptsv2paymentsidreversalsPaymentInformationPaymentType', 'model/Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsidreversalsPointOfSaleInformation', 'model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv', 'model/Ptsv2paymentsidreversalsProcessingInformation', 'model/Ptsv2paymentsidreversalsReversalInformation', 'model/Ptsv2paymentsidreversalsReversalInformationAmountDetails', 'model/Ptsv2paymentsidvoidsAgreementInformation', 'model/Ptsv2paymentsidvoidsMerchantInformation', 'model/Ptsv2paymentsidvoidsOrderInformation', 'model/Ptsv2paymentsidvoidsPaymentInformation', 'model/Ptsv2paymentsidvoidsProcessingInformation', 'model/Ptsv2payoutsClientReferenceInformation', 'model/Ptsv2payoutsMerchantInformation', 'model/Ptsv2payoutsMerchantInformationMerchantDescriptor', 'model/Ptsv2payoutsOrderInformation', 'model/Ptsv2payoutsOrderInformationAmountDetails', 'model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2payoutsOrderInformationBillTo', 'model/Ptsv2payoutsPaymentInformation', 'model/Ptsv2payoutsPaymentInformationCard', 'model/Ptsv2payoutsProcessingInformation', 'model/Ptsv2payoutsProcessingInformationFundingOptions', 'model/Ptsv2payoutsProcessingInformationFundingOptionsInitiator', 'model/Ptsv2payoutsProcessingInformationPayoutsOptions', 'model/Ptsv2payoutsRecipientInformation', 'model/Ptsv2payoutsSenderInformation', 'model/Ptsv2payoutsSenderInformationAccount', 'model/Ptsv2refreshpaymentstatusidAgreementInformation', 'model/Ptsv2refreshpaymentstatusidClientReferenceInformation', 'model/Ptsv2refreshpaymentstatusidPaymentInformation', 'model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer', 'model/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType', 'model/Ptsv2refreshpaymentstatusidProcessingInformation', 'model/Ptsv2voidsProcessingInformation', 'model/PushFunds201Response', 'model/PushFunds201ResponseClientReferenceInformation', 'model/PushFunds201ResponseErrorInformation', 'model/PushFunds201ResponseErrorInformationDetails', 'model/PushFunds201ResponseLinks', 'model/PushFunds201ResponseLinksCustomer', 'model/PushFunds201ResponseLinksInstrumentIdentifier', 'model/PushFunds201ResponseLinksPaymentInstrument', 'model/PushFunds201ResponseLinksSelf', 'model/PushFunds201ResponseMerchantInformation', 'model/PushFunds201ResponseMerchantInformationMerchantDescriptor', 'model/PushFunds201ResponseOrderInformation', 'model/PushFunds201ResponseOrderInformationAmountDetails', 'model/PushFunds201ResponseProcessorInformation', 'model/PushFunds201ResponseRecipientInformation', 'model/PushFunds201ResponseRecipientInformationCard', 'model/PushFunds400Response', 'model/PushFunds400ResponseDetails', 'model/PushFunds401Response', 'model/PushFunds404Response', 'model/PushFunds502Response', 'model/PushFundsRequest', 'model/Rbsv1plansClientReferenceInformation', 'model/Rbsv1plansOrderInformation', 'model/Rbsv1plansOrderInformationAmountDetails', 'model/Rbsv1plansPlanInformation', 'model/Rbsv1plansPlanInformationBillingCycles', 'model/Rbsv1plansidPlanInformation', 'model/Rbsv1plansidProcessingInformation', 'model/Rbsv1plansidProcessingInformationSubscriptionBillingOptions', 'model/Rbsv1subscriptionsClientReferenceInformation', 'model/Rbsv1subscriptionsPaymentInformation', 'model/Rbsv1subscriptionsPaymentInformationCustomer', 'model/Rbsv1subscriptionsPlanInformation', 'model/Rbsv1subscriptionsProcessingInformation', 'model/Rbsv1subscriptionsProcessingInformationAuthorizationOptions', 'model/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator', 'model/Rbsv1subscriptionsSubscriptionInformation', 'model/Rbsv1subscriptionsidOrderInformation', 'model/Rbsv1subscriptionsidOrderInformationAmountDetails', 'model/Rbsv1subscriptionsidPlanInformation', 'model/Rbsv1subscriptionsidSubscriptionInformation', 'model/RefreshPaymentStatusRequest', 'model/RefundCaptureRequest', 'model/RefundPaymentRequest', 'model/ReplayWebhooksRequest', 'model/ReportingV3ChargebackDetailsGet200Response', 'model/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails', 'model/ReportingV3ChargebackSummariesGet200Response', 'model/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries', 'model/ReportingV3ConversionDetailsGet200Response', 'model/ReportingV3ConversionDetailsGet200ResponseConversionDetails', 'model/ReportingV3ConversionDetailsGet200ResponseNotes', 'model/ReportingV3InterchangeClearingLevelDetailsGet200Response', 'model/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails', 'model/ReportingV3NetFundingsGet200Response', 'model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries', 'model/ReportingV3NetFundingsGet200ResponseTotalPurchases', 'model/ReportingV3NotificationofChangesGet200Response', 'model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges', 'model/ReportingV3PaymentBatchSummariesGet200Response', 'model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries', 'model/ReportingV3PurchaseRefundDetailsGet200Response', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements', 'model/ReportingV3ReportDefinitionsGet200Response', 'model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions', 'model/ReportingV3ReportDefinitionsNameGet200Response', 'model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes', 'model/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings', 'model/ReportingV3ReportSubscriptionsGet200Response', 'model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions', 'model/ReportingV3ReportsGet200Response', 'model/ReportingV3ReportsGet200ResponseLink', 'model/ReportingV3ReportsGet200ResponseLinkReportDownload', 'model/ReportingV3ReportsGet200ResponseReportSearchResults', 'model/ReportingV3ReportsIdGet200Response', 'model/ReportingV3RetrievalDetailsGet200Response', 'model/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails', 'model/ReportingV3RetrievalSummariesGet200Response', 'model/Reportingv3ReportDownloadsGet400Response', 'model/Reportingv3ReportDownloadsGet400ResponseDetails', 'model/Reportingv3reportsReportFilters', 'model/Reportingv3reportsReportPreferences', 'model/RiskProducts', 'model/RiskProductsDecisionManager', 'model/RiskProductsDecisionManagerConfigurationInformation', 'model/RiskProductsFraudManagementEssentials', 'model/RiskProductsFraudManagementEssentialsConfigurationInformation', 'model/RiskV1AddressVerificationsPost201Response', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1', 'model/RiskV1AddressVerificationsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationResultsPost201Response', 'model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationSetupsPost201Response', 'model/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationSetupsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationsPost201Response', 'model/RiskV1AuthenticationsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationsPost400Response', 'model/RiskV1AuthenticationsPost400Response1', 'model/RiskV1DecisionsPost201Response', 'model/RiskV1DecisionsPost201ResponseClientReferenceInformation', 'model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1DecisionsPost201ResponseErrorInformation', 'model/RiskV1DecisionsPost201ResponseOrderInformation', 'model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails', 'model/RiskV1DecisionsPost201ResponsePaymentInformation', 'model/RiskV1DecisionsPost400Response', 'model/RiskV1DecisionsPost400Response1', 'model/RiskV1ExportComplianceInquiriesPost201Response', 'model/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation', 'model/RiskV1UpdatePost201Response', 'model/Riskv1addressverificationsBuyerInformation', 'model/Riskv1addressverificationsOrderInformation', 'model/Riskv1addressverificationsOrderInformationBillTo', 'model/Riskv1addressverificationsOrderInformationLineItems', 'model/Riskv1addressverificationsOrderInformationShipTo', 'model/Riskv1authenticationresultsConsumerAuthenticationInformation', 'model/Riskv1authenticationresultsDeviceInformation', 'model/Riskv1authenticationresultsOrderInformation', 'model/Riskv1authenticationresultsOrderInformationAmountDetails', 'model/Riskv1authenticationresultsPaymentInformation', 'model/Riskv1authenticationresultsPaymentInformationCard', 'model/Riskv1authenticationresultsPaymentInformationFluidData', 'model/Riskv1authenticationresultsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsBuyerInformation', 'model/Riskv1authenticationsDeviceInformation', 'model/Riskv1authenticationsOrderInformation', 'model/Riskv1authenticationsOrderInformationAmountDetails', 'model/Riskv1authenticationsOrderInformationBillTo', 'model/Riskv1authenticationsOrderInformationLineItems', 'model/Riskv1authenticationsPaymentInformation', 'model/Riskv1authenticationsPaymentInformationCard', 'model/Riskv1authenticationsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsRiskInformation', 'model/Riskv1authenticationsTravelInformation', 'model/Riskv1authenticationsetupsPaymentInformation', 'model/Riskv1authenticationsetupsPaymentInformationCard', 'model/Riskv1authenticationsetupsPaymentInformationCustomer', 'model/Riskv1authenticationsetupsPaymentInformationFluidData', 'model/Riskv1authenticationsetupsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsetupsProcessingInformation', 'model/Riskv1authenticationsetupsTokenInformation', 'model/Riskv1decisionsAcquirerInformation', 'model/Riskv1decisionsBuyerInformation', 'model/Riskv1decisionsClientReferenceInformation', 'model/Riskv1decisionsClientReferenceInformationPartner', 'model/Riskv1decisionsConsumerAuthenticationInformation', 'model/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication', 'model/Riskv1decisionsDeviceInformation', 'model/Riskv1decisionsMerchantDefinedInformation', 'model/Riskv1decisionsMerchantInformation', 'model/Riskv1decisionsMerchantInformationMerchantDescriptor', 'model/Riskv1decisionsOrderInformation', 'model/Riskv1decisionsOrderInformationAmountDetails', 'model/Riskv1decisionsOrderInformationBillTo', 'model/Riskv1decisionsOrderInformationLineItems', 'model/Riskv1decisionsOrderInformationShipTo', 'model/Riskv1decisionsOrderInformationShippingDetails', 'model/Riskv1decisionsPaymentInformation', 'model/Riskv1decisionsPaymentInformationCard', 'model/Riskv1decisionsPaymentInformationTokenizedCard', 'model/Riskv1decisionsProcessingInformation', 'model/Riskv1decisionsProcessorInformation', 'model/Riskv1decisionsProcessorInformationAvs', 'model/Riskv1decisionsProcessorInformationCardVerification', 'model/Riskv1decisionsRiskInformation', 'model/Riskv1decisionsTokenInformation', 'model/Riskv1decisionsTravelInformation', 'model/Riskv1decisionsTravelInformationLegs', 'model/Riskv1decisionsTravelInformationPassengers', 'model/Riskv1decisionsidactionsDecisionInformation', 'model/Riskv1decisionsidactionsProcessingInformation', 'model/Riskv1decisionsidmarkingRiskInformation', 'model/Riskv1decisionsidmarkingRiskInformationMarkingDetails', 'model/Riskv1exportcomplianceinquiriesDeviceInformation', 'model/Riskv1exportcomplianceinquiriesExportComplianceInformation', 'model/Riskv1exportcomplianceinquiriesOrderInformation', 'model/Riskv1exportcomplianceinquiriesOrderInformationBillTo', 'model/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany', 'model/Riskv1exportcomplianceinquiriesOrderInformationLineItems', 'model/Riskv1exportcomplianceinquiriesOrderInformationShipTo', 'model/Riskv1liststypeentriesBuyerInformation', 'model/Riskv1liststypeentriesClientReferenceInformation', 'model/Riskv1liststypeentriesDeviceInformation', 'model/Riskv1liststypeentriesOrderInformation', 'model/Riskv1liststypeentriesOrderInformationAddress', 'model/Riskv1liststypeentriesOrderInformationBillTo', 'model/Riskv1liststypeentriesOrderInformationLineItems', 'model/Riskv1liststypeentriesOrderInformationShipTo', 'model/Riskv1liststypeentriesPaymentInformation', 'model/Riskv1liststypeentriesPaymentInformationBank', 'model/Riskv1liststypeentriesPaymentInformationCard', 'model/Riskv1liststypeentriesRiskInformation', 'model/Riskv1liststypeentriesRiskInformationMarkingDetails', 'model/SAConfig', 'model/SAConfigCheckout', 'model/SAConfigContactInformation', 'model/SAConfigNotifications', 'model/SAConfigNotificationsCustomerNotifications', 'model/SAConfigNotificationsMerchantNotifications', 'model/SAConfigPaymentMethods', 'model/SAConfigPaymentTypes', 'model/SAConfigPaymentTypesCardTypes', 'model/SAConfigPaymentTypesCardTypesDiscover', 'model/SAConfigService', 'model/SaveAsymEgressKey', 'model/SaveSymEgressKey', 'model/SearchRequest', 'model/ShippingAddressListForCustomer', 'model/ShippingAddressListForCustomerEmbedded', 'model/ShippingAddressListForCustomerLinks', 'model/ShippingAddressListForCustomerLinksFirst', 'model/ShippingAddressListForCustomerLinksLast', 'model/ShippingAddressListForCustomerLinksNext', 'model/ShippingAddressListForCustomerLinksPrev', 'model/ShippingAddressListForCustomerLinksSelf', 'model/SuspendSubscriptionResponse', 'model/SuspendSubscriptionResponseSubscriptionInformation', 'model/TaxRequest', 'model/TmsAuthorizationOptions', 'model/TmsAuthorizationOptionsInitiator', 'model/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/TmsEmbeddedInstrumentIdentifier', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments', 'model/TmsEmbeddedInstrumentIdentifierLinksSelf', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCardCard', 'model/TmsPaymentInstrumentProcessingInfo', 'model/TmsPaymentInstrumentProcessingInfoBankTransferOptions', 'model/Tmsv2customersBuyerInformation', 'model/Tmsv2customersClientReferenceInformation', 'model/Tmsv2customersDefaultPaymentInstrument', 'model/Tmsv2customersDefaultShippingAddress', 'model/Tmsv2customersEmbedded', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrument', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', 'model/Tmsv2customersEmbeddedDefaultShippingAddress', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinks', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf', 'model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata', 'model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo', 'model/Tmsv2customersLinks', 'model/Tmsv2customersLinksPaymentInstruments', 'model/Tmsv2customersLinksSelf', 'model/Tmsv2customersLinksShippingAddress', 'model/Tmsv2customersMerchantDefinedInformation', 'model/Tmsv2customersMetadata', 'model/Tmsv2customersObjectInformation', 'model/TssV2GetEmvTags200Response', 'model/TssV2GetEmvTags200ResponseEmvTagBreakdownList', 'model/TssV2PostEmvTags200Response', 'model/TssV2PostEmvTags200ResponseEmvTagBreakdownList', 'model/TssV2PostEmvTags200ResponseParsedEMVTagsList', 'model/TssV2TransactionsGet200Response', 'model/TssV2TransactionsGet200ResponseApplicationInformation', 'model/TssV2TransactionsGet200ResponseApplicationInformationApplications', 'model/TssV2TransactionsGet200ResponseBuyerInformation', 'model/TssV2TransactionsGet200ResponseClientReferenceInformation', 'model/TssV2TransactionsGet200ResponseClientReferenceInformationPartner', 'model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation', 'model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication', 'model/TssV2TransactionsGet200ResponseDeviceInformation', 'model/TssV2TransactionsGet200ResponseErrorInformation', 'model/TssV2TransactionsGet200ResponseFraudMarkingInformation', 'model/TssV2TransactionsGet200ResponseInstallmentInformation', 'model/TssV2TransactionsGet200ResponseLinks', 'model/TssV2TransactionsGet200ResponseMerchantInformation', 'model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor', 'model/TssV2TransactionsGet200ResponseOrderInformation', 'model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails', 'model/TssV2TransactionsGet200ResponseOrderInformationBillTo', 'model/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails', 'model/TssV2TransactionsGet200ResponseOrderInformationLineItems', 'model/TssV2TransactionsGet200ResponseOrderInformationShipTo', 'model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails', 'model/TssV2TransactionsGet200ResponsePaymentInformation', 'model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures', 'model/TssV2TransactionsGet200ResponsePaymentInformationBank', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate', 'model/TssV2TransactionsGet200ResponsePaymentInformationBrands', 'model/TssV2TransactionsGet200ResponsePaymentInformationCard', 'model/TssV2TransactionsGet200ResponsePaymentInformationCustomer', 'model/TssV2TransactionsGet200ResponsePaymentInformationFeatures', 'model/TssV2TransactionsGet200ResponsePaymentInformationFluidData', 'model/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier', 'model/TssV2TransactionsGet200ResponsePaymentInformationInvoice', 'model/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation', 'model/TssV2TransactionsGet200ResponsePaymentInformationNetwork', 'model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType', 'model/TssV2TransactionsGet200ResponsePayoutOptions', 'model/TssV2TransactionsGet200ResponsePointOfSaleInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator', 'model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions', 'model/TssV2TransactionsGet200ResponseProcessorInformation', 'model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults', 'model/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting', 'model/TssV2TransactionsGet200ResponseProcessorInformationProcessor', 'model/TssV2TransactionsGet200ResponseRecurringPaymentInformation', 'model/TssV2TransactionsGet200ResponseRiskInformation', 'model/TssV2TransactionsGet200ResponseRiskInformationProfile', 'model/TssV2TransactionsGet200ResponseRiskInformationRules', 'model/TssV2TransactionsGet200ResponseRiskInformationScore', 'model/TssV2TransactionsGet200ResponseSenderInformation', 'model/TssV2TransactionsGet200ResponseTokenInformation', 'model/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation', 'model/TssV2TransactionsPost201Response', 'model/TssV2TransactionsPost201ResponseEmbedded', 'model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications', 'model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner', 'model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedLinks', 'model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType', 'model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint', 'model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries', 'model/TssV2TransactionsPost400Response', 'model/Tssv2transactionsemvTagDetailsEmvDetailsList', 'model/UmsV1UsersGet200Response', 'model/UmsV1UsersGet200ResponseAccountInformation', 'model/UmsV1UsersGet200ResponseContactInformation', 'model/UmsV1UsersGet200ResponseOrganizationInformation', 'model/UmsV1UsersGet200ResponseUsers', 'model/UpdateAsymKeysRequest', 'model/UpdateInvoiceRequest', 'model/UpdatePGPKeysRequest', 'model/UpdatePGPKeysRequest1', 'model/UpdatePasswordKeysRequest', 'model/UpdatePlanRequest', 'model/UpdatePlanResponse', 'model/UpdatePlanResponsePlanInformation', 'model/UpdateSubscription', 'model/UpdateSubscriptionResponse', 'model/UpdateWebhookRequest', 'model/Upv1capturecontextsCaptureMandate', 'model/Upv1capturecontextsCheckoutApiInitialization', 'model/Upv1capturecontextsOrderInformation', 'model/Upv1capturecontextsOrderInformationAmountDetails', 'model/Upv1capturecontextsOrderInformationBillTo', 'model/Upv1capturecontextsOrderInformationBillToCompany', 'model/Upv1capturecontextsOrderInformationShipTo', 'model/V1FileDetailsGet200Response', 'model/V1FileDetailsGet200ResponseFileDetails', 'model/V1FileDetailsGet200ResponseLinks', 'model/V1FileDetailsGet200ResponseLinksFiles', 'model/V1FileDetailsGet200ResponseLinksSelf', 'model/VTConfig', 'model/VTConfigCardNotPresent', 'model/VTConfigCardNotPresentGlobalPaymentInformation', 'model/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation', 'model/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields', 'model/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation', 'model/VTConfigCardNotPresentReceiptInformation', 'model/VTConfigCardNotPresentReceiptInformationEmailReceipt', 'model/VTConfigCardNotPresentReceiptInformationHeader', 'model/VTConfigCardNotPresentReceiptInformationOrderInformation', 'model/ValidateExportComplianceRequest', 'model/ValidateRequest', 'model/ValueAddedServicesProducts', 'model/VasV2PaymentsPost201Response', 'model/VasV2PaymentsPost201ResponseLinks', 'model/VasV2PaymentsPost201ResponseOrderInformation', 'model/VasV2PaymentsPost201ResponseOrderInformationJurisdiction', 'model/VasV2PaymentsPost201ResponseOrderInformationLineItems', 'model/VasV2PaymentsPost201ResponseOrderInformationTaxDetails', 'model/VasV2PaymentsPost201ResponseTaxInformation', 'model/VasV2PaymentsPost400Response', 'model/VasV2TaxVoid200Response', 'model/VasV2TaxVoid200ResponseVoidAmountDetails', 'model/VasV2TaxVoidsPost400Response', 'model/Vasv2taxBuyerInformation', 'model/Vasv2taxClientReferenceInformation', 'model/Vasv2taxMerchantInformation', 'model/Vasv2taxOrderInformation', 'model/Vasv2taxOrderInformationBillTo', 'model/Vasv2taxOrderInformationInvoiceDetails', 'model/Vasv2taxOrderInformationLineItems', 'model/Vasv2taxOrderInformationOrderAcceptance', 'model/Vasv2taxOrderInformationOrderOrigin', 'model/Vasv2taxOrderInformationShipTo', 'model/Vasv2taxOrderInformationShippingDetails', 'model/Vasv2taxTaxInformation', 'model/Vasv2taxidClientReferenceInformation', 'model/Vasv2taxidClientReferenceInformationPartner', 'model/VerifyCustomerAddressRequest', 'model/VoidCaptureRequest', 'model/VoidCreditRequest', 'model/VoidPaymentRequest', 'model/VoidRefundRequest', 'model/VoidTaxRequest', 'model/AccessTokenResponse', 'model/BadRequestError', 'model/CreateAccessTokenRequest', 'model/ResourceNotFoundError', 'model/UnauthorizedClientError', 'api/AsymmetricKeyManagementApi', 'api/BatchesApi', 'api/BillingAgreementsApi', 'api/CaptureApi', 'api/ChargebackDetailsApi', 'api/ChargebackSummariesApi', 'api/ConversionDetailsApi', 'api/CreateNewWebhooksApi', 'api/CreditApi', 'api/CustomerApi', 'api/CustomerPaymentInstrumentApi', 'api/CustomerShippingAddressApi', 'api/DecisionManagerApi', 'api/DownloadDTDApi', 'api/DownloadXSDApi', 'api/EMVTagDetailsApi', 'api/InstrumentIdentifierApi', 'api/InterchangeClearingLevelDetailsApi', 'api/InvoiceSettingsApi', 'api/InvoicesApi', 'api/KeyManagementApi', 'api/KeyManagementPasswordApi', 'api/KeyManagementPgpApi', 'api/KeyManagementScmpApi', 'api/ManageWebhooksApi', 'api/MerchantBoardingApi', 'api/MicroformIntegrationApi', 'api/NetFundingsApi', 'api/NotificationOfChangesApi', 'api/PayerAuthenticationApi', 'api/PaymentBatchSummariesApi', 'api/PaymentInstrumentApi', 'api/PaymentsApi', 'api/PayoutsApi', 'api/PlansApi', 'api/PurchaseAndRefundDetailsApi', 'api/PushFundsApi', 'api/RefundApi', 'api/ReplayWebhooksApi', 'api/ReportDefinitionsApi', 'api/ReportDownloadsApi', 'api/ReportSubscriptionsApi', 'api/ReportsApi', 'api/RetrievalDetailsApi', 'api/RetrievalSummariesApi', 'api/ReversalApi', 'api/SearchTransactionsApi', 'api/SecureFileShareApi', 'api/SubscriptionsApi', 'api/SymmetricKeyManagementApi', 'api/TaxesApi', 'api/TokenApi', 'api/TransactionBatchesApi', 'api/TransactionDetailsApi', 'api/TransientTokenDataApi', 'api/UnifiedCheckoutCaptureContextApi', 'api/UserManagementApi', 'api/UserManagementSearchApi', 'api/VerificationApi', 'api/VoidApi', 'api/OAuthApi'], factory); + define(['ApiClient', 'model/Accountupdaterv1batchesIncluded', 'model/Accountupdaterv1batchesIncludedTokens', 'model/ActivateDeactivatePlanResponse', 'model/ActivateSubscriptionResponse', 'model/ActivateSubscriptionResponseSubscriptionInformation', 'model/AddNegativeListRequest', 'model/AuthReversalRequest', 'model/Boardingv1registrationsDocumentInformation', 'model/Boardingv1registrationsDocumentInformationSignedDocuments', 'model/Boardingv1registrationsIntegrationInformation', 'model/Boardingv1registrationsIntegrationInformationOauth2', 'model/Boardingv1registrationsIntegrationInformationTenantConfigurations', 'model/Boardingv1registrationsIntegrationInformationTenantInformation', 'model/Boardingv1registrationsOrganizationInformation', 'model/Boardingv1registrationsOrganizationInformationBusinessInformation', 'model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress', 'model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact', 'model/Boardingv1registrationsOrganizationInformationKYC', 'model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount', 'model/Boardingv1registrationsOrganizationInformationOwners', 'model/Boardingv1registrationsProductInformation', 'model/Boardingv1registrationsProductInformationSelectedProducts', 'model/Boardingv1registrationsRegistrationInformation', 'model/Body', 'model/CancelSubscriptionResponse', 'model/CancelSubscriptionResponseSubscriptionInformation', 'model/CapturePaymentRequest', 'model/CardProcessingConfig', 'model/CardProcessingConfigCommon', 'model/CardProcessingConfigCommonAcquirer', 'model/CardProcessingConfigCommonCurrencies', 'model/CardProcessingConfigCommonCurrencies1', 'model/CardProcessingConfigCommonMerchantDescriptorInformation', 'model/CardProcessingConfigCommonPaymentTypes', 'model/CardProcessingConfigCommonProcessors', 'model/CardProcessingConfigFeatures', 'model/CardProcessingConfigFeaturesCardNotPresent', 'model/CardProcessingConfigFeaturesCardNotPresentInstallment', 'model/CardProcessingConfigFeaturesCardNotPresentPayouts', 'model/CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies', 'model/CardProcessingConfigFeaturesCardNotPresentProcessors', 'model/CardProcessingConfigFeaturesCardPresent', 'model/CardProcessingConfigFeaturesCardPresentProcessors', 'model/CaseManagementActionsRequest', 'model/CaseManagementCommentsRequest', 'model/CheckPayerAuthEnrollmentRequest', 'model/CommerceSolutionsProducts', 'model/CommerceSolutionsProductsAccountUpdater', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformation', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard', 'model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa', 'model/CommerceSolutionsProductsBinLookup', 'model/CommerceSolutionsProductsBinLookupConfigurationInformation', 'model/CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations', 'model/CommerceSolutionsProductsTokenManagement', 'model/CommerceSolutionsProductsTokenManagementConfigurationInformation', 'model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations', 'model/CreateAdhocReportRequest', 'model/CreateBillingAgreement', 'model/CreateBundledDecisionManagerCaseRequest', 'model/CreateCreditRequest', 'model/CreateInvoiceRequest', 'model/CreateP12KeysRequest', 'model/CreatePaymentRequest', 'model/CreatePlanRequest', 'model/CreatePlanResponse', 'model/CreatePlanResponsePlanInformation', 'model/CreateReportSubscriptionRequest', 'model/CreateSearchRequest', 'model/CreateSessionReq', 'model/CreateSessionRequest', 'model/CreateSharedSecretKeysRequest', 'model/CreateSharedSecretKeysVerifiRequest', 'model/CreateSubscriptionRequest', 'model/CreateSubscriptionResponse', 'model/CreateSubscriptionResponseLinks', 'model/CreateSubscriptionResponseSubscriptionInformation', 'model/CreateWebhookRequest', 'model/DeleteBulkP12KeysRequest', 'model/DeleteBulkSymmetricKeysRequest', 'model/DeletePlanResponse', 'model/DmConfig', 'model/DmConfigOrganization', 'model/DmConfigPortfolioControls', 'model/DmConfigProcessingOptions', 'model/DmConfigThirdparty', 'model/DmConfigThirdpartyProvider', 'model/DmConfigThirdpartyProviderAccurint', 'model/DmConfigThirdpartyProviderAccurintCredentials', 'model/DmConfigThirdpartyProviderCredilink', 'model/DmConfigThirdpartyProviderCredilinkCredentials', 'model/DmConfigThirdpartyProviderEkata', 'model/DmConfigThirdpartyProviderEkataCredentials', 'model/DmConfigThirdpartyProviderEmailage', 'model/DmConfigThirdpartyProviderPerseuss', 'model/DmConfigThirdpartyProviderSignifyd', 'model/DmConfigThirdpartyProviderSignifydCredentials', 'model/DmConfigThirdpartyProviderTargus', 'model/DmConfigThirdpartyProviderTargusCredentials', 'model/ECheckConfig', 'model/ECheckConfigCommon', 'model/ECheckConfigCommonInternalOnly', 'model/ECheckConfigCommonInternalOnlyProcessors', 'model/ECheckConfigCommonProcessors', 'model/ECheckConfigFeatures', 'model/ECheckConfigFeaturesAccountValidationService', 'model/ECheckConfigFeaturesAccountValidationServiceInternalOnly', 'model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors', 'model/ECheckConfigFeaturesAccountValidationServiceProcessors', 'model/ECheckConfigUnderwriting', 'model/FraudMarkingActionRequest', 'model/GenerateCaptureContextRequest', 'model/GenerateUnifiedCheckoutCaptureContextRequest', 'model/GetAllPlansResponse', 'model/GetAllPlansResponseLinks', 'model/GetAllPlansResponseOrderInformation', 'model/GetAllPlansResponseOrderInformationAmountDetails', 'model/GetAllPlansResponsePlanInformation', 'model/GetAllPlansResponsePlanInformationBillingCycles', 'model/GetAllPlansResponsePlanInformationBillingPeriod', 'model/GetAllPlansResponsePlans', 'model/GetAllSubscriptionsResponse', 'model/GetAllSubscriptionsResponseLinks', 'model/GetAllSubscriptionsResponseOrderInformation', 'model/GetAllSubscriptionsResponseOrderInformationBillTo', 'model/GetAllSubscriptionsResponsePaymentInformation', 'model/GetAllSubscriptionsResponsePaymentInformationCustomer', 'model/GetAllSubscriptionsResponsePlanInformation', 'model/GetAllSubscriptionsResponsePlanInformationBillingCycles', 'model/GetAllSubscriptionsResponseSubscriptionInformation', 'model/GetAllSubscriptionsResponseSubscriptions', 'model/GetPlanCodeResponse', 'model/GetPlanResponse', 'model/GetSubscriptionCodeResponse', 'model/GetSubscriptionResponse', 'model/IncrementAuthRequest', 'model/InlineResponse200', 'model/InlineResponse2001', 'model/InlineResponse2001Keys', 'model/InlineResponse2002', 'model/InlineResponse2002IntegrationInformation', 'model/InlineResponse2002IntegrationInformationTenantConfigurations', 'model/InlineResponse2003', 'model/InlineResponse2004', 'model/InlineResponse2005', 'model/InlineResponse2006', 'model/InlineResponse2006Embedded', 'model/InlineResponse2006EmbeddedBatches', 'model/InlineResponse2006EmbeddedLinks', 'model/InlineResponse2006EmbeddedLinksReports', 'model/InlineResponse2006EmbeddedTotals', 'model/InlineResponse2006Links', 'model/InlineResponse2007', 'model/InlineResponse2007Billing', 'model/InlineResponse2007Links', 'model/InlineResponse2007LinksReport', 'model/InlineResponse2008', 'model/InlineResponse2008Records', 'model/InlineResponse2008ResponseRecord', 'model/InlineResponse2008ResponseRecordAdditionalUpdates', 'model/InlineResponse2008SourceRecord', 'model/InlineResponse200Embedded', 'model/InlineResponse200EmbeddedCapture', 'model/InlineResponse200EmbeddedCaptureLinks', 'model/InlineResponse200EmbeddedCaptureLinksSelf', 'model/InlineResponse200EmbeddedReversal', 'model/InlineResponse200EmbeddedReversalLinks', 'model/InlineResponse200EmbeddedReversalLinksSelf', 'model/InlineResponse201', 'model/InlineResponse2011', 'model/InlineResponse2011IntegrationInformation', 'model/InlineResponse2011IntegrationInformationTenantConfigurations', 'model/InlineResponse2011OrganizationInformation', 'model/InlineResponse2011ProductInformationSetups', 'model/InlineResponse2011RegistrationInformation', 'model/InlineResponse2011Setups', 'model/InlineResponse2011SetupsCommerceSolutions', 'model/InlineResponse2011SetupsPayments', 'model/InlineResponse2011SetupsPaymentsCardProcessing', 'model/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus', 'model/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus', 'model/InlineResponse2011SetupsPaymentsDigitalPayments', 'model/InlineResponse2011SetupsRisk', 'model/InlineResponse2011SetupsValueAddedServices', 'model/InlineResponse2012', 'model/InlineResponse2012KeyInformation', 'model/InlineResponse2012KeyInformationErrorInformation', 'model/InlineResponse2012KeyInformationErrorInformationDetails', 'model/InlineResponse2013', 'model/InlineResponse2014', 'model/InlineResponse202', 'model/InlineResponse202Links', 'model/InlineResponse202LinksStatus', 'model/InlineResponse400', 'model/InlineResponse4001', 'model/InlineResponse4002', 'model/InlineResponse4003', 'model/InlineResponse4004', 'model/InlineResponse4004Fields', 'model/InlineResponse4005', 'model/InlineResponse4006', 'model/InlineResponse4007', 'model/InlineResponse4007Details', 'model/InlineResponse4008', 'model/InlineResponse4008Details', 'model/InlineResponse400Details', 'model/InlineResponse400Errors', 'model/InlineResponse401', 'model/InlineResponse401Fields', 'model/InlineResponse401Links', 'model/InlineResponse401LinksSelf', 'model/InlineResponse403', 'model/InlineResponse4031', 'model/InlineResponse403Errors', 'model/InlineResponse404', 'model/InlineResponse4041', 'model/InlineResponse4042', 'model/InlineResponse4042Details', 'model/InlineResponse409', 'model/InlineResponse409Errors', 'model/InlineResponse410', 'model/InlineResponse410Errors', 'model/InlineResponse412', 'model/InlineResponse412Errors', 'model/InlineResponse422', 'model/InlineResponse4221', 'model/InlineResponse424', 'model/InlineResponse424Errors', 'model/InlineResponse500', 'model/InlineResponse5001', 'model/InlineResponse5002', 'model/InlineResponse5003', 'model/InlineResponse500Errors', 'model/InlineResponse502', 'model/InlineResponse5021', 'model/InlineResponse503', 'model/InlineResponseDefault', 'model/InlineResponseDefaultLinks', 'model/InlineResponseDefaultLinksNext', 'model/InlineResponseDefaultResponseStatus', 'model/InlineResponseDefaultResponseStatusDetails', 'model/IntimateBillingAgreement', 'model/InvoiceSettingsRequest', 'model/InvoicingV2InvoiceSettingsGet200Response', 'model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation', 'model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle', 'model/InvoicingV2InvoicesAllGet200Response', 'model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation', 'model/InvoicingV2InvoicesAllGet200ResponseInvoiceInformation', 'model/InvoicingV2InvoicesAllGet200ResponseInvoices', 'model/InvoicingV2InvoicesAllGet200ResponseLinks', 'model/InvoicingV2InvoicesAllGet200ResponseOrderInformation', 'model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails', 'model/InvoicingV2InvoicesAllGet400Response', 'model/InvoicingV2InvoicesAllGet404Response', 'model/InvoicingV2InvoicesAllGet502Response', 'model/InvoicingV2InvoicesGet200Response', 'model/InvoicingV2InvoicesGet200ResponseInvoiceHistory', 'model/InvoicingV2InvoicesGet200ResponseTransactionDetails', 'model/InvoicingV2InvoicesPost201Response', 'model/InvoicingV2InvoicesPost201ResponseInvoiceInformation', 'model/InvoicingV2InvoicesPost201ResponseOrderInformation', 'model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails', 'model/InvoicingV2InvoicesPost202Response', 'model/Invoicingv2invoiceSettingsInvoiceSettingsInformation', 'model/Invoicingv2invoicesCustomerInformation', 'model/Invoicingv2invoicesCustomerInformationCompany', 'model/Invoicingv2invoicesInvoiceInformation', 'model/Invoicingv2invoicesOrderInformation', 'model/Invoicingv2invoicesOrderInformationAmountDetails', 'model/Invoicingv2invoicesOrderInformationAmountDetailsFreight', 'model/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails', 'model/Invoicingv2invoicesOrderInformationLineItems', 'model/Invoicingv2invoicesidInvoiceInformation', 'model/KmsV2KeysAsymDeletesPost200Response', 'model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation', 'model/KmsV2KeysAsymGet200Response', 'model/KmsV2KeysAsymGet200ResponseKeyInformation', 'model/KmsV2KeysAsymPost201Response', 'model/KmsV2KeysAsymPost201ResponseCertificateInformation', 'model/KmsV2KeysAsymPost201ResponseKeyInformation', 'model/KmsV2KeysSymDeletesPost200Response', 'model/KmsV2KeysSymDeletesPost200ResponseKeyInformation', 'model/KmsV2KeysSymGet200Response', 'model/KmsV2KeysSymGet200ResponseKeyInformation', 'model/KmsV2KeysSymPost201Response', 'model/KmsV2KeysSymPost201ResponseErrorInformation', 'model/KmsV2KeysSymPost201ResponseKeyInformation', 'model/Kmsegressv2keysasymClientReferenceInformation', 'model/Kmsegressv2keysasymKeyInformation', 'model/Kmsegressv2keyssymClientReferenceInformation', 'model/Kmsegressv2keyssymKeyInformation', 'model/Kmsv2keysasymKeyInformation', 'model/Kmsv2keyssymClientReferenceInformation', 'model/Kmsv2keyssymKeyInformation', 'model/Kmsv2keyssymdeletesKeyInformation', 'model/Kmsv2keyssymverifiKeyInformation', 'model/MerchantInitiatedTransactionObject', 'model/Microformv2sessionsCheckoutApiInitialization', 'model/MitReversalRequest', 'model/MitVoidRequest', 'model/ModifyBillingAgreement', 'model/Notificationsubscriptionsv1productsorganizationIdEventTypes', 'model/Notificationsubscriptionsv1webhooksNotificationScope', 'model/Notificationsubscriptionsv1webhooksProducts', 'model/Notificationsubscriptionsv1webhooksRetryPolicy', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1Config', 'model/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig', 'model/Notificationsubscriptionsv1webhooksSecurityPolicyConfig', 'model/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus', 'model/OctCreatePaymentRequest', 'model/OrderPaymentRequest', 'model/PatchCustomerPaymentInstrumentRequest', 'model/PatchCustomerRequest', 'model/PatchCustomerShippingAddressRequest', 'model/PatchInstrumentIdentifierRequest', 'model/PatchPaymentInstrumentRequest', 'model/PayerAuthConfig', 'model/PayerAuthConfigCardTypes', 'model/PayerAuthConfigCardTypesCB', 'model/PayerAuthConfigCardTypesJCBJSecure', 'model/PayerAuthConfigCardTypesVerifiedByVisa', 'model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies', 'model/PayerAuthSetupRequest', 'model/PaymentInstrumentList', 'model/PaymentInstrumentList1', 'model/PaymentInstrumentList1Embedded', 'model/PaymentInstrumentList1EmbeddedEmbedded', 'model/PaymentInstrumentList1EmbeddedPaymentInstruments', 'model/PaymentInstrumentListEmbedded', 'model/PaymentInstrumentListLinks', 'model/PaymentInstrumentListLinksFirst', 'model/PaymentInstrumentListLinksLast', 'model/PaymentInstrumentListLinksNext', 'model/PaymentInstrumentListLinksPrev', 'model/PaymentInstrumentListLinksSelf', 'model/PaymentsProducts', 'model/PaymentsProductsCardPresentConnect', 'model/PaymentsProductsCardPresentConnectConfigurationInformation', 'model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations', 'model/PaymentsProductsCardPresentConnectSubscriptionInformation', 'model/PaymentsProductsCardProcessing', 'model/PaymentsProductsCardProcessingConfigurationInformation', 'model/PaymentsProductsCardProcessingSubscriptionInformation', 'model/PaymentsProductsCardProcessingSubscriptionInformationFeatures', 'model/PaymentsProductsCurrencyConversion', 'model/PaymentsProductsCurrencyConversionConfigurationInformation', 'model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurations', 'model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors', 'model/PaymentsProductsCybsReadyTerminal', 'model/PaymentsProductsDifferentialFee', 'model/PaymentsProductsDifferentialFeeSubscriptionInformation', 'model/PaymentsProductsDifferentialFeeSubscriptionInformationFeatures', 'model/PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge', 'model/PaymentsProductsDigitalPayments', 'model/PaymentsProductsDigitalPaymentsSubscriptionInformation', 'model/PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures', 'model/PaymentsProductsECheck', 'model/PaymentsProductsECheckConfigurationInformation', 'model/PaymentsProductsECheckSubscriptionInformation', 'model/PaymentsProductsPayerAuthentication', 'model/PaymentsProductsPayerAuthenticationConfigurationInformation', 'model/PaymentsProductsPayerAuthenticationSubscriptionInformation', 'model/PaymentsProductsPayouts', 'model/PaymentsProductsPayoutsConfigurationInformation', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurations', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds', 'model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds', 'model/PaymentsProductsSecureAcceptance', 'model/PaymentsProductsSecureAcceptanceConfigurationInformation', 'model/PaymentsProductsTax', 'model/PaymentsProductsVirtualTerminal', 'model/PaymentsProductsVirtualTerminalConfigurationInformation', 'model/PaymentsStrongAuthIssuerInformation', 'model/PostCustomerPaymentInstrumentRequest', 'model/PostCustomerRequest', 'model/PostCustomerShippingAddressRequest', 'model/PostInstrumentIdentifierEnrollmentRequest', 'model/PostInstrumentIdentifierRequest', 'model/PostPaymentCredentialsRequest', 'model/PostPaymentInstrumentRequest', 'model/PostRegistrationBody', 'model/PredefinedSubscriptionRequestBean', 'model/PtsV1TransactionBatchesGet200Response', 'model/PtsV1TransactionBatchesGet200ResponseLinks', 'model/PtsV1TransactionBatchesGet200ResponseLinksSelf', 'model/PtsV1TransactionBatchesGet200ResponseTransactionBatches', 'model/PtsV1TransactionBatchesGet400Response', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformation', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails', 'model/PtsV1TransactionBatchesGet500Response', 'model/PtsV1TransactionBatchesGet500ResponseErrorInformation', 'model/PtsV1TransactionBatchesIdGet200Response', 'model/PtsV1TransactionBatchesIdGet200ResponseLinks', 'model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions', 'model/PtsV2CreateBillingAgreementPost201Response', 'model/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseLinks', 'model/PtsV2CreateBillingAgreementPost201ResponseProcessorInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseRiskInformation', 'model/PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults', 'model/PtsV2CreateBillingAgreementPost400Response', 'model/PtsV2CreateBillingAgreementPost502Response', 'model/PtsV2CreditsPost201Response', 'model/PtsV2CreditsPost201Response1', 'model/PtsV2CreditsPost201Response1ProcessorInformation', 'model/PtsV2CreditsPost201ResponseCreditAmountDetails', 'model/PtsV2CreditsPost201ResponsePaymentInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2IncrementalAuthorizationPatch201Response', 'model/PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseLinks', 'model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails', 'model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation', 'model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures', 'model/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation', 'model/PtsV2IncrementalAuthorizationPatch400Response', 'model/PtsV2ModifyBillingAgreementPost201Response', 'model/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponseLinks', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo', 'model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank', 'model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsCapturesPost201Response', 'model/PtsV2PaymentsCapturesPost201ResponseLinks', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformation', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails', 'model/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation', 'model/PtsV2PaymentsCapturesPost201ResponseProcessingInformation', 'model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation', 'model/PtsV2PaymentsCapturesPost400Response', 'model/PtsV2PaymentsOrderPost201Response', 'model/PtsV2PaymentsOrderPost201ResponseBuyerInformation', 'model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformation', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo', 'model/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails', 'model/PtsV2PaymentsOrderPost201ResponsePaymentInformation', 'model/PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsOrderPost201ResponseProcessingInformation', 'model/PtsV2PaymentsOrderPost201ResponseProcessorInformation', 'model/PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection', 'model/PtsV2PaymentsPost201Response', 'model/PtsV2PaymentsPost201Response1', 'model/PtsV2PaymentsPost201Response1OrderInformation', 'model/PtsV2PaymentsPost201Response1OrderInformationBillTo', 'model/PtsV2PaymentsPost201Response1OrderInformationShipTo', 'model/PtsV2PaymentsPost201Response1PaymentInformation', 'model/PtsV2PaymentsPost201Response1PaymentInformationBank', 'model/PtsV2PaymentsPost201Response1PaymentInformationBankAccount', 'model/PtsV2PaymentsPost201Response1PaymentInformationPaymentType', 'model/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod', 'model/PtsV2PaymentsPost201Response1ProcessorInformation', 'model/PtsV2PaymentsPost201Response1ProcessorInformationAvs', 'model/PtsV2PaymentsPost201Response2', 'model/PtsV2PaymentsPost201Response2OrderInformation', 'model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails', 'model/PtsV2PaymentsPost201Response2PaymentInformation', 'model/PtsV2PaymentsPost201Response2PaymentInformationEWallet', 'model/PtsV2PaymentsPost201Response2ProcessorInformation', 'model/PtsV2PaymentsPost201ResponseBuyerInformation', 'model/PtsV2PaymentsPost201ResponseClientReferenceInformation', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr', 'model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication', 'model/PtsV2PaymentsPost201ResponseEmbeddedActions', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION', 'model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING', 'model/PtsV2PaymentsPost201ResponseErrorInformation', 'model/PtsV2PaymentsPost201ResponseErrorInformationDetails', 'model/PtsV2PaymentsPost201ResponseInstallmentInformation', 'model/PtsV2PaymentsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsPost201ResponseLinks', 'model/PtsV2PaymentsPost201ResponseLinksSelf', 'model/PtsV2PaymentsPost201ResponseMerchantInformation', 'model/PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor', 'model/PtsV2PaymentsPost201ResponseOrderInformation', 'model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationBillTo', 'model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationShipTo', 'model/PtsV2PaymentsPost201ResponsePaymentAccountInformation', 'model/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard', 'model/PtsV2PaymentsPost201ResponsePaymentInformation', 'model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures', 'model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBank', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount', 'model/PtsV2PaymentsPost201ResponsePaymentInformationEWallet', 'model/PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier', 'model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard', 'model/PtsV2PaymentsPost201ResponsePaymentInsightsInformation', 'model/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformation', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv', 'model/PtsV2PaymentsPost201ResponseProcessingInformation', 'model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2PaymentsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAvs', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer', 'model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults', 'model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice', 'model/PtsV2PaymentsPost201ResponseProcessorInformationRouting', 'model/PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection', 'model/PtsV2PaymentsPost201ResponseRiskInformation', 'model/PtsV2PaymentsPost201ResponseRiskInformationInfoCodes', 'model/PtsV2PaymentsPost201ResponseRiskInformationIpAddress', 'model/PtsV2PaymentsPost201ResponseRiskInformationProcessorResults', 'model/PtsV2PaymentsPost201ResponseRiskInformationProfile', 'model/PtsV2PaymentsPost201ResponseRiskInformationRules', 'model/PtsV2PaymentsPost201ResponseRiskInformationScore', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravel', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination', 'model/PtsV2PaymentsPost201ResponseRiskInformationVelocity', 'model/PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing', 'model/PtsV2PaymentsPost201ResponseTokenInformation', 'model/PtsV2PaymentsPost201ResponseTokenInformationCustomer', 'model/PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier', 'model/PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument', 'model/PtsV2PaymentsPost201ResponseTokenInformationShippingAddress', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformation', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList', 'model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches', 'model/PtsV2PaymentsPost400Response', 'model/PtsV2PaymentsPost502Response', 'model/PtsV2PaymentsRefundPost201Response', 'model/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation', 'model/PtsV2PaymentsRefundPost201ResponseLinks', 'model/PtsV2PaymentsRefundPost201ResponseOrderInformation', 'model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsRefundPost201ResponseProcessorInformation', 'model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails', 'model/PtsV2PaymentsRefundPost400Response', 'model/PtsV2PaymentsReversalsPost201Response', 'model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation', 'model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails', 'model/PtsV2PaymentsReversalsPost400Response', 'model/PtsV2PaymentsVoidsPost201Response', 'model/PtsV2PaymentsVoidsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails', 'model/PtsV2PaymentsVoidsPost400Response', 'model/PtsV2PayoutsPost201Response', 'model/PtsV2PayoutsPost201ResponseErrorInformation', 'model/PtsV2PayoutsPost201ResponseIssuerInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor', 'model/PtsV2PayoutsPost201ResponseOrderInformation', 'model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PayoutsPost201ResponseProcessorInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformationCard', 'model/PtsV2PayoutsPost400Response', 'model/Ptsv1pushfundstransferClientReferenceInformation', 'model/Ptsv1pushfundstransferOrderInformation', 'model/Ptsv1pushfundstransferOrderInformationAmountDetails', 'model/Ptsv1pushfundstransferProcessingInformation', 'model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions', 'model/Ptsv1pushfundstransferRecipientInformation', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformation', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier', 'model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument', 'model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification', 'model/Ptsv1pushfundstransferSenderInformation', 'model/Ptsv1pushfundstransferSenderInformationAccount', 'model/Ptsv1pushfundstransferSenderInformationPaymentInformation', 'model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard', 'model/Ptsv1pushfundstransferSenderInformationPersonalIdentification', 'model/Ptsv2billingagreementsAggregatorInformation', 'model/Ptsv2billingagreementsAgreementInformation', 'model/Ptsv2billingagreementsBuyerInformation', 'model/Ptsv2billingagreementsClientReferenceInformation', 'model/Ptsv2billingagreementsConsumerAuthenticationInformation', 'model/Ptsv2billingagreementsDeviceInformation', 'model/Ptsv2billingagreementsInstallmentInformation', 'model/Ptsv2billingagreementsMerchantInformation', 'model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor', 'model/Ptsv2billingagreementsOrderInformation', 'model/Ptsv2billingagreementsOrderInformationBillTo', 'model/Ptsv2billingagreementsPaymentInformation', 'model/Ptsv2billingagreementsPaymentInformationBank', 'model/Ptsv2billingagreementsPaymentInformationBankAccount', 'model/Ptsv2billingagreementsPaymentInformationCard', 'model/Ptsv2billingagreementsPaymentInformationPaymentType', 'model/Ptsv2billingagreementsPaymentInformationPaymentTypeMethod', 'model/Ptsv2billingagreementsPaymentInformationTokenizedCard', 'model/Ptsv2billingagreementsProcessingInformation', 'model/Ptsv2billingagreementsidAgreementInformation', 'model/Ptsv2billingagreementsidBuyerInformation', 'model/Ptsv2billingagreementsidProcessingInformation', 'model/Ptsv2creditsInstallmentInformation', 'model/Ptsv2creditsProcessingInformation', 'model/Ptsv2creditsProcessingInformationBankTransferOptions', 'model/Ptsv2creditsProcessingInformationElectronicBenefitsTransfer', 'model/Ptsv2creditsProcessingInformationJapanPaymentOptions', 'model/Ptsv2creditsProcessingInformationPurchaseOptions', 'model/Ptsv2creditsProcessingInformationRefundOptions', 'model/Ptsv2creditsRecipientInformation', 'model/Ptsv2creditsSenderInformation', 'model/Ptsv2creditsSenderInformationAccount', 'model/Ptsv2paymentreferencesAgreementInformation', 'model/Ptsv2paymentreferencesBuyerInformation', 'model/Ptsv2paymentreferencesDeviceInformation', 'model/Ptsv2paymentreferencesMerchantInformation', 'model/Ptsv2paymentreferencesOrderInformation', 'model/Ptsv2paymentreferencesOrderInformationAmountDetails', 'model/Ptsv2paymentreferencesOrderInformationBillTo', 'model/Ptsv2paymentreferencesOrderInformationInvoiceDetails', 'model/Ptsv2paymentreferencesOrderInformationLineItems', 'model/Ptsv2paymentreferencesOrderInformationShipTo', 'model/Ptsv2paymentreferencesPaymentInformation', 'model/Ptsv2paymentreferencesPaymentInformationBank', 'model/Ptsv2paymentreferencesPaymentInformationBankAccount', 'model/Ptsv2paymentreferencesPaymentInformationCard', 'model/Ptsv2paymentreferencesPaymentInformationEWallet', 'model/Ptsv2paymentreferencesPaymentInformationOptions', 'model/Ptsv2paymentreferencesProcessingInformation', 'model/Ptsv2paymentreferencesTravelInformation', 'model/Ptsv2paymentreferencesTravelInformationAutoRental', 'model/Ptsv2paymentreferencesUserInterface', 'model/Ptsv2paymentreferencesUserInterfaceColor', 'model/Ptsv2paymentreferencesidintentsOrderInformation', 'model/Ptsv2paymentreferencesidintentsPaymentInformation', 'model/Ptsv2paymentreferencesidintentsPaymentInformationEWallet', 'model/Ptsv2paymentreferencesidintentsProcessingInformation', 'model/Ptsv2paymentsAcquirerInformation', 'model/Ptsv2paymentsAggregatorInformation', 'model/Ptsv2paymentsAggregatorInformationSubMerchant', 'model/Ptsv2paymentsAgreementInformation', 'model/Ptsv2paymentsBuyerInformation', 'model/Ptsv2paymentsBuyerInformationPersonalIdentification', 'model/Ptsv2paymentsClientReferenceInformation', 'model/Ptsv2paymentsClientReferenceInformationPartner', 'model/Ptsv2paymentsConsumerAuthenticationInformation', 'model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication', 'model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation', 'model/Ptsv2paymentsDeviceInformation', 'model/Ptsv2paymentsDeviceInformationRawData', 'model/Ptsv2paymentsHealthCareInformation', 'model/Ptsv2paymentsHealthCareInformationAmountDetails', 'model/Ptsv2paymentsHostedPaymentInformation', 'model/Ptsv2paymentsHostedPaymentInformationUserAgent', 'model/Ptsv2paymentsInstallmentInformation', 'model/Ptsv2paymentsInvoiceDetails', 'model/Ptsv2paymentsIssuerInformation', 'model/Ptsv2paymentsMerchantDefinedInformation', 'model/Ptsv2paymentsMerchantDefinedSecureInformation', 'model/Ptsv2paymentsMerchantInformation', 'model/Ptsv2paymentsMerchantInformationMerchantDescriptor', 'model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor', 'model/Ptsv2paymentsMerchantInformationServiceLocation', 'model/Ptsv2paymentsOrderInformation', 'model/Ptsv2paymentsOrderInformationAmountDetails', 'model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts', 'model/Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion', 'model/Ptsv2paymentsOrderInformationAmountDetailsOrder', 'model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails', 'model/Ptsv2paymentsOrderInformationBillTo', 'model/Ptsv2paymentsOrderInformationBillToCompany', 'model/Ptsv2paymentsOrderInformationInvoiceDetails', 'model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum', 'model/Ptsv2paymentsOrderInformationLineItems', 'model/Ptsv2paymentsOrderInformationPassenger', 'model/Ptsv2paymentsOrderInformationShipTo', 'model/Ptsv2paymentsOrderInformationShippingDetails', 'model/Ptsv2paymentsPaymentInformation', 'model/Ptsv2paymentsPaymentInformationBank', 'model/Ptsv2paymentsPaymentInformationBankAccount', 'model/Ptsv2paymentsPaymentInformationCard', 'model/Ptsv2paymentsPaymentInformationCustomer', 'model/Ptsv2paymentsPaymentInformationDirectDebit', 'model/Ptsv2paymentsPaymentInformationDirectDebitMandate', 'model/Ptsv2paymentsPaymentInformationEWallet', 'model/Ptsv2paymentsPaymentInformationFluidData', 'model/Ptsv2paymentsPaymentInformationInstrumentIdentifier', 'model/Ptsv2paymentsPaymentInformationLegacyToken', 'model/Ptsv2paymentsPaymentInformationOptions', 'model/Ptsv2paymentsPaymentInformationPaymentInstrument', 'model/Ptsv2paymentsPaymentInformationPaymentType', 'model/Ptsv2paymentsPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsPaymentInformationSepa', 'model/Ptsv2paymentsPaymentInformationSepaDirectDebit', 'model/Ptsv2paymentsPaymentInformationShippingAddress', 'model/Ptsv2paymentsPaymentInformationTokenizedCard', 'model/Ptsv2paymentsPointOfSaleInformation', 'model/Ptsv2paymentsPointOfSaleInformationEmv', 'model/Ptsv2paymentsProcessingInformation', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/Ptsv2paymentsProcessingInformationBankTransferOptions', 'model/Ptsv2paymentsProcessingInformationCaptureOptions', 'model/Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer', 'model/Ptsv2paymentsProcessingInformationJapanPaymentOptions', 'model/Ptsv2paymentsProcessingInformationLoanOptions', 'model/Ptsv2paymentsProcessingInformationPurchaseOptions', 'model/Ptsv2paymentsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsProcessorInformation', 'model/Ptsv2paymentsProcessorInformationAuthorizationOptions', 'model/Ptsv2paymentsProcessorInformationReversal', 'model/Ptsv2paymentsPromotionInformation', 'model/Ptsv2paymentsRecipientInformation', 'model/Ptsv2paymentsRecurringPaymentInformation', 'model/Ptsv2paymentsRiskInformation', 'model/Ptsv2paymentsRiskInformationAuxiliaryData', 'model/Ptsv2paymentsRiskInformationBuyerHistory', 'model/Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory', 'model/Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount', 'model/Ptsv2paymentsRiskInformationProfile', 'model/Ptsv2paymentsTokenInformation', 'model/Ptsv2paymentsTokenInformationPaymentInstrument', 'model/Ptsv2paymentsTokenInformationShippingAddress', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'model/Ptsv2paymentsTravelInformation', 'model/Ptsv2paymentsTravelInformationAgency', 'model/Ptsv2paymentsTravelInformationAutoRental', 'model/Ptsv2paymentsTravelInformationAutoRentalRentalAddress', 'model/Ptsv2paymentsTravelInformationAutoRentalReturnAddress', 'model/Ptsv2paymentsTravelInformationAutoRentalTaxDetails', 'model/Ptsv2paymentsTravelInformationLodging', 'model/Ptsv2paymentsTravelInformationLodgingRoom', 'model/Ptsv2paymentsTravelInformationTransit', 'model/Ptsv2paymentsTravelInformationTransitAirline', 'model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation', 'model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService', 'model/Ptsv2paymentsTravelInformationTransitAirlineLegs', 'model/Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer', 'model/Ptsv2paymentsTravelInformationVehicleData', 'model/Ptsv2paymentsWatchlistScreeningInformation', 'model/Ptsv2paymentsWatchlistScreeningInformationWeights', 'model/Ptsv2paymentsidClientReferenceInformation', 'model/Ptsv2paymentsidClientReferenceInformationPartner', 'model/Ptsv2paymentsidMerchantInformation', 'model/Ptsv2paymentsidOrderInformation', 'model/Ptsv2paymentsidOrderInformationAmountDetails', 'model/Ptsv2paymentsidProcessingInformation', 'model/Ptsv2paymentsidProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator', 'model/Ptsv2paymentsidTravelInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant', 'model/Ptsv2paymentsidcapturesBuyerInformation', 'model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification', 'model/Ptsv2paymentsidcapturesDeviceInformation', 'model/Ptsv2paymentsidcapturesInstallmentInformation', 'model/Ptsv2paymentsidcapturesMerchantInformation', 'model/Ptsv2paymentsidcapturesOrderInformation', 'model/Ptsv2paymentsidcapturesOrderInformationAmountDetails', 'model/Ptsv2paymentsidcapturesOrderInformationBillTo', 'model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails', 'model/Ptsv2paymentsidcapturesOrderInformationShipTo', 'model/Ptsv2paymentsidcapturesOrderInformationShippingDetails', 'model/Ptsv2paymentsidcapturesPaymentInformation', 'model/Ptsv2paymentsidcapturesPaymentInformationCard', 'model/Ptsv2paymentsidcapturesPaymentInformationPaymentType', 'model/Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsidcapturesPointOfSaleInformation', 'model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv', 'model/Ptsv2paymentsidcapturesProcessingInformation', 'model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions', 'model/Ptsv2paymentsidrefundsClientReferenceInformation', 'model/Ptsv2paymentsidrefundsMerchantInformation', 'model/Ptsv2paymentsidrefundsOrderInformation', 'model/Ptsv2paymentsidrefundsOrderInformationLineItems', 'model/Ptsv2paymentsidrefundsPaymentInformation', 'model/Ptsv2paymentsidrefundsPaymentInformationBank', 'model/Ptsv2paymentsidrefundsPaymentInformationBankAccount', 'model/Ptsv2paymentsidrefundsPaymentInformationCard', 'model/Ptsv2paymentsidrefundsPaymentInformationEWallet', 'model/Ptsv2paymentsidrefundsPaymentInformationPaymentType', 'model/Ptsv2paymentsidrefundsPointOfSaleInformation', 'model/Ptsv2paymentsidrefundsProcessingInformation', 'model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsidrefundsProcessingInformationRefundOptions', 'model/Ptsv2paymentsidreversalsClientReferenceInformation', 'model/Ptsv2paymentsidreversalsClientReferenceInformationPartner', 'model/Ptsv2paymentsidreversalsOrderInformation', 'model/Ptsv2paymentsidreversalsOrderInformationAmountDetails', 'model/Ptsv2paymentsidreversalsOrderInformationLineItems', 'model/Ptsv2paymentsidreversalsPaymentInformation', 'model/Ptsv2paymentsidreversalsPaymentInformationPaymentType', 'model/Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod', 'model/Ptsv2paymentsidreversalsPointOfSaleInformation', 'model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv', 'model/Ptsv2paymentsidreversalsProcessingInformation', 'model/Ptsv2paymentsidreversalsReversalInformation', 'model/Ptsv2paymentsidreversalsReversalInformationAmountDetails', 'model/Ptsv2paymentsidvoidsAgreementInformation', 'model/Ptsv2paymentsidvoidsMerchantInformation', 'model/Ptsv2paymentsidvoidsOrderInformation', 'model/Ptsv2paymentsidvoidsPaymentInformation', 'model/Ptsv2paymentsidvoidsProcessingInformation', 'model/Ptsv2payoutsClientReferenceInformation', 'model/Ptsv2payoutsMerchantInformation', 'model/Ptsv2payoutsMerchantInformationMerchantDescriptor', 'model/Ptsv2payoutsOrderInformation', 'model/Ptsv2payoutsOrderInformationAmountDetails', 'model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2payoutsOrderInformationBillTo', 'model/Ptsv2payoutsPaymentInformation', 'model/Ptsv2payoutsPaymentInformationCard', 'model/Ptsv2payoutsProcessingInformation', 'model/Ptsv2payoutsProcessingInformationFundingOptions', 'model/Ptsv2payoutsProcessingInformationFundingOptionsInitiator', 'model/Ptsv2payoutsProcessingInformationPayoutsOptions', 'model/Ptsv2payoutsRecipientInformation', 'model/Ptsv2payoutsSenderInformation', 'model/Ptsv2payoutsSenderInformationAccount', 'model/Ptsv2refreshpaymentstatusidAgreementInformation', 'model/Ptsv2refreshpaymentstatusidClientReferenceInformation', 'model/Ptsv2refreshpaymentstatusidPaymentInformation', 'model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer', 'model/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType', 'model/Ptsv2refreshpaymentstatusidProcessingInformation', 'model/Ptsv2voidsProcessingInformation', 'model/PushFunds201Response', 'model/PushFunds201ResponseClientReferenceInformation', 'model/PushFunds201ResponseErrorInformation', 'model/PushFunds201ResponseErrorInformationDetails', 'model/PushFunds201ResponseLinks', 'model/PushFunds201ResponseLinksCustomer', 'model/PushFunds201ResponseLinksInstrumentIdentifier', 'model/PushFunds201ResponseLinksPaymentInstrument', 'model/PushFunds201ResponseLinksSelf', 'model/PushFunds201ResponseMerchantInformation', 'model/PushFunds201ResponseMerchantInformationMerchantDescriptor', 'model/PushFunds201ResponseOrderInformation', 'model/PushFunds201ResponseOrderInformationAmountDetails', 'model/PushFunds201ResponseProcessorInformation', 'model/PushFunds201ResponseRecipientInformation', 'model/PushFunds201ResponseRecipientInformationCard', 'model/PushFunds400Response', 'model/PushFunds400ResponseDetails', 'model/PushFunds401Response', 'model/PushFunds404Response', 'model/PushFunds502Response', 'model/PushFundsRequest', 'model/Rbsv1plansClientReferenceInformation', 'model/Rbsv1plansOrderInformation', 'model/Rbsv1plansOrderInformationAmountDetails', 'model/Rbsv1plansPlanInformation', 'model/Rbsv1plansPlanInformationBillingCycles', 'model/Rbsv1plansidPlanInformation', 'model/Rbsv1plansidProcessingInformation', 'model/Rbsv1plansidProcessingInformationSubscriptionBillingOptions', 'model/Rbsv1subscriptionsClientReferenceInformation', 'model/Rbsv1subscriptionsPaymentInformation', 'model/Rbsv1subscriptionsPaymentInformationCustomer', 'model/Rbsv1subscriptionsPlanInformation', 'model/Rbsv1subscriptionsProcessingInformation', 'model/Rbsv1subscriptionsProcessingInformationAuthorizationOptions', 'model/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator', 'model/Rbsv1subscriptionsSubscriptionInformation', 'model/Rbsv1subscriptionsidOrderInformation', 'model/Rbsv1subscriptionsidOrderInformationAmountDetails', 'model/Rbsv1subscriptionsidPlanInformation', 'model/Rbsv1subscriptionsidSubscriptionInformation', 'model/RefreshPaymentStatusRequest', 'model/RefundCaptureRequest', 'model/RefundPaymentRequest', 'model/ReplayWebhooksRequest', 'model/ReportingV3ChargebackDetailsGet200Response', 'model/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails', 'model/ReportingV3ChargebackSummariesGet200Response', 'model/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries', 'model/ReportingV3ConversionDetailsGet200Response', 'model/ReportingV3ConversionDetailsGet200ResponseConversionDetails', 'model/ReportingV3ConversionDetailsGet200ResponseNotes', 'model/ReportingV3InterchangeClearingLevelDetailsGet200Response', 'model/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails', 'model/ReportingV3NetFundingsGet200Response', 'model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries', 'model/ReportingV3NetFundingsGet200ResponseTotalPurchases', 'model/ReportingV3NotificationofChangesGet200Response', 'model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges', 'model/ReportingV3PaymentBatchSummariesGet200Response', 'model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries', 'model/ReportingV3PurchaseRefundDetailsGet200Response', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements', 'model/ReportingV3ReportDefinitionsGet200Response', 'model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions', 'model/ReportingV3ReportDefinitionsNameGet200Response', 'model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes', 'model/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings', 'model/ReportingV3ReportSubscriptionsGet200Response', 'model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions', 'model/ReportingV3ReportsGet200Response', 'model/ReportingV3ReportsGet200ResponseLink', 'model/ReportingV3ReportsGet200ResponseLinkReportDownload', 'model/ReportingV3ReportsGet200ResponseReportSearchResults', 'model/ReportingV3ReportsIdGet200Response', 'model/ReportingV3RetrievalDetailsGet200Response', 'model/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails', 'model/ReportingV3RetrievalSummariesGet200Response', 'model/Reportingv3ReportDownloadsGet400Response', 'model/Reportingv3ReportDownloadsGet400ResponseDetails', 'model/Reportingv3reportsReportFilters', 'model/Reportingv3reportsReportPreferences', 'model/RiskProducts', 'model/RiskProductsDecisionManager', 'model/RiskProductsDecisionManagerConfigurationInformation', 'model/RiskProductsFraudManagementEssentials', 'model/RiskProductsFraudManagementEssentialsConfigurationInformation', 'model/RiskV1AddressVerificationsPost201Response', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress', 'model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1', 'model/RiskV1AddressVerificationsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationResultsPost201Response', 'model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationSetupsPost201Response', 'model/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationSetupsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationsPost201Response', 'model/RiskV1AuthenticationsPost201ResponseErrorInformation', 'model/RiskV1AuthenticationsPost400Response', 'model/RiskV1AuthenticationsPost400Response1', 'model/RiskV1DecisionsPost201Response', 'model/RiskV1DecisionsPost201ResponseClientReferenceInformation', 'model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1DecisionsPost201ResponseErrorInformation', 'model/RiskV1DecisionsPost201ResponseOrderInformation', 'model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails', 'model/RiskV1DecisionsPost201ResponsePaymentInformation', 'model/RiskV1DecisionsPost400Response', 'model/RiskV1DecisionsPost400Response1', 'model/RiskV1ExportComplianceInquiriesPost201Response', 'model/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation', 'model/RiskV1UpdatePost201Response', 'model/Riskv1addressverificationsBuyerInformation', 'model/Riskv1addressverificationsOrderInformation', 'model/Riskv1addressverificationsOrderInformationBillTo', 'model/Riskv1addressverificationsOrderInformationLineItems', 'model/Riskv1addressverificationsOrderInformationShipTo', 'model/Riskv1authenticationresultsConsumerAuthenticationInformation', 'model/Riskv1authenticationresultsDeviceInformation', 'model/Riskv1authenticationresultsOrderInformation', 'model/Riskv1authenticationresultsOrderInformationAmountDetails', 'model/Riskv1authenticationresultsPaymentInformation', 'model/Riskv1authenticationresultsPaymentInformationCard', 'model/Riskv1authenticationresultsPaymentInformationFluidData', 'model/Riskv1authenticationresultsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsBuyerInformation', 'model/Riskv1authenticationsDeviceInformation', 'model/Riskv1authenticationsOrderInformation', 'model/Riskv1authenticationsOrderInformationAmountDetails', 'model/Riskv1authenticationsOrderInformationBillTo', 'model/Riskv1authenticationsOrderInformationLineItems', 'model/Riskv1authenticationsPaymentInformation', 'model/Riskv1authenticationsPaymentInformationCard', 'model/Riskv1authenticationsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsRiskInformation', 'model/Riskv1authenticationsTravelInformation', 'model/Riskv1authenticationsetupsPaymentInformation', 'model/Riskv1authenticationsetupsPaymentInformationCard', 'model/Riskv1authenticationsetupsPaymentInformationCustomer', 'model/Riskv1authenticationsetupsPaymentInformationFluidData', 'model/Riskv1authenticationsetupsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsetupsProcessingInformation', 'model/Riskv1authenticationsetupsTokenInformation', 'model/Riskv1decisionsAcquirerInformation', 'model/Riskv1decisionsBuyerInformation', 'model/Riskv1decisionsClientReferenceInformation', 'model/Riskv1decisionsClientReferenceInformationPartner', 'model/Riskv1decisionsConsumerAuthenticationInformation', 'model/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication', 'model/Riskv1decisionsDeviceInformation', 'model/Riskv1decisionsMerchantDefinedInformation', 'model/Riskv1decisionsMerchantInformation', 'model/Riskv1decisionsMerchantInformationMerchantDescriptor', 'model/Riskv1decisionsOrderInformation', 'model/Riskv1decisionsOrderInformationAmountDetails', 'model/Riskv1decisionsOrderInformationBillTo', 'model/Riskv1decisionsOrderInformationLineItems', 'model/Riskv1decisionsOrderInformationShipTo', 'model/Riskv1decisionsOrderInformationShippingDetails', 'model/Riskv1decisionsPaymentInformation', 'model/Riskv1decisionsPaymentInformationCard', 'model/Riskv1decisionsPaymentInformationTokenizedCard', 'model/Riskv1decisionsProcessingInformation', 'model/Riskv1decisionsProcessorInformation', 'model/Riskv1decisionsProcessorInformationAvs', 'model/Riskv1decisionsProcessorInformationCardVerification', 'model/Riskv1decisionsRiskInformation', 'model/Riskv1decisionsTokenInformation', 'model/Riskv1decisionsTravelInformation', 'model/Riskv1decisionsTravelInformationLegs', 'model/Riskv1decisionsTravelInformationPassengers', 'model/Riskv1decisionsidactionsDecisionInformation', 'model/Riskv1decisionsidactionsProcessingInformation', 'model/Riskv1decisionsidmarkingRiskInformation', 'model/Riskv1decisionsidmarkingRiskInformationMarkingDetails', 'model/Riskv1exportcomplianceinquiriesDeviceInformation', 'model/Riskv1exportcomplianceinquiriesExportComplianceInformation', 'model/Riskv1exportcomplianceinquiriesOrderInformation', 'model/Riskv1exportcomplianceinquiriesOrderInformationBillTo', 'model/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany', 'model/Riskv1exportcomplianceinquiriesOrderInformationLineItems', 'model/Riskv1exportcomplianceinquiriesOrderInformationShipTo', 'model/Riskv1liststypeentriesBuyerInformation', 'model/Riskv1liststypeentriesClientReferenceInformation', 'model/Riskv1liststypeentriesDeviceInformation', 'model/Riskv1liststypeentriesOrderInformation', 'model/Riskv1liststypeentriesOrderInformationAddress', 'model/Riskv1liststypeentriesOrderInformationBillTo', 'model/Riskv1liststypeentriesOrderInformationLineItems', 'model/Riskv1liststypeentriesOrderInformationShipTo', 'model/Riskv1liststypeentriesPaymentInformation', 'model/Riskv1liststypeentriesPaymentInformationBank', 'model/Riskv1liststypeentriesPaymentInformationCard', 'model/Riskv1liststypeentriesRiskInformation', 'model/Riskv1liststypeentriesRiskInformationMarkingDetails', 'model/SAConfig', 'model/SAConfigCheckout', 'model/SAConfigContactInformation', 'model/SAConfigNotifications', 'model/SAConfigNotificationsCustomerNotifications', 'model/SAConfigNotificationsMerchantNotifications', 'model/SAConfigPaymentMethods', 'model/SAConfigPaymentTypes', 'model/SAConfigPaymentTypesCardTypes', 'model/SAConfigPaymentTypesCardTypesDiscover', 'model/SAConfigService', 'model/SaveAsymEgressKey', 'model/SaveSymEgressKey', 'model/SearchRequest', 'model/ShippingAddressListForCustomer', 'model/ShippingAddressListForCustomerEmbedded', 'model/ShippingAddressListForCustomerLinks', 'model/ShippingAddressListForCustomerLinksFirst', 'model/ShippingAddressListForCustomerLinksLast', 'model/ShippingAddressListForCustomerLinksNext', 'model/ShippingAddressListForCustomerLinksPrev', 'model/ShippingAddressListForCustomerLinksSelf', 'model/SuspendSubscriptionResponse', 'model/SuspendSubscriptionResponseSubscriptionInformation', 'model/TaxRequest', 'model/TmsAuthorizationOptions', 'model/TmsAuthorizationOptionsInitiator', 'model/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/TmsEmbeddedInstrumentIdentifier', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments', 'model/TmsEmbeddedInstrumentIdentifierLinksSelf', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCardCard', 'model/TmsPaymentInstrumentProcessingInfo', 'model/TmsPaymentInstrumentProcessingInfoBankTransferOptions', 'model/Tmsv2customersBuyerInformation', 'model/Tmsv2customersClientReferenceInformation', 'model/Tmsv2customersDefaultPaymentInstrument', 'model/Tmsv2customersDefaultShippingAddress', 'model/Tmsv2customersEmbedded', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrument', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor', 'model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', 'model/Tmsv2customersEmbeddedDefaultShippingAddress', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinks', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer', 'model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf', 'model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata', 'model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo', 'model/Tmsv2customersLinks', 'model/Tmsv2customersLinksPaymentInstruments', 'model/Tmsv2customersLinksSelf', 'model/Tmsv2customersLinksShippingAddress', 'model/Tmsv2customersMerchantDefinedInformation', 'model/Tmsv2customersMetadata', 'model/Tmsv2customersObjectInformation', 'model/TssV2GetEmvTags200Response', 'model/TssV2GetEmvTags200ResponseEmvTagBreakdownList', 'model/TssV2PostEmvTags200Response', 'model/TssV2PostEmvTags200ResponseEmvTagBreakdownList', 'model/TssV2PostEmvTags200ResponseParsedEMVTagsList', 'model/TssV2TransactionsGet200Response', 'model/TssV2TransactionsGet200ResponseApplicationInformation', 'model/TssV2TransactionsGet200ResponseApplicationInformationApplications', 'model/TssV2TransactionsGet200ResponseBuyerInformation', 'model/TssV2TransactionsGet200ResponseClientReferenceInformation', 'model/TssV2TransactionsGet200ResponseClientReferenceInformationPartner', 'model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation', 'model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication', 'model/TssV2TransactionsGet200ResponseDeviceInformation', 'model/TssV2TransactionsGet200ResponseErrorInformation', 'model/TssV2TransactionsGet200ResponseFraudMarkingInformation', 'model/TssV2TransactionsGet200ResponseInstallmentInformation', 'model/TssV2TransactionsGet200ResponseLinks', 'model/TssV2TransactionsGet200ResponseMerchantInformation', 'model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor', 'model/TssV2TransactionsGet200ResponseOrderInformation', 'model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails', 'model/TssV2TransactionsGet200ResponseOrderInformationBillTo', 'model/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails', 'model/TssV2TransactionsGet200ResponseOrderInformationLineItems', 'model/TssV2TransactionsGet200ResponseOrderInformationShipTo', 'model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails', 'model/TssV2TransactionsGet200ResponsePaymentInformation', 'model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures', 'model/TssV2TransactionsGet200ResponsePaymentInformationBank', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate', 'model/TssV2TransactionsGet200ResponsePaymentInformationBrands', 'model/TssV2TransactionsGet200ResponsePaymentInformationCard', 'model/TssV2TransactionsGet200ResponsePaymentInformationCustomer', 'model/TssV2TransactionsGet200ResponsePaymentInformationFeatures', 'model/TssV2TransactionsGet200ResponsePaymentInformationFluidData', 'model/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier', 'model/TssV2TransactionsGet200ResponsePaymentInformationInvoice', 'model/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation', 'model/TssV2TransactionsGet200ResponsePaymentInformationNetwork', 'model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType', 'model/TssV2TransactionsGet200ResponsePayoutOptions', 'model/TssV2TransactionsGet200ResponsePointOfSaleInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator', 'model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions', 'model/TssV2TransactionsGet200ResponseProcessorInformation', 'model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults', 'model/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting', 'model/TssV2TransactionsGet200ResponseProcessorInformationProcessor', 'model/TssV2TransactionsGet200ResponseRecurringPaymentInformation', 'model/TssV2TransactionsGet200ResponseRiskInformation', 'model/TssV2TransactionsGet200ResponseRiskInformationProfile', 'model/TssV2TransactionsGet200ResponseRiskInformationRules', 'model/TssV2TransactionsGet200ResponseRiskInformationScore', 'model/TssV2TransactionsGet200ResponseSenderInformation', 'model/TssV2TransactionsGet200ResponseTokenInformation', 'model/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation', 'model/TssV2TransactionsPost201Response', 'model/TssV2TransactionsPost201ResponseEmbedded', 'model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications', 'model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner', 'model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedLinks', 'model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType', 'model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint', 'model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries', 'model/TssV2TransactionsPost400Response', 'model/Tssv2transactionsemvTagDetailsEmvDetailsList', 'model/UmsV1UsersGet200Response', 'model/UmsV1UsersGet200ResponseAccountInformation', 'model/UmsV1UsersGet200ResponseContactInformation', 'model/UmsV1UsersGet200ResponseOrganizationInformation', 'model/UmsV1UsersGet200ResponseUsers', 'model/UpdateAsymKeysRequest', 'model/UpdateInvoiceRequest', 'model/UpdatePGPKeysRequest', 'model/UpdatePGPKeysRequest1', 'model/UpdatePasswordKeysRequest', 'model/UpdatePlanRequest', 'model/UpdatePlanResponse', 'model/UpdatePlanResponsePlanInformation', 'model/UpdateSubscription', 'model/UpdateSubscriptionResponse', 'model/UpdateWebhookRequest', 'model/Upv1capturecontextsCaptureMandate', 'model/Upv1capturecontextsCheckoutApiInitialization', 'model/Upv1capturecontextsOrderInformation', 'model/Upv1capturecontextsOrderInformationAmountDetails', 'model/Upv1capturecontextsOrderInformationBillTo', 'model/Upv1capturecontextsOrderInformationBillToCompany', 'model/Upv1capturecontextsOrderInformationShipTo', 'model/V1FileDetailsGet200Response', 'model/V1FileDetailsGet200ResponseFileDetails', 'model/V1FileDetailsGet200ResponseLinks', 'model/V1FileDetailsGet200ResponseLinksFiles', 'model/V1FileDetailsGet200ResponseLinksSelf', 'model/VTConfig', 'model/VTConfigCardNotPresent', 'model/VTConfigCardNotPresentGlobalPaymentInformation', 'model/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation', 'model/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields', 'model/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation', 'model/VTConfigCardNotPresentReceiptInformation', 'model/VTConfigCardNotPresentReceiptInformationEmailReceipt', 'model/VTConfigCardNotPresentReceiptInformationHeader', 'model/VTConfigCardNotPresentReceiptInformationOrderInformation', 'model/ValidateExportComplianceRequest', 'model/ValidateRequest', 'model/ValueAddedServicesProducts', 'model/VasV2PaymentsPost201Response', 'model/VasV2PaymentsPost201ResponseLinks', 'model/VasV2PaymentsPost201ResponseOrderInformation', 'model/VasV2PaymentsPost201ResponseOrderInformationJurisdiction', 'model/VasV2PaymentsPost201ResponseOrderInformationLineItems', 'model/VasV2PaymentsPost201ResponseOrderInformationTaxDetails', 'model/VasV2PaymentsPost201ResponseTaxInformation', 'model/VasV2PaymentsPost400Response', 'model/VasV2TaxVoid200Response', 'model/VasV2TaxVoid200ResponseVoidAmountDetails', 'model/VasV2TaxVoidsPost400Response', 'model/Vasv2taxBuyerInformation', 'model/Vasv2taxClientReferenceInformation', 'model/Vasv2taxMerchantInformation', 'model/Vasv2taxOrderInformation', 'model/Vasv2taxOrderInformationBillTo', 'model/Vasv2taxOrderInformationInvoiceDetails', 'model/Vasv2taxOrderInformationLineItems', 'model/Vasv2taxOrderInformationOrderAcceptance', 'model/Vasv2taxOrderInformationOrderOrigin', 'model/Vasv2taxOrderInformationShipTo', 'model/Vasv2taxOrderInformationShippingDetails', 'model/Vasv2taxTaxInformation', 'model/Vasv2taxidClientReferenceInformation', 'model/Vasv2taxidClientReferenceInformationPartner', 'model/VerifyCustomerAddressRequest', 'model/VoidCaptureRequest', 'model/VoidCreditRequest', 'model/VoidPaymentRequest', 'model/VoidRefundRequest', 'model/VoidTaxRequest', 'model/AccessTokenResponse', 'model/BadRequestError', 'model/CreateAccessTokenRequest', 'model/ResourceNotFoundError', 'model/UnauthorizedClientError', 'api/AsymmetricKeyManagementApi', 'api/BatchesApi', 'api/BillingAgreementsApi', 'api/CaptureApi', 'api/ChargebackDetailsApi', 'api/ChargebackSummariesApi', 'api/ConversionDetailsApi', 'api/CreateNewWebhooksApi', 'api/CreditApi', 'api/CustomerApi', 'api/CustomerPaymentInstrumentApi', 'api/CustomerShippingAddressApi', 'api/DecisionManagerApi', 'api/DownloadDTDApi', 'api/DownloadXSDApi', 'api/EMVTagDetailsApi', 'api/InstrumentIdentifierApi', 'api/InterchangeClearingLevelDetailsApi', 'api/InvoiceSettingsApi', 'api/InvoicesApi', 'api/KeyManagementApi', 'api/KeyManagementPasswordApi', 'api/KeyManagementPgpApi', 'api/KeyManagementScmpApi', 'api/ManageWebhooksApi', 'api/MerchantBoardingApi', 'api/MicroformIntegrationApi', 'api/NetFundingsApi', 'api/NotificationOfChangesApi', 'api/PayerAuthenticationApi', 'api/PaymentBatchSummariesApi', 'api/PaymentInstrumentApi', 'api/PaymentsApi', 'api/PayoutsApi', 'api/PlansApi', 'api/PurchaseAndRefundDetailsApi', 'api/PushFundsApi', 'api/RefundApi', 'api/ReplayWebhooksApi', 'api/ReportDefinitionsApi', 'api/ReportDownloadsApi', 'api/ReportSubscriptionsApi', 'api/ReportsApi', 'api/RetrievalDetailsApi', 'api/RetrievalSummariesApi', 'api/ReversalApi', 'api/SearchTransactionsApi', 'api/SecureFileShareApi', 'api/SubscriptionsApi', 'api/SymmetricKeyManagementApi', 'api/TaxesApi', 'api/TokenApi', 'api/TransactionBatchesApi', 'api/TransactionDetailsApi', 'api/TransientTokenDataApi', 'api/UnifiedCheckoutCaptureContextApi', 'api/UserManagementApi', 'api/UserManagementSearchApi', 'api/VerificationApi', 'api/VoidApi', 'api/OAuthApi'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('./ApiClient'), require('./model/Accountupdaterv1batchesIncluded'), require('./model/Accountupdaterv1batchesIncludedTokens'), require('./model/ActivateDeactivatePlanResponse'), require('./model/ActivateSubscriptionResponse'), require('./model/ActivateSubscriptionResponseSubscriptionInformation'), require('./model/AddNegativeListRequest'), require('./model/AuthReversalRequest'), require('./model/Boardingv1registrationsDocumentInformation'), require('./model/Boardingv1registrationsDocumentInformationSignedDocuments'), require('./model/Boardingv1registrationsIntegrationInformation'), require('./model/Boardingv1registrationsIntegrationInformationOauth2'), require('./model/Boardingv1registrationsIntegrationInformationTenantConfigurations'), require('./model/Boardingv1registrationsIntegrationInformationTenantInformation'), require('./model/Boardingv1registrationsOrganizationInformation'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformation'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact'), require('./model/Boardingv1registrationsOrganizationInformationKYC'), require('./model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount'), require('./model/Boardingv1registrationsOrganizationInformationOwners'), require('./model/Boardingv1registrationsProductInformation'), require('./model/Boardingv1registrationsProductInformationSelectedProducts'), require('./model/Boardingv1registrationsRegistrationInformation'), require('./model/Body'), require('./model/CancelSubscriptionResponse'), require('./model/CancelSubscriptionResponseSubscriptionInformation'), require('./model/CapturePaymentRequest'), require('./model/CardProcessingConfig'), require('./model/CardProcessingConfigCommon'), require('./model/CardProcessingConfigCommonAcquirer'), require('./model/CardProcessingConfigCommonCurrencies'), require('./model/CardProcessingConfigCommonCurrencies1'), require('./model/CardProcessingConfigCommonMerchantDescriptorInformation'), require('./model/CardProcessingConfigCommonPaymentTypes'), require('./model/CardProcessingConfigCommonProcessors'), require('./model/CardProcessingConfigFeatures'), require('./model/CardProcessingConfigFeaturesCardNotPresent'), require('./model/CardProcessingConfigFeaturesCardNotPresentInstallment'), require('./model/CardProcessingConfigFeaturesCardNotPresentPayouts'), require('./model/CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies'), require('./model/CardProcessingConfigFeaturesCardNotPresentProcessors'), require('./model/CardProcessingConfigFeaturesCardPresent'), require('./model/CardProcessingConfigFeaturesCardPresentProcessors'), require('./model/CaseManagementActionsRequest'), require('./model/CaseManagementCommentsRequest'), require('./model/CheckPayerAuthEnrollmentRequest'), require('./model/CommerceSolutionsProducts'), require('./model/CommerceSolutionsProductsAccountUpdater'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformation'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa'), require('./model/CommerceSolutionsProductsBinLookup'), require('./model/CommerceSolutionsProductsBinLookupConfigurationInformation'), require('./model/CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations'), require('./model/CommerceSolutionsProductsTokenManagement'), require('./model/CommerceSolutionsProductsTokenManagementConfigurationInformation'), require('./model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations'), require('./model/CreateAdhocReportRequest'), require('./model/CreateBillingAgreement'), require('./model/CreateBundledDecisionManagerCaseRequest'), require('./model/CreateCreditRequest'), require('./model/CreateInvoiceRequest'), require('./model/CreateP12KeysRequest'), require('./model/CreatePaymentRequest'), require('./model/CreatePlanRequest'), require('./model/CreatePlanResponse'), require('./model/CreatePlanResponsePlanInformation'), require('./model/CreateReportSubscriptionRequest'), require('./model/CreateSearchRequest'), require('./model/CreateSessionReq'), require('./model/CreateSessionRequest'), require('./model/CreateSharedSecretKeysRequest'), require('./model/CreateSharedSecretKeysVerifiRequest'), require('./model/CreateSubscriptionRequest'), require('./model/CreateSubscriptionResponse'), require('./model/CreateSubscriptionResponseLinks'), require('./model/CreateSubscriptionResponseSubscriptionInformation'), require('./model/CreateWebhookRequest'), require('./model/DeleteBulkP12KeysRequest'), require('./model/DeleteBulkSymmetricKeysRequest'), require('./model/DeletePlanResponse'), require('./model/DmConfig'), require('./model/DmConfigOrganization'), require('./model/DmConfigPortfolioControls'), require('./model/DmConfigProcessingOptions'), require('./model/DmConfigThirdparty'), require('./model/DmConfigThirdpartyProvider'), require('./model/DmConfigThirdpartyProviderAccurint'), require('./model/DmConfigThirdpartyProviderAccurintCredentials'), require('./model/DmConfigThirdpartyProviderCredilink'), require('./model/DmConfigThirdpartyProviderCredilinkCredentials'), require('./model/DmConfigThirdpartyProviderEkata'), require('./model/DmConfigThirdpartyProviderEkataCredentials'), require('./model/DmConfigThirdpartyProviderEmailage'), require('./model/DmConfigThirdpartyProviderPerseuss'), require('./model/DmConfigThirdpartyProviderSignifyd'), require('./model/DmConfigThirdpartyProviderSignifydCredentials'), require('./model/DmConfigThirdpartyProviderTargus'), require('./model/DmConfigThirdpartyProviderTargusCredentials'), require('./model/ECheckConfig'), require('./model/ECheckConfigCommon'), require('./model/ECheckConfigCommonInternalOnly'), require('./model/ECheckConfigCommonInternalOnlyProcessors'), require('./model/ECheckConfigCommonProcessors'), require('./model/ECheckConfigFeatures'), require('./model/ECheckConfigFeaturesAccountValidationService'), require('./model/ECheckConfigFeaturesAccountValidationServiceInternalOnly'), require('./model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors'), require('./model/ECheckConfigFeaturesAccountValidationServiceProcessors'), require('./model/ECheckConfigUnderwriting'), require('./model/FraudMarkingActionRequest'), require('./model/GenerateCaptureContextRequest'), require('./model/GenerateUnifiedCheckoutCaptureContextRequest'), require('./model/GetAllPlansResponse'), require('./model/GetAllPlansResponseLinks'), require('./model/GetAllPlansResponseOrderInformation'), require('./model/GetAllPlansResponseOrderInformationAmountDetails'), require('./model/GetAllPlansResponsePlanInformation'), require('./model/GetAllPlansResponsePlanInformationBillingCycles'), require('./model/GetAllPlansResponsePlanInformationBillingPeriod'), require('./model/GetAllPlansResponsePlans'), require('./model/GetAllSubscriptionsResponse'), require('./model/GetAllSubscriptionsResponseLinks'), require('./model/GetAllSubscriptionsResponseOrderInformation'), require('./model/GetAllSubscriptionsResponseOrderInformationBillTo'), require('./model/GetAllSubscriptionsResponsePaymentInformation'), require('./model/GetAllSubscriptionsResponsePaymentInformationCustomer'), require('./model/GetAllSubscriptionsResponsePlanInformation'), require('./model/GetAllSubscriptionsResponsePlanInformationBillingCycles'), require('./model/GetAllSubscriptionsResponseSubscriptionInformation'), require('./model/GetAllSubscriptionsResponseSubscriptions'), require('./model/GetPlanCodeResponse'), require('./model/GetPlanResponse'), require('./model/GetSubscriptionCodeResponse'), require('./model/GetSubscriptionResponse'), require('./model/IncrementAuthRequest'), require('./model/InlineResponse200'), require('./model/InlineResponse2001'), require('./model/InlineResponse2001Keys'), require('./model/InlineResponse2002'), require('./model/InlineResponse2002IntegrationInformation'), require('./model/InlineResponse2002IntegrationInformationTenantConfigurations'), require('./model/InlineResponse2003'), require('./model/InlineResponse2004'), require('./model/InlineResponse2005'), require('./model/InlineResponse2006'), require('./model/InlineResponse2006Embedded'), require('./model/InlineResponse2006EmbeddedBatches'), require('./model/InlineResponse2006EmbeddedLinks'), require('./model/InlineResponse2006EmbeddedLinksReports'), require('./model/InlineResponse2006EmbeddedTotals'), require('./model/InlineResponse2006Links'), require('./model/InlineResponse2007'), require('./model/InlineResponse2007Billing'), require('./model/InlineResponse2007Links'), require('./model/InlineResponse2007LinksReport'), require('./model/InlineResponse2008'), require('./model/InlineResponse2008Records'), require('./model/InlineResponse2008ResponseRecord'), require('./model/InlineResponse2008ResponseRecordAdditionalUpdates'), require('./model/InlineResponse2008SourceRecord'), require('./model/InlineResponse200Embedded'), require('./model/InlineResponse200EmbeddedCapture'), require('./model/InlineResponse200EmbeddedCaptureLinks'), require('./model/InlineResponse200EmbeddedCaptureLinksSelf'), require('./model/InlineResponse200EmbeddedReversal'), require('./model/InlineResponse200EmbeddedReversalLinks'), require('./model/InlineResponse200EmbeddedReversalLinksSelf'), require('./model/InlineResponse201'), require('./model/InlineResponse2011'), require('./model/InlineResponse2011IntegrationInformation'), require('./model/InlineResponse2011IntegrationInformationTenantConfigurations'), require('./model/InlineResponse2011OrganizationInformation'), require('./model/InlineResponse2011ProductInformationSetups'), require('./model/InlineResponse2011RegistrationInformation'), require('./model/InlineResponse2011Setups'), require('./model/InlineResponse2011SetupsCommerceSolutions'), require('./model/InlineResponse2011SetupsPayments'), require('./model/InlineResponse2011SetupsPaymentsCardProcessing'), require('./model/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus'), require('./model/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus'), require('./model/InlineResponse2011SetupsPaymentsDigitalPayments'), require('./model/InlineResponse2011SetupsRisk'), require('./model/InlineResponse2011SetupsValueAddedServices'), require('./model/InlineResponse2012'), require('./model/InlineResponse2012KeyInformation'), require('./model/InlineResponse2012KeyInformationErrorInformation'), require('./model/InlineResponse2012KeyInformationErrorInformationDetails'), require('./model/InlineResponse2013'), require('./model/InlineResponse2014'), require('./model/InlineResponse202'), require('./model/InlineResponse202Links'), require('./model/InlineResponse202LinksStatus'), require('./model/InlineResponse400'), require('./model/InlineResponse4001'), require('./model/InlineResponse4002'), require('./model/InlineResponse4003'), require('./model/InlineResponse4004'), require('./model/InlineResponse4004Fields'), require('./model/InlineResponse4005'), require('./model/InlineResponse4006'), require('./model/InlineResponse4007'), require('./model/InlineResponse4007Details'), require('./model/InlineResponse4008'), require('./model/InlineResponse4008Details'), require('./model/InlineResponse400Details'), require('./model/InlineResponse400Errors'), require('./model/InlineResponse401'), require('./model/InlineResponse401Fields'), require('./model/InlineResponse401Links'), require('./model/InlineResponse401LinksSelf'), require('./model/InlineResponse403'), require('./model/InlineResponse4031'), require('./model/InlineResponse403Errors'), require('./model/InlineResponse404'), require('./model/InlineResponse4041'), require('./model/InlineResponse4042'), require('./model/InlineResponse4042Details'), require('./model/InlineResponse409'), require('./model/InlineResponse409Errors'), require('./model/InlineResponse410'), require('./model/InlineResponse410Errors'), require('./model/InlineResponse412'), require('./model/InlineResponse412Errors'), require('./model/InlineResponse422'), require('./model/InlineResponse4221'), require('./model/InlineResponse424'), require('./model/InlineResponse424Errors'), require('./model/InlineResponse500'), require('./model/InlineResponse5001'), require('./model/InlineResponse5002'), require('./model/InlineResponse5003'), require('./model/InlineResponse500Errors'), require('./model/InlineResponse502'), require('./model/InlineResponse5021'), require('./model/InlineResponse503'), require('./model/InlineResponseDefault'), require('./model/InlineResponseDefaultLinks'), require('./model/InlineResponseDefaultLinksNext'), require('./model/InlineResponseDefaultResponseStatus'), require('./model/InlineResponseDefaultResponseStatusDetails'), require('./model/IntimateBillingAgreement'), require('./model/InvoiceSettingsRequest'), require('./model/InvoicingV2InvoiceSettingsGet200Response'), require('./model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation'), require('./model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle'), require('./model/InvoicingV2InvoicesAllGet200Response'), require('./model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseInvoiceInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseInvoices'), require('./model/InvoicingV2InvoicesAllGet200ResponseLinks'), require('./model/InvoicingV2InvoicesAllGet200ResponseOrderInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails'), require('./model/InvoicingV2InvoicesAllGet400Response'), require('./model/InvoicingV2InvoicesAllGet404Response'), require('./model/InvoicingV2InvoicesAllGet502Response'), require('./model/InvoicingV2InvoicesGet200Response'), require('./model/InvoicingV2InvoicesGet200ResponseInvoiceHistory'), require('./model/InvoicingV2InvoicesGet200ResponseTransactionDetails'), require('./model/InvoicingV2InvoicesPost201Response'), require('./model/InvoicingV2InvoicesPost201ResponseInvoiceInformation'), require('./model/InvoicingV2InvoicesPost201ResponseOrderInformation'), require('./model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails'), require('./model/InvoicingV2InvoicesPost202Response'), require('./model/Invoicingv2invoiceSettingsInvoiceSettingsInformation'), require('./model/Invoicingv2invoicesCustomerInformation'), require('./model/Invoicingv2invoicesCustomerInformationCompany'), require('./model/Invoicingv2invoicesInvoiceInformation'), require('./model/Invoicingv2invoicesOrderInformation'), require('./model/Invoicingv2invoicesOrderInformationAmountDetails'), require('./model/Invoicingv2invoicesOrderInformationAmountDetailsFreight'), require('./model/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails'), require('./model/Invoicingv2invoicesOrderInformationLineItems'), require('./model/Invoicingv2invoicesidInvoiceInformation'), require('./model/KmsV2KeysAsymDeletesPost200Response'), require('./model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation'), require('./model/KmsV2KeysAsymGet200Response'), require('./model/KmsV2KeysAsymGet200ResponseKeyInformation'), require('./model/KmsV2KeysAsymPost201Response'), require('./model/KmsV2KeysAsymPost201ResponseCertificateInformation'), require('./model/KmsV2KeysAsymPost201ResponseKeyInformation'), require('./model/KmsV2KeysSymDeletesPost200Response'), require('./model/KmsV2KeysSymDeletesPost200ResponseKeyInformation'), require('./model/KmsV2KeysSymGet200Response'), require('./model/KmsV2KeysSymGet200ResponseKeyInformation'), require('./model/KmsV2KeysSymPost201Response'), require('./model/KmsV2KeysSymPost201ResponseErrorInformation'), require('./model/KmsV2KeysSymPost201ResponseKeyInformation'), require('./model/Kmsegressv2keysasymClientReferenceInformation'), require('./model/Kmsegressv2keysasymKeyInformation'), require('./model/Kmsegressv2keyssymClientReferenceInformation'), require('./model/Kmsegressv2keyssymKeyInformation'), require('./model/Kmsv2keysasymKeyInformation'), require('./model/Kmsv2keyssymClientReferenceInformation'), require('./model/Kmsv2keyssymKeyInformation'), require('./model/Kmsv2keyssymdeletesKeyInformation'), require('./model/Kmsv2keyssymverifiKeyInformation'), require('./model/MerchantInitiatedTransactionObject'), require('./model/Microformv2sessionsCheckoutApiInitialization'), require('./model/MitReversalRequest'), require('./model/MitVoidRequest'), require('./model/ModifyBillingAgreement'), require('./model/Notificationsubscriptionsv1productsorganizationIdEventTypes'), require('./model/Notificationsubscriptionsv1webhooksNotificationScope'), require('./model/Notificationsubscriptionsv1webhooksProducts'), require('./model/Notificationsubscriptionsv1webhooksRetryPolicy'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1Config'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicyConfig'), require('./model/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus'), require('./model/OctCreatePaymentRequest'), require('./model/OrderPaymentRequest'), require('./model/PatchCustomerPaymentInstrumentRequest'), require('./model/PatchCustomerRequest'), require('./model/PatchCustomerShippingAddressRequest'), require('./model/PatchInstrumentIdentifierRequest'), require('./model/PatchPaymentInstrumentRequest'), require('./model/PayerAuthConfig'), require('./model/PayerAuthConfigCardTypes'), require('./model/PayerAuthConfigCardTypesCB'), require('./model/PayerAuthConfigCardTypesJCBJSecure'), require('./model/PayerAuthConfigCardTypesVerifiedByVisa'), require('./model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies'), require('./model/PayerAuthSetupRequest'), require('./model/PaymentInstrumentList'), require('./model/PaymentInstrumentList1'), require('./model/PaymentInstrumentList1Embedded'), require('./model/PaymentInstrumentList1EmbeddedEmbedded'), require('./model/PaymentInstrumentList1EmbeddedPaymentInstruments'), require('./model/PaymentInstrumentListEmbedded'), require('./model/PaymentInstrumentListLinks'), require('./model/PaymentInstrumentListLinksFirst'), require('./model/PaymentInstrumentListLinksLast'), require('./model/PaymentInstrumentListLinksNext'), require('./model/PaymentInstrumentListLinksPrev'), require('./model/PaymentInstrumentListLinksSelf'), require('./model/PaymentsProducts'), require('./model/PaymentsProductsCardPresentConnect'), require('./model/PaymentsProductsCardPresentConnectConfigurationInformation'), require('./model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations'), require('./model/PaymentsProductsCardPresentConnectSubscriptionInformation'), require('./model/PaymentsProductsCardProcessing'), require('./model/PaymentsProductsCardProcessingConfigurationInformation'), require('./model/PaymentsProductsCardProcessingSubscriptionInformation'), require('./model/PaymentsProductsCardProcessingSubscriptionInformationFeatures'), require('./model/PaymentsProductsCurrencyConversion'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformation'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurations'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors'), require('./model/PaymentsProductsCybsReadyTerminal'), require('./model/PaymentsProductsDifferentialFee'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformation'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformationFeatures'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge'), require('./model/PaymentsProductsDigitalPayments'), require('./model/PaymentsProductsDigitalPaymentsSubscriptionInformation'), require('./model/PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures'), require('./model/PaymentsProductsECheck'), require('./model/PaymentsProductsECheckConfigurationInformation'), require('./model/PaymentsProductsECheckSubscriptionInformation'), require('./model/PaymentsProductsPayerAuthentication'), require('./model/PaymentsProductsPayerAuthenticationConfigurationInformation'), require('./model/PaymentsProductsPayerAuthenticationSubscriptionInformation'), require('./model/PaymentsProductsPayouts'), require('./model/PaymentsProductsPayoutsConfigurationInformation'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurations'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds'), require('./model/PaymentsProductsSecureAcceptance'), require('./model/PaymentsProductsSecureAcceptanceConfigurationInformation'), require('./model/PaymentsProductsTax'), require('./model/PaymentsProductsVirtualTerminal'), require('./model/PaymentsProductsVirtualTerminalConfigurationInformation'), require('./model/PaymentsStrongAuthIssuerInformation'), require('./model/PostCustomerPaymentInstrumentRequest'), require('./model/PostCustomerRequest'), require('./model/PostCustomerShippingAddressRequest'), require('./model/PostInstrumentIdentifierEnrollmentRequest'), require('./model/PostInstrumentIdentifierRequest'), require('./model/PostPaymentCredentialsRequest'), require('./model/PostPaymentInstrumentRequest'), require('./model/PostRegistrationBody'), require('./model/PredefinedSubscriptionRequestBean'), require('./model/PtsV1TransactionBatchesGet200Response'), require('./model/PtsV1TransactionBatchesGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesGet200ResponseLinksSelf'), require('./model/PtsV1TransactionBatchesGet200ResponseTransactionBatches'), require('./model/PtsV1TransactionBatchesGet400Response'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails'), require('./model/PtsV1TransactionBatchesGet500Response'), require('./model/PtsV1TransactionBatchesGet500ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesIdGet200Response'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions'), require('./model/PtsV2CreateBillingAgreementPost201Response'), require('./model/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseLinks'), require('./model/PtsV2CreateBillingAgreementPost201ResponseProcessorInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseRiskInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults'), require('./model/PtsV2CreateBillingAgreementPost400Response'), require('./model/PtsV2CreateBillingAgreementPost502Response'), require('./model/PtsV2CreditsPost201Response'), require('./model/PtsV2CreditsPost201Response1'), require('./model/PtsV2CreditsPost201Response1ProcessorInformation'), require('./model/PtsV2CreditsPost201ResponseCreditAmountDetails'), require('./model/PtsV2CreditsPost201ResponsePaymentInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2IncrementalAuthorizationPatch201Response'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseLinks'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation'), require('./model/PtsV2IncrementalAuthorizationPatch400Response'), require('./model/PtsV2ModifyBillingAgreementPost201Response'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseLinks'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsCapturesPost201Response'), require('./model/PtsV2PaymentsCapturesPost201ResponseLinks'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsCapturesPost400Response'), require('./model/PtsV2PaymentsOrderPost201Response'), require('./model/PtsV2PaymentsOrderPost201ResponseBuyerInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails'), require('./model/PtsV2PaymentsOrderPost201ResponsePaymentInformation'), require('./model/PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection'), require('./model/PtsV2PaymentsPost201Response'), require('./model/PtsV2PaymentsPost201Response1'), require('./model/PtsV2PaymentsPost201Response1OrderInformation'), require('./model/PtsV2PaymentsPost201Response1OrderInformationBillTo'), require('./model/PtsV2PaymentsPost201Response1OrderInformationShipTo'), require('./model/PtsV2PaymentsPost201Response1PaymentInformation'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationBank'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationBankAccount'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationPaymentType'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod'), require('./model/PtsV2PaymentsPost201Response1ProcessorInformation'), require('./model/PtsV2PaymentsPost201Response1ProcessorInformationAvs'), require('./model/PtsV2PaymentsPost201Response2'), require('./model/PtsV2PaymentsPost201Response2OrderInformation'), require('./model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails'), require('./model/PtsV2PaymentsPost201Response2PaymentInformation'), require('./model/PtsV2PaymentsPost201Response2PaymentInformationEWallet'), require('./model/PtsV2PaymentsPost201Response2ProcessorInformation'), require('./model/PtsV2PaymentsPost201ResponseBuyerInformation'), require('./model/PtsV2PaymentsPost201ResponseClientReferenceInformation'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActions'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING'), require('./model/PtsV2PaymentsPost201ResponseErrorInformation'), require('./model/PtsV2PaymentsPost201ResponseErrorInformationDetails'), require('./model/PtsV2PaymentsPost201ResponseInstallmentInformation'), require('./model/PtsV2PaymentsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsPost201ResponseLinks'), require('./model/PtsV2PaymentsPost201ResponseLinksSelf'), require('./model/PtsV2PaymentsPost201ResponseMerchantInformation'), require('./model/PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor'), require('./model/PtsV2PaymentsPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationBillTo'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationShipTo'), require('./model/PtsV2PaymentsPost201ResponsePaymentAccountInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBank'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard'), require('./model/PtsV2PaymentsPost201ResponsePaymentInsightsInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformation'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAvs'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationRouting'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection'), require('./model/PtsV2PaymentsPost201ResponseRiskInformation'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationInfoCodes'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationIpAddress'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationProcessorResults'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationProfile'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationRules'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationScore'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravel'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationVelocity'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing'), require('./model/PtsV2PaymentsPost201ResponseTokenInformation'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationCustomer'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationShippingAddress'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformation'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches'), require('./model/PtsV2PaymentsPost400Response'), require('./model/PtsV2PaymentsPost502Response'), require('./model/PtsV2PaymentsRefundPost201Response'), require('./model/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseLinks'), require('./model/PtsV2PaymentsRefundPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsRefundPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails'), require('./model/PtsV2PaymentsRefundPost400Response'), require('./model/PtsV2PaymentsReversalsPost201Response'), require('./model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails'), require('./model/PtsV2PaymentsReversalsPost400Response'), require('./model/PtsV2PaymentsVoidsPost201Response'), require('./model/PtsV2PaymentsVoidsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails'), require('./model/PtsV2PaymentsVoidsPost400Response'), require('./model/PtsV2PayoutsPost201Response'), require('./model/PtsV2PayoutsPost201ResponseErrorInformation'), require('./model/PtsV2PayoutsPost201ResponseIssuerInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor'), require('./model/PtsV2PayoutsPost201ResponseOrderInformation'), require('./model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PayoutsPost201ResponseProcessorInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformationCard'), require('./model/PtsV2PayoutsPost400Response'), require('./model/Ptsv1pushfundstransferAggregatorInformation'), require('./model/Ptsv1pushfundstransferAggregatorInformationSubMerchant'), require('./model/Ptsv1pushfundstransferClientReferenceInformation'), require('./model/Ptsv1pushfundstransferMerchantDefinedInformation'), require('./model/Ptsv1pushfundstransferMerchantInformation'), require('./model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor'), require('./model/Ptsv1pushfundstransferOrderInformation'), require('./model/Ptsv1pushfundstransferOrderInformationAmountDetails'), require('./model/Ptsv1pushfundstransferOrderInformationSurcharge'), require('./model/Ptsv1pushfundstransferPointOfServiceInformation'), require('./model/Ptsv1pushfundstransferProcessingInformation'), require('./model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions'), require('./model/Ptsv1pushfundstransferProcessingInformationRecurringOptions'), require('./model/Ptsv1pushfundstransferProcessingOptions'), require('./model/Ptsv1pushfundstransferProcessingOptionsFundingOptions'), require('./model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator'), require('./model/Ptsv1pushfundstransferRecipientInformation'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformation'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument'), require('./model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification'), require('./model/Ptsv1pushfundstransferSenderInformation'), require('./model/Ptsv1pushfundstransferSenderInformationAccount'), require('./model/Ptsv1pushfundstransferSenderInformationPaymentInformation'), require('./model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard'), require('./model/Ptsv1pushfundstransferSenderInformationPersonalIdentification'), require('./model/Ptsv2billingagreementsAggregatorInformation'), require('./model/Ptsv2billingagreementsAgreementInformation'), require('./model/Ptsv2billingagreementsBuyerInformation'), require('./model/Ptsv2billingagreementsClientReferenceInformation'), require('./model/Ptsv2billingagreementsConsumerAuthenticationInformation'), require('./model/Ptsv2billingagreementsDeviceInformation'), require('./model/Ptsv2billingagreementsInstallmentInformation'), require('./model/Ptsv2billingagreementsMerchantInformation'), require('./model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2billingagreementsOrderInformation'), require('./model/Ptsv2billingagreementsOrderInformationBillTo'), require('./model/Ptsv2billingagreementsPaymentInformation'), require('./model/Ptsv2billingagreementsPaymentInformationBank'), require('./model/Ptsv2billingagreementsPaymentInformationBankAccount'), require('./model/Ptsv2billingagreementsPaymentInformationCard'), require('./model/Ptsv2billingagreementsPaymentInformationPaymentType'), require('./model/Ptsv2billingagreementsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2billingagreementsPaymentInformationTokenizedCard'), require('./model/Ptsv2billingagreementsProcessingInformation'), require('./model/Ptsv2billingagreementsidAgreementInformation'), require('./model/Ptsv2billingagreementsidBuyerInformation'), require('./model/Ptsv2billingagreementsidProcessingInformation'), require('./model/Ptsv2creditsInstallmentInformation'), require('./model/Ptsv2creditsProcessingInformation'), require('./model/Ptsv2creditsProcessingInformationBankTransferOptions'), require('./model/Ptsv2creditsProcessingInformationElectronicBenefitsTransfer'), require('./model/Ptsv2creditsProcessingInformationJapanPaymentOptions'), require('./model/Ptsv2creditsProcessingInformationPurchaseOptions'), require('./model/Ptsv2creditsProcessingInformationRefundOptions'), require('./model/Ptsv2creditsRecipientInformation'), require('./model/Ptsv2creditsSenderInformation'), require('./model/Ptsv2creditsSenderInformationAccount'), require('./model/Ptsv2paymentreferencesAgreementInformation'), require('./model/Ptsv2paymentreferencesBuyerInformation'), require('./model/Ptsv2paymentreferencesDeviceInformation'), require('./model/Ptsv2paymentreferencesMerchantInformation'), require('./model/Ptsv2paymentreferencesOrderInformation'), require('./model/Ptsv2paymentreferencesOrderInformationAmountDetails'), require('./model/Ptsv2paymentreferencesOrderInformationBillTo'), require('./model/Ptsv2paymentreferencesOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentreferencesOrderInformationLineItems'), require('./model/Ptsv2paymentreferencesOrderInformationShipTo'), require('./model/Ptsv2paymentreferencesPaymentInformation'), require('./model/Ptsv2paymentreferencesPaymentInformationBank'), require('./model/Ptsv2paymentreferencesPaymentInformationBankAccount'), require('./model/Ptsv2paymentreferencesPaymentInformationCard'), require('./model/Ptsv2paymentreferencesPaymentInformationEWallet'), require('./model/Ptsv2paymentreferencesPaymentInformationOptions'), require('./model/Ptsv2paymentreferencesProcessingInformation'), require('./model/Ptsv2paymentreferencesTravelInformation'), require('./model/Ptsv2paymentreferencesTravelInformationAutoRental'), require('./model/Ptsv2paymentreferencesUserInterface'), require('./model/Ptsv2paymentreferencesUserInterfaceColor'), require('./model/Ptsv2paymentreferencesidintentsOrderInformation'), require('./model/Ptsv2paymentreferencesidintentsPaymentInformation'), require('./model/Ptsv2paymentreferencesidintentsPaymentInformationEWallet'), require('./model/Ptsv2paymentreferencesidintentsProcessingInformation'), require('./model/Ptsv2paymentsAcquirerInformation'), require('./model/Ptsv2paymentsAggregatorInformation'), require('./model/Ptsv2paymentsAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsAgreementInformation'), require('./model/Ptsv2paymentsBuyerInformation'), require('./model/Ptsv2paymentsBuyerInformationPersonalIdentification'), require('./model/Ptsv2paymentsClientReferenceInformation'), require('./model/Ptsv2paymentsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsConsumerAuthenticationInformation'), require('./model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication'), require('./model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation'), require('./model/Ptsv2paymentsDeviceInformation'), require('./model/Ptsv2paymentsDeviceInformationRawData'), require('./model/Ptsv2paymentsHealthCareInformation'), require('./model/Ptsv2paymentsHealthCareInformationAmountDetails'), require('./model/Ptsv2paymentsHostedPaymentInformation'), require('./model/Ptsv2paymentsHostedPaymentInformationUserAgent'), require('./model/Ptsv2paymentsInstallmentInformation'), require('./model/Ptsv2paymentsInvoiceDetails'), require('./model/Ptsv2paymentsIssuerInformation'), require('./model/Ptsv2paymentsMerchantDefinedInformation'), require('./model/Ptsv2paymentsMerchantDefinedSecureInformation'), require('./model/Ptsv2paymentsMerchantInformation'), require('./model/Ptsv2paymentsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor'), require('./model/Ptsv2paymentsMerchantInformationServiceLocation'), require('./model/Ptsv2paymentsOrderInformation'), require('./model/Ptsv2paymentsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsOrder'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails'), require('./model/Ptsv2paymentsOrderInformationBillTo'), require('./model/Ptsv2paymentsOrderInformationBillToCompany'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum'), require('./model/Ptsv2paymentsOrderInformationLineItems'), require('./model/Ptsv2paymentsOrderInformationPassenger'), require('./model/Ptsv2paymentsOrderInformationShipTo'), require('./model/Ptsv2paymentsOrderInformationShippingDetails'), require('./model/Ptsv2paymentsPaymentInformation'), require('./model/Ptsv2paymentsPaymentInformationBank'), require('./model/Ptsv2paymentsPaymentInformationBankAccount'), require('./model/Ptsv2paymentsPaymentInformationCard'), require('./model/Ptsv2paymentsPaymentInformationCustomer'), require('./model/Ptsv2paymentsPaymentInformationDirectDebit'), require('./model/Ptsv2paymentsPaymentInformationDirectDebitMandate'), require('./model/Ptsv2paymentsPaymentInformationEWallet'), require('./model/Ptsv2paymentsPaymentInformationFluidData'), require('./model/Ptsv2paymentsPaymentInformationInstrumentIdentifier'), require('./model/Ptsv2paymentsPaymentInformationLegacyToken'), require('./model/Ptsv2paymentsPaymentInformationOptions'), require('./model/Ptsv2paymentsPaymentInformationPaymentInstrument'), require('./model/Ptsv2paymentsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsPaymentInformationSepa'), require('./model/Ptsv2paymentsPaymentInformationSepaDirectDebit'), require('./model/Ptsv2paymentsPaymentInformationShippingAddress'), require('./model/Ptsv2paymentsPaymentInformationTokenizedCard'), require('./model/Ptsv2paymentsPointOfSaleInformation'), require('./model/Ptsv2paymentsPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsProcessingInformation'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/Ptsv2paymentsProcessingInformationBankTransferOptions'), require('./model/Ptsv2paymentsProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer'), require('./model/Ptsv2paymentsProcessingInformationJapanPaymentOptions'), require('./model/Ptsv2paymentsProcessingInformationLoanOptions'), require('./model/Ptsv2paymentsProcessingInformationPurchaseOptions'), require('./model/Ptsv2paymentsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsProcessorInformation'), require('./model/Ptsv2paymentsProcessorInformationAuthorizationOptions'), require('./model/Ptsv2paymentsProcessorInformationReversal'), require('./model/Ptsv2paymentsPromotionInformation'), require('./model/Ptsv2paymentsRecipientInformation'), require('./model/Ptsv2paymentsRecurringPaymentInformation'), require('./model/Ptsv2paymentsRiskInformation'), require('./model/Ptsv2paymentsRiskInformationAuxiliaryData'), require('./model/Ptsv2paymentsRiskInformationBuyerHistory'), require('./model/Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory'), require('./model/Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount'), require('./model/Ptsv2paymentsRiskInformationProfile'), require('./model/Ptsv2paymentsTokenInformation'), require('./model/Ptsv2paymentsTokenInformationPaymentInstrument'), require('./model/Ptsv2paymentsTokenInformationShippingAddress'), require('./model/Ptsv2paymentsTravelInformation'), require('./model/Ptsv2paymentsTravelInformationAgency'), require('./model/Ptsv2paymentsTravelInformationAutoRental'), require('./model/Ptsv2paymentsTravelInformationAutoRentalRentalAddress'), require('./model/Ptsv2paymentsTravelInformationAutoRentalReturnAddress'), require('./model/Ptsv2paymentsTravelInformationAutoRentalTaxDetails'), require('./model/Ptsv2paymentsTravelInformationLodging'), require('./model/Ptsv2paymentsTravelInformationLodgingRoom'), require('./model/Ptsv2paymentsTravelInformationTransit'), require('./model/Ptsv2paymentsTravelInformationTransitAirline'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineLegs'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer'), require('./model/Ptsv2paymentsTravelInformationVehicleData'), require('./model/Ptsv2paymentsWatchlistScreeningInformation'), require('./model/Ptsv2paymentsWatchlistScreeningInformationWeights'), require('./model/Ptsv2paymentsidClientReferenceInformation'), require('./model/Ptsv2paymentsidClientReferenceInformationPartner'), require('./model/Ptsv2paymentsidMerchantInformation'), require('./model/Ptsv2paymentsidOrderInformation'), require('./model/Ptsv2paymentsidOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidProcessingInformation'), require('./model/Ptsv2paymentsidProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator'), require('./model/Ptsv2paymentsidTravelInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsidcapturesBuyerInformation'), require('./model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification'), require('./model/Ptsv2paymentsidcapturesDeviceInformation'), require('./model/Ptsv2paymentsidcapturesInstallmentInformation'), require('./model/Ptsv2paymentsidcapturesMerchantInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationBillTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationShipTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationShippingDetails'), require('./model/Ptsv2paymentsidcapturesPaymentInformation'), require('./model/Ptsv2paymentsidcapturesPaymentInformationCard'), require('./model/Ptsv2paymentsidcapturesPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformation'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsidcapturesProcessingInformation'), require('./model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsidrefundsClientReferenceInformation'), require('./model/Ptsv2paymentsidrefundsMerchantInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformationLineItems'), require('./model/Ptsv2paymentsidrefundsPaymentInformation'), require('./model/Ptsv2paymentsidrefundsPaymentInformationBank'), require('./model/Ptsv2paymentsidrefundsPaymentInformationBankAccount'), require('./model/Ptsv2paymentsidrefundsPaymentInformationCard'), require('./model/Ptsv2paymentsidrefundsPaymentInformationEWallet'), require('./model/Ptsv2paymentsidrefundsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidrefundsPointOfSaleInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsidrefundsProcessingInformationRefundOptions'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformation'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsidreversalsOrderInformation'), require('./model/Ptsv2paymentsidreversalsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidreversalsOrderInformationLineItems'), require('./model/Ptsv2paymentsidreversalsPaymentInformation'), require('./model/Ptsv2paymentsidreversalsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsidreversalsPointOfSaleInformation'), require('./model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsidreversalsProcessingInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformationAmountDetails'), require('./model/Ptsv2paymentsidvoidsAgreementInformation'), require('./model/Ptsv2paymentsidvoidsMerchantInformation'), require('./model/Ptsv2paymentsidvoidsOrderInformation'), require('./model/Ptsv2paymentsidvoidsPaymentInformation'), require('./model/Ptsv2paymentsidvoidsProcessingInformation'), require('./model/Ptsv2payoutsClientReferenceInformation'), require('./model/Ptsv2payoutsMerchantInformation'), require('./model/Ptsv2payoutsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2payoutsOrderInformation'), require('./model/Ptsv2payoutsOrderInformationAmountDetails'), require('./model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2payoutsOrderInformationBillTo'), require('./model/Ptsv2payoutsPaymentInformation'), require('./model/Ptsv2payoutsPaymentInformationCard'), require('./model/Ptsv2payoutsProcessingInformation'), require('./model/Ptsv2payoutsProcessingInformationFundingOptions'), require('./model/Ptsv2payoutsProcessingInformationFundingOptionsInitiator'), require('./model/Ptsv2payoutsProcessingInformationPayoutsOptions'), require('./model/Ptsv2payoutsRecipientInformation'), require('./model/Ptsv2payoutsSenderInformation'), require('./model/Ptsv2payoutsSenderInformationAccount'), require('./model/Ptsv2refreshpaymentstatusidAgreementInformation'), require('./model/Ptsv2refreshpaymentstatusidClientReferenceInformation'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformation'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType'), require('./model/Ptsv2refreshpaymentstatusidProcessingInformation'), require('./model/Ptsv2voidsProcessingInformation'), require('./model/PushFunds201Response'), require('./model/PushFunds201ResponseClientReferenceInformation'), require('./model/PushFunds201ResponseErrorInformation'), require('./model/PushFunds201ResponseErrorInformationDetails'), require('./model/PushFunds201ResponseLinks'), require('./model/PushFunds201ResponseLinksCustomer'), require('./model/PushFunds201ResponseLinksInstrumentIdentifier'), require('./model/PushFunds201ResponseLinksPaymentInstrument'), require('./model/PushFunds201ResponseLinksSelf'), require('./model/PushFunds201ResponseMerchantInformation'), require('./model/PushFunds201ResponseMerchantInformationMerchantDescriptor'), require('./model/PushFunds201ResponseOrderInformation'), require('./model/PushFunds201ResponseOrderInformationAmountDetails'), require('./model/PushFunds201ResponseProcessorInformation'), require('./model/PushFunds201ResponseRecipientInformation'), require('./model/PushFunds201ResponseRecipientInformationCard'), require('./model/PushFunds400Response'), require('./model/PushFunds400ResponseDetails'), require('./model/PushFunds401Response'), require('./model/PushFunds404Response'), require('./model/PushFunds502Response'), require('./model/PushFundsRequest'), require('./model/Rbsv1plansClientReferenceInformation'), require('./model/Rbsv1plansOrderInformation'), require('./model/Rbsv1plansOrderInformationAmountDetails'), require('./model/Rbsv1plansPlanInformation'), require('./model/Rbsv1plansPlanInformationBillingCycles'), require('./model/Rbsv1plansidPlanInformation'), require('./model/Rbsv1plansidProcessingInformation'), require('./model/Rbsv1plansidProcessingInformationSubscriptionBillingOptions'), require('./model/Rbsv1subscriptionsClientReferenceInformation'), require('./model/Rbsv1subscriptionsPaymentInformation'), require('./model/Rbsv1subscriptionsPaymentInformationCustomer'), require('./model/Rbsv1subscriptionsPlanInformation'), require('./model/Rbsv1subscriptionsProcessingInformation'), require('./model/Rbsv1subscriptionsProcessingInformationAuthorizationOptions'), require('./model/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator'), require('./model/Rbsv1subscriptionsSubscriptionInformation'), require('./model/Rbsv1subscriptionsidOrderInformation'), require('./model/Rbsv1subscriptionsidOrderInformationAmountDetails'), require('./model/Rbsv1subscriptionsidPlanInformation'), require('./model/Rbsv1subscriptionsidSubscriptionInformation'), require('./model/RefreshPaymentStatusRequest'), require('./model/RefundCaptureRequest'), require('./model/RefundPaymentRequest'), require('./model/ReplayWebhooksRequest'), require('./model/ReportingV3ChargebackDetailsGet200Response'), require('./model/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails'), require('./model/ReportingV3ChargebackSummariesGet200Response'), require('./model/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries'), require('./model/ReportingV3ConversionDetailsGet200Response'), require('./model/ReportingV3ConversionDetailsGet200ResponseConversionDetails'), require('./model/ReportingV3ConversionDetailsGet200ResponseNotes'), require('./model/ReportingV3InterchangeClearingLevelDetailsGet200Response'), require('./model/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails'), require('./model/ReportingV3NetFundingsGet200Response'), require('./model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries'), require('./model/ReportingV3NetFundingsGet200ResponseTotalPurchases'), require('./model/ReportingV3NotificationofChangesGet200Response'), require('./model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges'), require('./model/ReportingV3PaymentBatchSummariesGet200Response'), require('./model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries'), require('./model/ReportingV3PurchaseRefundDetailsGet200Response'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements'), require('./model/ReportingV3ReportDefinitionsGet200Response'), require('./model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions'), require('./model/ReportingV3ReportDefinitionsNameGet200Response'), require('./model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes'), require('./model/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings'), require('./model/ReportingV3ReportSubscriptionsGet200Response'), require('./model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions'), require('./model/ReportingV3ReportsGet200Response'), require('./model/ReportingV3ReportsGet200ResponseLink'), require('./model/ReportingV3ReportsGet200ResponseLinkReportDownload'), require('./model/ReportingV3ReportsGet200ResponseReportSearchResults'), require('./model/ReportingV3ReportsIdGet200Response'), require('./model/ReportingV3RetrievalDetailsGet200Response'), require('./model/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails'), require('./model/ReportingV3RetrievalSummariesGet200Response'), require('./model/Reportingv3ReportDownloadsGet400Response'), require('./model/Reportingv3ReportDownloadsGet400ResponseDetails'), require('./model/Reportingv3reportsReportFilters'), require('./model/Reportingv3reportsReportPreferences'), require('./model/RiskProducts'), require('./model/RiskProductsDecisionManager'), require('./model/RiskProductsDecisionManagerConfigurationInformation'), require('./model/RiskProductsFraudManagementEssentials'), require('./model/RiskProductsFraudManagementEssentialsConfigurationInformation'), require('./model/RiskV1AddressVerificationsPost201Response'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1'), require('./model/RiskV1AddressVerificationsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationResultsPost201Response'), require('./model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationSetupsPost201Response'), require('./model/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationSetupsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationsPost201Response'), require('./model/RiskV1AuthenticationsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationsPost400Response'), require('./model/RiskV1AuthenticationsPost400Response1'), require('./model/RiskV1DecisionsPost201Response'), require('./model/RiskV1DecisionsPost201ResponseClientReferenceInformation'), require('./model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1DecisionsPost201ResponseErrorInformation'), require('./model/RiskV1DecisionsPost201ResponseOrderInformation'), require('./model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails'), require('./model/RiskV1DecisionsPost201ResponsePaymentInformation'), require('./model/RiskV1DecisionsPost400Response'), require('./model/RiskV1DecisionsPost400Response1'), require('./model/RiskV1ExportComplianceInquiriesPost201Response'), require('./model/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation'), require('./model/RiskV1UpdatePost201Response'), require('./model/Riskv1addressverificationsBuyerInformation'), require('./model/Riskv1addressverificationsOrderInformation'), require('./model/Riskv1addressverificationsOrderInformationBillTo'), require('./model/Riskv1addressverificationsOrderInformationLineItems'), require('./model/Riskv1addressverificationsOrderInformationShipTo'), require('./model/Riskv1authenticationresultsConsumerAuthenticationInformation'), require('./model/Riskv1authenticationresultsDeviceInformation'), require('./model/Riskv1authenticationresultsOrderInformation'), require('./model/Riskv1authenticationresultsOrderInformationAmountDetails'), require('./model/Riskv1authenticationresultsPaymentInformation'), require('./model/Riskv1authenticationresultsPaymentInformationCard'), require('./model/Riskv1authenticationresultsPaymentInformationFluidData'), require('./model/Riskv1authenticationresultsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsBuyerInformation'), require('./model/Riskv1authenticationsDeviceInformation'), require('./model/Riskv1authenticationsOrderInformation'), require('./model/Riskv1authenticationsOrderInformationAmountDetails'), require('./model/Riskv1authenticationsOrderInformationBillTo'), require('./model/Riskv1authenticationsOrderInformationLineItems'), require('./model/Riskv1authenticationsPaymentInformation'), require('./model/Riskv1authenticationsPaymentInformationCard'), require('./model/Riskv1authenticationsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsRiskInformation'), require('./model/Riskv1authenticationsTravelInformation'), require('./model/Riskv1authenticationsetupsPaymentInformation'), require('./model/Riskv1authenticationsetupsPaymentInformationCard'), require('./model/Riskv1authenticationsetupsPaymentInformationCustomer'), require('./model/Riskv1authenticationsetupsPaymentInformationFluidData'), require('./model/Riskv1authenticationsetupsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsetupsProcessingInformation'), require('./model/Riskv1authenticationsetupsTokenInformation'), require('./model/Riskv1decisionsAcquirerInformation'), require('./model/Riskv1decisionsBuyerInformation'), require('./model/Riskv1decisionsClientReferenceInformation'), require('./model/Riskv1decisionsClientReferenceInformationPartner'), require('./model/Riskv1decisionsConsumerAuthenticationInformation'), require('./model/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication'), require('./model/Riskv1decisionsDeviceInformation'), require('./model/Riskv1decisionsMerchantDefinedInformation'), require('./model/Riskv1decisionsMerchantInformation'), require('./model/Riskv1decisionsMerchantInformationMerchantDescriptor'), require('./model/Riskv1decisionsOrderInformation'), require('./model/Riskv1decisionsOrderInformationAmountDetails'), require('./model/Riskv1decisionsOrderInformationBillTo'), require('./model/Riskv1decisionsOrderInformationLineItems'), require('./model/Riskv1decisionsOrderInformationShipTo'), require('./model/Riskv1decisionsOrderInformationShippingDetails'), require('./model/Riskv1decisionsPaymentInformation'), require('./model/Riskv1decisionsPaymentInformationCard'), require('./model/Riskv1decisionsPaymentInformationTokenizedCard'), require('./model/Riskv1decisionsProcessingInformation'), require('./model/Riskv1decisionsProcessorInformation'), require('./model/Riskv1decisionsProcessorInformationAvs'), require('./model/Riskv1decisionsProcessorInformationCardVerification'), require('./model/Riskv1decisionsRiskInformation'), require('./model/Riskv1decisionsTokenInformation'), require('./model/Riskv1decisionsTravelInformation'), require('./model/Riskv1decisionsTravelInformationLegs'), require('./model/Riskv1decisionsTravelInformationPassengers'), require('./model/Riskv1decisionsidactionsDecisionInformation'), require('./model/Riskv1decisionsidactionsProcessingInformation'), require('./model/Riskv1decisionsidmarkingRiskInformation'), require('./model/Riskv1decisionsidmarkingRiskInformationMarkingDetails'), require('./model/Riskv1exportcomplianceinquiriesDeviceInformation'), require('./model/Riskv1exportcomplianceinquiriesExportComplianceInformation'), require('./model/Riskv1exportcomplianceinquiriesOrderInformation'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationBillTo'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationLineItems'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationShipTo'), require('./model/Riskv1liststypeentriesBuyerInformation'), require('./model/Riskv1liststypeentriesClientReferenceInformation'), require('./model/Riskv1liststypeentriesDeviceInformation'), require('./model/Riskv1liststypeentriesOrderInformation'), require('./model/Riskv1liststypeentriesOrderInformationAddress'), require('./model/Riskv1liststypeentriesOrderInformationBillTo'), require('./model/Riskv1liststypeentriesOrderInformationLineItems'), require('./model/Riskv1liststypeentriesOrderInformationShipTo'), require('./model/Riskv1liststypeentriesPaymentInformation'), require('./model/Riskv1liststypeentriesPaymentInformationBank'), require('./model/Riskv1liststypeentriesPaymentInformationCard'), require('./model/Riskv1liststypeentriesRiskInformation'), require('./model/Riskv1liststypeentriesRiskInformationMarkingDetails'), require('./model/SAConfig'), require('./model/SAConfigCheckout'), require('./model/SAConfigContactInformation'), require('./model/SAConfigNotifications'), require('./model/SAConfigNotificationsCustomerNotifications'), require('./model/SAConfigNotificationsMerchantNotifications'), require('./model/SAConfigPaymentMethods'), require('./model/SAConfigPaymentTypes'), require('./model/SAConfigPaymentTypesCardTypes'), require('./model/SAConfigPaymentTypesCardTypesDiscover'), require('./model/SAConfigService'), require('./model/SaveAsymEgressKey'), require('./model/SaveSymEgressKey'), require('./model/SearchRequest'), require('./model/ShippingAddressListForCustomer'), require('./model/ShippingAddressListForCustomerEmbedded'), require('./model/ShippingAddressListForCustomerLinks'), require('./model/ShippingAddressListForCustomerLinksFirst'), require('./model/ShippingAddressListForCustomerLinksLast'), require('./model/ShippingAddressListForCustomerLinksNext'), require('./model/ShippingAddressListForCustomerLinksPrev'), require('./model/ShippingAddressListForCustomerLinksSelf'), require('./model/SuspendSubscriptionResponse'), require('./model/SuspendSubscriptionResponseSubscriptionInformation'), require('./model/TaxRequest'), require('./model/TmsAuthorizationOptions'), require('./model/TmsAuthorizationOptionsInitiator'), require('./model/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/TmsEmbeddedInstrumentIdentifier'), require('./model/TmsEmbeddedInstrumentIdentifierBankAccount'), require('./model/TmsEmbeddedInstrumentIdentifierBillTo'), require('./model/TmsEmbeddedInstrumentIdentifierCard'), require('./model/TmsEmbeddedInstrumentIdentifierIssuer'), require('./model/TmsEmbeddedInstrumentIdentifierLinks'), require('./model/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments'), require('./model/TmsEmbeddedInstrumentIdentifierLinksSelf'), require('./model/TmsEmbeddedInstrumentIdentifierMetadata'), require('./model/TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation'), require('./model/TmsEmbeddedInstrumentIdentifierTokenizedCard'), require('./model/TmsEmbeddedInstrumentIdentifierTokenizedCardCard'), require('./model/TmsPaymentInstrumentProcessingInfo'), require('./model/TmsPaymentInstrumentProcessingInfoBankTransferOptions'), require('./model/Tmsv2customersBuyerInformation'), require('./model/Tmsv2customersClientReferenceInformation'), require('./model/Tmsv2customersDefaultPaymentInstrument'), require('./model/Tmsv2customersDefaultShippingAddress'), require('./model/Tmsv2customersEmbedded'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrument'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddress'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinks'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo'), require('./model/Tmsv2customersLinks'), require('./model/Tmsv2customersLinksPaymentInstruments'), require('./model/Tmsv2customersLinksSelf'), require('./model/Tmsv2customersLinksShippingAddress'), require('./model/Tmsv2customersMerchantDefinedInformation'), require('./model/Tmsv2customersMetadata'), require('./model/Tmsv2customersObjectInformation'), require('./model/TssV2GetEmvTags200Response'), require('./model/TssV2GetEmvTags200ResponseEmvTagBreakdownList'), require('./model/TssV2PostEmvTags200Response'), require('./model/TssV2PostEmvTags200ResponseEmvTagBreakdownList'), require('./model/TssV2PostEmvTags200ResponseParsedEMVTagsList'), require('./model/TssV2TransactionsGet200Response'), require('./model/TssV2TransactionsGet200ResponseApplicationInformation'), require('./model/TssV2TransactionsGet200ResponseApplicationInformationApplications'), require('./model/TssV2TransactionsGet200ResponseBuyerInformation'), require('./model/TssV2TransactionsGet200ResponseClientReferenceInformation'), require('./model/TssV2TransactionsGet200ResponseClientReferenceInformationPartner'), require('./model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation'), require('./model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication'), require('./model/TssV2TransactionsGet200ResponseDeviceInformation'), require('./model/TssV2TransactionsGet200ResponseErrorInformation'), require('./model/TssV2TransactionsGet200ResponseFraudMarkingInformation'), require('./model/TssV2TransactionsGet200ResponseInstallmentInformation'), require('./model/TssV2TransactionsGet200ResponseLinks'), require('./model/TssV2TransactionsGet200ResponseMerchantInformation'), require('./model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor'), require('./model/TssV2TransactionsGet200ResponseOrderInformation'), require('./model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails'), require('./model/TssV2TransactionsGet200ResponseOrderInformationBillTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails'), require('./model/TssV2TransactionsGet200ResponseOrderInformationLineItems'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShipTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails'), require('./model/TssV2TransactionsGet200ResponsePaymentInformation'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBank'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBrands'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationCard'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationCustomer'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationFeatures'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationFluidData'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationInvoice'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationNetwork'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType'), require('./model/TssV2TransactionsGet200ResponsePayoutOptions'), require('./model/TssV2TransactionsGet200ResponsePointOfSaleInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions'), require('./model/TssV2TransactionsGet200ResponseProcessorInformation'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationProcessor'), require('./model/TssV2TransactionsGet200ResponseRecurringPaymentInformation'), require('./model/TssV2TransactionsGet200ResponseRiskInformation'), require('./model/TssV2TransactionsGet200ResponseRiskInformationProfile'), require('./model/TssV2TransactionsGet200ResponseRiskInformationRules'), require('./model/TssV2TransactionsGet200ResponseRiskInformationScore'), require('./model/TssV2TransactionsGet200ResponseSenderInformation'), require('./model/TssV2TransactionsGet200ResponseTokenInformation'), require('./model/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation'), require('./model/TssV2TransactionsPost201Response'), require('./model/TssV2TransactionsPost201ResponseEmbedded'), require('./model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications'), require('./model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner'), require('./model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedLinks'), require('./model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint'), require('./model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries'), require('./model/TssV2TransactionsPost400Response'), require('./model/Tssv2transactionsemvTagDetailsEmvDetailsList'), require('./model/UmsV1UsersGet200Response'), require('./model/UmsV1UsersGet200ResponseAccountInformation'), require('./model/UmsV1UsersGet200ResponseContactInformation'), require('./model/UmsV1UsersGet200ResponseOrganizationInformation'), require('./model/UmsV1UsersGet200ResponseUsers'), require('./model/UpdateAsymKeysRequest'), require('./model/UpdateInvoiceRequest'), require('./model/UpdatePGPKeysRequest'), require('./model/UpdatePGPKeysRequest1'), require('./model/UpdatePasswordKeysRequest'), require('./model/UpdatePlanRequest'), require('./model/UpdatePlanResponse'), require('./model/UpdatePlanResponsePlanInformation'), require('./model/UpdateSubscription'), require('./model/UpdateSubscriptionResponse'), require('./model/UpdateWebhookRequest'), require('./model/Upv1capturecontextsCaptureMandate'), require('./model/Upv1capturecontextsCheckoutApiInitialization'), require('./model/Upv1capturecontextsOrderInformation'), require('./model/Upv1capturecontextsOrderInformationAmountDetails'), require('./model/Upv1capturecontextsOrderInformationBillTo'), require('./model/Upv1capturecontextsOrderInformationBillToCompany'), require('./model/Upv1capturecontextsOrderInformationShipTo'), require('./model/V1FileDetailsGet200Response'), require('./model/V1FileDetailsGet200ResponseFileDetails'), require('./model/V1FileDetailsGet200ResponseLinks'), require('./model/V1FileDetailsGet200ResponseLinksFiles'), require('./model/V1FileDetailsGet200ResponseLinksSelf'), require('./model/VTConfig'), require('./model/VTConfigCardNotPresent'), require('./model/VTConfigCardNotPresentGlobalPaymentInformation'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation'), require('./model/VTConfigCardNotPresentReceiptInformation'), require('./model/VTConfigCardNotPresentReceiptInformationEmailReceipt'), require('./model/VTConfigCardNotPresentReceiptInformationHeader'), require('./model/VTConfigCardNotPresentReceiptInformationOrderInformation'), require('./model/ValidateExportComplianceRequest'), require('./model/ValidateRequest'), require('./model/ValueAddedServicesProducts'), require('./model/VasV2PaymentsPost201Response'), require('./model/VasV2PaymentsPost201ResponseLinks'), require('./model/VasV2PaymentsPost201ResponseOrderInformation'), require('./model/VasV2PaymentsPost201ResponseOrderInformationJurisdiction'), require('./model/VasV2PaymentsPost201ResponseOrderInformationLineItems'), require('./model/VasV2PaymentsPost201ResponseOrderInformationTaxDetails'), require('./model/VasV2PaymentsPost201ResponseTaxInformation'), require('./model/VasV2PaymentsPost400Response'), require('./model/VasV2TaxVoid200Response'), require('./model/VasV2TaxVoid200ResponseVoidAmountDetails'), require('./model/VasV2TaxVoidsPost400Response'), require('./model/Vasv2taxBuyerInformation'), require('./model/Vasv2taxClientReferenceInformation'), require('./model/Vasv2taxMerchantInformation'), require('./model/Vasv2taxOrderInformation'), require('./model/Vasv2taxOrderInformationBillTo'), require('./model/Vasv2taxOrderInformationInvoiceDetails'), require('./model/Vasv2taxOrderInformationLineItems'), require('./model/Vasv2taxOrderInformationOrderAcceptance'), require('./model/Vasv2taxOrderInformationOrderOrigin'), require('./model/Vasv2taxOrderInformationShipTo'), require('./model/Vasv2taxOrderInformationShippingDetails'), require('./model/Vasv2taxTaxInformation'), require('./model/Vasv2taxidClientReferenceInformation'), require('./model/Vasv2taxidClientReferenceInformationPartner'), require('./model/VerifyCustomerAddressRequest'), require('./model/VoidCaptureRequest'), require('./model/VoidCreditRequest'), require('./model/VoidPaymentRequest'), require('./model/VoidRefundRequest'), require('./model/VoidTaxRequest'), require('./model/AccessTokenResponse'), require('./model/BadRequestError'), require('./model/CreateAccessTokenRequest'), require('./model/ResourceNotFoundError'), require('./model/UnauthorizedClientError'), require('./api/AsymmetricKeyManagementApi'), require('./api/BatchesApi'), require('./api/BillingAgreementsApi'), require('./api/CaptureApi'), require('./api/ChargebackDetailsApi'), require('./api/ChargebackSummariesApi'), require('./api/ConversionDetailsApi'), require('./api/CreateNewWebhooksApi'), require('./api/CreditApi'), require('./api/CustomerApi'), require('./api/CustomerPaymentInstrumentApi'), require('./api/CustomerShippingAddressApi'), require('./api/DecisionManagerApi'), require('./api/DownloadDTDApi'), require('./api/DownloadXSDApi'), require('./api/EMVTagDetailsApi'), require('./api/InstrumentIdentifierApi'), require('./api/InterchangeClearingLevelDetailsApi'), require('./api/InvoiceSettingsApi'), require('./api/InvoicesApi'), require('./api/KeyManagementApi'), require('./api/KeyManagementPasswordApi'), require('./api/KeyManagementPgpApi'), require('./api/KeyManagementScmpApi'), require('./api/ManageWebhooksApi'), require('./api/MerchantBoardingApi'), require('./api/MicroformIntegrationApi'), require('./api/NetFundingsApi'), require('./api/NotificationOfChangesApi'), require('./api/PayerAuthenticationApi'), require('./api/PaymentBatchSummariesApi'), require('./api/PaymentInstrumentApi'), require('./api/PaymentsApi'), require('./api/PayoutsApi'), require('./api/PlansApi'), require('./api/PurchaseAndRefundDetailsApi'), require('./api/PushFundsApi'), require('./api/RefundApi'), require('./api/ReplayWebhooksApi'), require('./api/ReportDefinitionsApi'), require('./api/ReportDownloadsApi'), require('./api/ReportSubscriptionsApi'), require('./api/ReportsApi'), require('./api/RetrievalDetailsApi'), require('./api/RetrievalSummariesApi'), require('./api/ReversalApi'), require('./api/SearchTransactionsApi'), require('./api/SecureFileShareApi'), require('./api/SubscriptionsApi'), require('./api/SymmetricKeyManagementApi'), require('./api/TaxesApi'), require('./api/TokenApi'), require('./api/TransactionBatchesApi'), require('./api/TransactionDetailsApi'), require('./api/TransientTokenDataApi'), require('./api/UnifiedCheckoutCaptureContextApi'), require('./api/UserManagementApi'), require('./api/UserManagementSearchApi'), require('./api/VerificationApi'), require('./api/VoidApi'), require('./api/OAuthApi')); + module.exports = factory(require('./ApiClient'), require('./model/Accountupdaterv1batchesIncluded'), require('./model/Accountupdaterv1batchesIncludedTokens'), require('./model/ActivateDeactivatePlanResponse'), require('./model/ActivateSubscriptionResponse'), require('./model/ActivateSubscriptionResponseSubscriptionInformation'), require('./model/AddNegativeListRequest'), require('./model/AuthReversalRequest'), require('./model/Boardingv1registrationsDocumentInformation'), require('./model/Boardingv1registrationsDocumentInformationSignedDocuments'), require('./model/Boardingv1registrationsIntegrationInformation'), require('./model/Boardingv1registrationsIntegrationInformationOauth2'), require('./model/Boardingv1registrationsIntegrationInformationTenantConfigurations'), require('./model/Boardingv1registrationsIntegrationInformationTenantInformation'), require('./model/Boardingv1registrationsOrganizationInformation'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformation'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress'), require('./model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact'), require('./model/Boardingv1registrationsOrganizationInformationKYC'), require('./model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount'), require('./model/Boardingv1registrationsOrganizationInformationOwners'), require('./model/Boardingv1registrationsProductInformation'), require('./model/Boardingv1registrationsProductInformationSelectedProducts'), require('./model/Boardingv1registrationsRegistrationInformation'), require('./model/Body'), require('./model/CancelSubscriptionResponse'), require('./model/CancelSubscriptionResponseSubscriptionInformation'), require('./model/CapturePaymentRequest'), require('./model/CardProcessingConfig'), require('./model/CardProcessingConfigCommon'), require('./model/CardProcessingConfigCommonAcquirer'), require('./model/CardProcessingConfigCommonCurrencies'), require('./model/CardProcessingConfigCommonCurrencies1'), require('./model/CardProcessingConfigCommonMerchantDescriptorInformation'), require('./model/CardProcessingConfigCommonPaymentTypes'), require('./model/CardProcessingConfigCommonProcessors'), require('./model/CardProcessingConfigFeatures'), require('./model/CardProcessingConfigFeaturesCardNotPresent'), require('./model/CardProcessingConfigFeaturesCardNotPresentInstallment'), require('./model/CardProcessingConfigFeaturesCardNotPresentPayouts'), require('./model/CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies'), require('./model/CardProcessingConfigFeaturesCardNotPresentProcessors'), require('./model/CardProcessingConfigFeaturesCardPresent'), require('./model/CardProcessingConfigFeaturesCardPresentProcessors'), require('./model/CaseManagementActionsRequest'), require('./model/CaseManagementCommentsRequest'), require('./model/CheckPayerAuthEnrollmentRequest'), require('./model/CommerceSolutionsProducts'), require('./model/CommerceSolutionsProductsAccountUpdater'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformation'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard'), require('./model/CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa'), require('./model/CommerceSolutionsProductsBinLookup'), require('./model/CommerceSolutionsProductsBinLookupConfigurationInformation'), require('./model/CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations'), require('./model/CommerceSolutionsProductsTokenManagement'), require('./model/CommerceSolutionsProductsTokenManagementConfigurationInformation'), require('./model/CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations'), require('./model/CreateAdhocReportRequest'), require('./model/CreateBillingAgreement'), require('./model/CreateBundledDecisionManagerCaseRequest'), require('./model/CreateCreditRequest'), require('./model/CreateInvoiceRequest'), require('./model/CreateP12KeysRequest'), require('./model/CreatePaymentRequest'), require('./model/CreatePlanRequest'), require('./model/CreatePlanResponse'), require('./model/CreatePlanResponsePlanInformation'), require('./model/CreateReportSubscriptionRequest'), require('./model/CreateSearchRequest'), require('./model/CreateSessionReq'), require('./model/CreateSessionRequest'), require('./model/CreateSharedSecretKeysRequest'), require('./model/CreateSharedSecretKeysVerifiRequest'), require('./model/CreateSubscriptionRequest'), require('./model/CreateSubscriptionResponse'), require('./model/CreateSubscriptionResponseLinks'), require('./model/CreateSubscriptionResponseSubscriptionInformation'), require('./model/CreateWebhookRequest'), require('./model/DeleteBulkP12KeysRequest'), require('./model/DeleteBulkSymmetricKeysRequest'), require('./model/DeletePlanResponse'), require('./model/DmConfig'), require('./model/DmConfigOrganization'), require('./model/DmConfigPortfolioControls'), require('./model/DmConfigProcessingOptions'), require('./model/DmConfigThirdparty'), require('./model/DmConfigThirdpartyProvider'), require('./model/DmConfigThirdpartyProviderAccurint'), require('./model/DmConfigThirdpartyProviderAccurintCredentials'), require('./model/DmConfigThirdpartyProviderCredilink'), require('./model/DmConfigThirdpartyProviderCredilinkCredentials'), require('./model/DmConfigThirdpartyProviderEkata'), require('./model/DmConfigThirdpartyProviderEkataCredentials'), require('./model/DmConfigThirdpartyProviderEmailage'), require('./model/DmConfigThirdpartyProviderPerseuss'), require('./model/DmConfigThirdpartyProviderSignifyd'), require('./model/DmConfigThirdpartyProviderSignifydCredentials'), require('./model/DmConfigThirdpartyProviderTargus'), require('./model/DmConfigThirdpartyProviderTargusCredentials'), require('./model/ECheckConfig'), require('./model/ECheckConfigCommon'), require('./model/ECheckConfigCommonInternalOnly'), require('./model/ECheckConfigCommonInternalOnlyProcessors'), require('./model/ECheckConfigCommonProcessors'), require('./model/ECheckConfigFeatures'), require('./model/ECheckConfigFeaturesAccountValidationService'), require('./model/ECheckConfigFeaturesAccountValidationServiceInternalOnly'), require('./model/ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors'), require('./model/ECheckConfigFeaturesAccountValidationServiceProcessors'), require('./model/ECheckConfigUnderwriting'), require('./model/FraudMarkingActionRequest'), require('./model/GenerateCaptureContextRequest'), require('./model/GenerateUnifiedCheckoutCaptureContextRequest'), require('./model/GetAllPlansResponse'), require('./model/GetAllPlansResponseLinks'), require('./model/GetAllPlansResponseOrderInformation'), require('./model/GetAllPlansResponseOrderInformationAmountDetails'), require('./model/GetAllPlansResponsePlanInformation'), require('./model/GetAllPlansResponsePlanInformationBillingCycles'), require('./model/GetAllPlansResponsePlanInformationBillingPeriod'), require('./model/GetAllPlansResponsePlans'), require('./model/GetAllSubscriptionsResponse'), require('./model/GetAllSubscriptionsResponseLinks'), require('./model/GetAllSubscriptionsResponseOrderInformation'), require('./model/GetAllSubscriptionsResponseOrderInformationBillTo'), require('./model/GetAllSubscriptionsResponsePaymentInformation'), require('./model/GetAllSubscriptionsResponsePaymentInformationCustomer'), require('./model/GetAllSubscriptionsResponsePlanInformation'), require('./model/GetAllSubscriptionsResponsePlanInformationBillingCycles'), require('./model/GetAllSubscriptionsResponseSubscriptionInformation'), require('./model/GetAllSubscriptionsResponseSubscriptions'), require('./model/GetPlanCodeResponse'), require('./model/GetPlanResponse'), require('./model/GetSubscriptionCodeResponse'), require('./model/GetSubscriptionResponse'), require('./model/IncrementAuthRequest'), require('./model/InlineResponse200'), require('./model/InlineResponse2001'), require('./model/InlineResponse2001Keys'), require('./model/InlineResponse2002'), require('./model/InlineResponse2002IntegrationInformation'), require('./model/InlineResponse2002IntegrationInformationTenantConfigurations'), require('./model/InlineResponse2003'), require('./model/InlineResponse2004'), require('./model/InlineResponse2005'), require('./model/InlineResponse2006'), require('./model/InlineResponse2006Embedded'), require('./model/InlineResponse2006EmbeddedBatches'), require('./model/InlineResponse2006EmbeddedLinks'), require('./model/InlineResponse2006EmbeddedLinksReports'), require('./model/InlineResponse2006EmbeddedTotals'), require('./model/InlineResponse2006Links'), require('./model/InlineResponse2007'), require('./model/InlineResponse2007Billing'), require('./model/InlineResponse2007Links'), require('./model/InlineResponse2007LinksReport'), require('./model/InlineResponse2008'), require('./model/InlineResponse2008Records'), require('./model/InlineResponse2008ResponseRecord'), require('./model/InlineResponse2008ResponseRecordAdditionalUpdates'), require('./model/InlineResponse2008SourceRecord'), require('./model/InlineResponse200Embedded'), require('./model/InlineResponse200EmbeddedCapture'), require('./model/InlineResponse200EmbeddedCaptureLinks'), require('./model/InlineResponse200EmbeddedCaptureLinksSelf'), require('./model/InlineResponse200EmbeddedReversal'), require('./model/InlineResponse200EmbeddedReversalLinks'), require('./model/InlineResponse200EmbeddedReversalLinksSelf'), require('./model/InlineResponse201'), require('./model/InlineResponse2011'), require('./model/InlineResponse2011IntegrationInformation'), require('./model/InlineResponse2011IntegrationInformationTenantConfigurations'), require('./model/InlineResponse2011OrganizationInformation'), require('./model/InlineResponse2011ProductInformationSetups'), require('./model/InlineResponse2011RegistrationInformation'), require('./model/InlineResponse2011Setups'), require('./model/InlineResponse2011SetupsCommerceSolutions'), require('./model/InlineResponse2011SetupsPayments'), require('./model/InlineResponse2011SetupsPaymentsCardProcessing'), require('./model/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus'), require('./model/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus'), require('./model/InlineResponse2011SetupsPaymentsDigitalPayments'), require('./model/InlineResponse2011SetupsRisk'), require('./model/InlineResponse2011SetupsValueAddedServices'), require('./model/InlineResponse2012'), require('./model/InlineResponse2012KeyInformation'), require('./model/InlineResponse2012KeyInformationErrorInformation'), require('./model/InlineResponse2012KeyInformationErrorInformationDetails'), require('./model/InlineResponse2013'), require('./model/InlineResponse2014'), require('./model/InlineResponse202'), require('./model/InlineResponse202Links'), require('./model/InlineResponse202LinksStatus'), require('./model/InlineResponse400'), require('./model/InlineResponse4001'), require('./model/InlineResponse4002'), require('./model/InlineResponse4003'), require('./model/InlineResponse4004'), require('./model/InlineResponse4004Fields'), require('./model/InlineResponse4005'), require('./model/InlineResponse4006'), require('./model/InlineResponse4007'), require('./model/InlineResponse4007Details'), require('./model/InlineResponse4008'), require('./model/InlineResponse4008Details'), require('./model/InlineResponse400Details'), require('./model/InlineResponse400Errors'), require('./model/InlineResponse401'), require('./model/InlineResponse401Fields'), require('./model/InlineResponse401Links'), require('./model/InlineResponse401LinksSelf'), require('./model/InlineResponse403'), require('./model/InlineResponse4031'), require('./model/InlineResponse403Errors'), require('./model/InlineResponse404'), require('./model/InlineResponse4041'), require('./model/InlineResponse4042'), require('./model/InlineResponse4042Details'), require('./model/InlineResponse409'), require('./model/InlineResponse409Errors'), require('./model/InlineResponse410'), require('./model/InlineResponse410Errors'), require('./model/InlineResponse412'), require('./model/InlineResponse412Errors'), require('./model/InlineResponse422'), require('./model/InlineResponse4221'), require('./model/InlineResponse424'), require('./model/InlineResponse424Errors'), require('./model/InlineResponse500'), require('./model/InlineResponse5001'), require('./model/InlineResponse5002'), require('./model/InlineResponse5003'), require('./model/InlineResponse500Errors'), require('./model/InlineResponse502'), require('./model/InlineResponse5021'), require('./model/InlineResponse503'), require('./model/InlineResponseDefault'), require('./model/InlineResponseDefaultLinks'), require('./model/InlineResponseDefaultLinksNext'), require('./model/InlineResponseDefaultResponseStatus'), require('./model/InlineResponseDefaultResponseStatusDetails'), require('./model/IntimateBillingAgreement'), require('./model/InvoiceSettingsRequest'), require('./model/InvoicingV2InvoiceSettingsGet200Response'), require('./model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation'), require('./model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle'), require('./model/InvoicingV2InvoicesAllGet200Response'), require('./model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseInvoiceInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseInvoices'), require('./model/InvoicingV2InvoicesAllGet200ResponseLinks'), require('./model/InvoicingV2InvoicesAllGet200ResponseOrderInformation'), require('./model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails'), require('./model/InvoicingV2InvoicesAllGet400Response'), require('./model/InvoicingV2InvoicesAllGet404Response'), require('./model/InvoicingV2InvoicesAllGet502Response'), require('./model/InvoicingV2InvoicesGet200Response'), require('./model/InvoicingV2InvoicesGet200ResponseInvoiceHistory'), require('./model/InvoicingV2InvoicesGet200ResponseTransactionDetails'), require('./model/InvoicingV2InvoicesPost201Response'), require('./model/InvoicingV2InvoicesPost201ResponseInvoiceInformation'), require('./model/InvoicingV2InvoicesPost201ResponseOrderInformation'), require('./model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails'), require('./model/InvoicingV2InvoicesPost202Response'), require('./model/Invoicingv2invoiceSettingsInvoiceSettingsInformation'), require('./model/Invoicingv2invoicesCustomerInformation'), require('./model/Invoicingv2invoicesCustomerInformationCompany'), require('./model/Invoicingv2invoicesInvoiceInformation'), require('./model/Invoicingv2invoicesOrderInformation'), require('./model/Invoicingv2invoicesOrderInformationAmountDetails'), require('./model/Invoicingv2invoicesOrderInformationAmountDetailsFreight'), require('./model/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails'), require('./model/Invoicingv2invoicesOrderInformationLineItems'), require('./model/Invoicingv2invoicesidInvoiceInformation'), require('./model/KmsV2KeysAsymDeletesPost200Response'), require('./model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation'), require('./model/KmsV2KeysAsymGet200Response'), require('./model/KmsV2KeysAsymGet200ResponseKeyInformation'), require('./model/KmsV2KeysAsymPost201Response'), require('./model/KmsV2KeysAsymPost201ResponseCertificateInformation'), require('./model/KmsV2KeysAsymPost201ResponseKeyInformation'), require('./model/KmsV2KeysSymDeletesPost200Response'), require('./model/KmsV2KeysSymDeletesPost200ResponseKeyInformation'), require('./model/KmsV2KeysSymGet200Response'), require('./model/KmsV2KeysSymGet200ResponseKeyInformation'), require('./model/KmsV2KeysSymPost201Response'), require('./model/KmsV2KeysSymPost201ResponseErrorInformation'), require('./model/KmsV2KeysSymPost201ResponseKeyInformation'), require('./model/Kmsegressv2keysasymClientReferenceInformation'), require('./model/Kmsegressv2keysasymKeyInformation'), require('./model/Kmsegressv2keyssymClientReferenceInformation'), require('./model/Kmsegressv2keyssymKeyInformation'), require('./model/Kmsv2keysasymKeyInformation'), require('./model/Kmsv2keyssymClientReferenceInformation'), require('./model/Kmsv2keyssymKeyInformation'), require('./model/Kmsv2keyssymdeletesKeyInformation'), require('./model/Kmsv2keyssymverifiKeyInformation'), require('./model/MerchantInitiatedTransactionObject'), require('./model/Microformv2sessionsCheckoutApiInitialization'), require('./model/MitReversalRequest'), require('./model/MitVoidRequest'), require('./model/ModifyBillingAgreement'), require('./model/Notificationsubscriptionsv1productsorganizationIdEventTypes'), require('./model/Notificationsubscriptionsv1webhooksNotificationScope'), require('./model/Notificationsubscriptionsv1webhooksProducts'), require('./model/Notificationsubscriptionsv1webhooksRetryPolicy'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1Config'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig'), require('./model/Notificationsubscriptionsv1webhooksSecurityPolicyConfig'), require('./model/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus'), require('./model/OctCreatePaymentRequest'), require('./model/OrderPaymentRequest'), require('./model/PatchCustomerPaymentInstrumentRequest'), require('./model/PatchCustomerRequest'), require('./model/PatchCustomerShippingAddressRequest'), require('./model/PatchInstrumentIdentifierRequest'), require('./model/PatchPaymentInstrumentRequest'), require('./model/PayerAuthConfig'), require('./model/PayerAuthConfigCardTypes'), require('./model/PayerAuthConfigCardTypesCB'), require('./model/PayerAuthConfigCardTypesJCBJSecure'), require('./model/PayerAuthConfigCardTypesVerifiedByVisa'), require('./model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies'), require('./model/PayerAuthSetupRequest'), require('./model/PaymentInstrumentList'), require('./model/PaymentInstrumentList1'), require('./model/PaymentInstrumentList1Embedded'), require('./model/PaymentInstrumentList1EmbeddedEmbedded'), require('./model/PaymentInstrumentList1EmbeddedPaymentInstruments'), require('./model/PaymentInstrumentListEmbedded'), require('./model/PaymentInstrumentListLinks'), require('./model/PaymentInstrumentListLinksFirst'), require('./model/PaymentInstrumentListLinksLast'), require('./model/PaymentInstrumentListLinksNext'), require('./model/PaymentInstrumentListLinksPrev'), require('./model/PaymentInstrumentListLinksSelf'), require('./model/PaymentsProducts'), require('./model/PaymentsProductsCardPresentConnect'), require('./model/PaymentsProductsCardPresentConnectConfigurationInformation'), require('./model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations'), require('./model/PaymentsProductsCardPresentConnectSubscriptionInformation'), require('./model/PaymentsProductsCardProcessing'), require('./model/PaymentsProductsCardProcessingConfigurationInformation'), require('./model/PaymentsProductsCardProcessingSubscriptionInformation'), require('./model/PaymentsProductsCardProcessingSubscriptionInformationFeatures'), require('./model/PaymentsProductsCurrencyConversion'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformation'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurations'), require('./model/PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors'), require('./model/PaymentsProductsCybsReadyTerminal'), require('./model/PaymentsProductsDifferentialFee'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformation'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformationFeatures'), require('./model/PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge'), require('./model/PaymentsProductsDigitalPayments'), require('./model/PaymentsProductsDigitalPaymentsSubscriptionInformation'), require('./model/PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures'), require('./model/PaymentsProductsECheck'), require('./model/PaymentsProductsECheckConfigurationInformation'), require('./model/PaymentsProductsECheckSubscriptionInformation'), require('./model/PaymentsProductsPayerAuthentication'), require('./model/PaymentsProductsPayerAuthenticationConfigurationInformation'), require('./model/PaymentsProductsPayerAuthenticationSubscriptionInformation'), require('./model/PaymentsProductsPayouts'), require('./model/PaymentsProductsPayoutsConfigurationInformation'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurations'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds'), require('./model/PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds'), require('./model/PaymentsProductsSecureAcceptance'), require('./model/PaymentsProductsSecureAcceptanceConfigurationInformation'), require('./model/PaymentsProductsTax'), require('./model/PaymentsProductsVirtualTerminal'), require('./model/PaymentsProductsVirtualTerminalConfigurationInformation'), require('./model/PaymentsStrongAuthIssuerInformation'), require('./model/PostCustomerPaymentInstrumentRequest'), require('./model/PostCustomerRequest'), require('./model/PostCustomerShippingAddressRequest'), require('./model/PostInstrumentIdentifierEnrollmentRequest'), require('./model/PostInstrumentIdentifierRequest'), require('./model/PostPaymentCredentialsRequest'), require('./model/PostPaymentInstrumentRequest'), require('./model/PostRegistrationBody'), require('./model/PredefinedSubscriptionRequestBean'), require('./model/PtsV1TransactionBatchesGet200Response'), require('./model/PtsV1TransactionBatchesGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesGet200ResponseLinksSelf'), require('./model/PtsV1TransactionBatchesGet200ResponseTransactionBatches'), require('./model/PtsV1TransactionBatchesGet400Response'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails'), require('./model/PtsV1TransactionBatchesGet500Response'), require('./model/PtsV1TransactionBatchesGet500ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesIdGet200Response'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions'), require('./model/PtsV2CreateBillingAgreementPost201Response'), require('./model/PtsV2CreateBillingAgreementPost201ResponseAgreementInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseLinks'), require('./model/PtsV2CreateBillingAgreementPost201ResponseProcessorInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseRiskInformation'), require('./model/PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults'), require('./model/PtsV2CreateBillingAgreementPost400Response'), require('./model/PtsV2CreateBillingAgreementPost502Response'), require('./model/PtsV2CreditsPost201Response'), require('./model/PtsV2CreditsPost201Response1'), require('./model/PtsV2CreditsPost201Response1ProcessorInformation'), require('./model/PtsV2CreditsPost201ResponseCreditAmountDetails'), require('./model/PtsV2CreditsPost201ResponsePaymentInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2IncrementalAuthorizationPatch201Response'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseLinks'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures'), require('./model/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation'), require('./model/PtsV2IncrementalAuthorizationPatch400Response'), require('./model/PtsV2ModifyBillingAgreementPost201Response'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseLinks'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo'), require('./model/PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank'), require('./model/PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsCapturesPost201Response'), require('./model/PtsV2PaymentsCapturesPost201ResponseLinks'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsCapturesPost400Response'), require('./model/PtsV2PaymentsOrderPost201Response'), require('./model/PtsV2PaymentsOrderPost201ResponseBuyerInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo'), require('./model/PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails'), require('./model/PtsV2PaymentsOrderPost201ResponsePaymentInformation'), require('./model/PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection'), require('./model/PtsV2PaymentsPost201Response'), require('./model/PtsV2PaymentsPost201Response1'), require('./model/PtsV2PaymentsPost201Response1OrderInformation'), require('./model/PtsV2PaymentsPost201Response1OrderInformationBillTo'), require('./model/PtsV2PaymentsPost201Response1OrderInformationShipTo'), require('./model/PtsV2PaymentsPost201Response1PaymentInformation'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationBank'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationBankAccount'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationPaymentType'), require('./model/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod'), require('./model/PtsV2PaymentsPost201Response1ProcessorInformation'), require('./model/PtsV2PaymentsPost201Response1ProcessorInformationAvs'), require('./model/PtsV2PaymentsPost201Response2'), require('./model/PtsV2PaymentsPost201Response2OrderInformation'), require('./model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails'), require('./model/PtsV2PaymentsPost201Response2PaymentInformation'), require('./model/PtsV2PaymentsPost201Response2PaymentInformationEWallet'), require('./model/PtsV2PaymentsPost201Response2ProcessorInformation'), require('./model/PtsV2PaymentsPost201ResponseBuyerInformation'), require('./model/PtsV2PaymentsPost201ResponseClientReferenceInformation'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr'), require('./model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActions'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION'), require('./model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING'), require('./model/PtsV2PaymentsPost201ResponseErrorInformation'), require('./model/PtsV2PaymentsPost201ResponseErrorInformationDetails'), require('./model/PtsV2PaymentsPost201ResponseInstallmentInformation'), require('./model/PtsV2PaymentsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsPost201ResponseLinks'), require('./model/PtsV2PaymentsPost201ResponseLinksSelf'), require('./model/PtsV2PaymentsPost201ResponseMerchantInformation'), require('./model/PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor'), require('./model/PtsV2PaymentsPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationBillTo'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationShipTo'), require('./model/PtsV2PaymentsPost201ResponsePaymentAccountInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBank'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationEWallet'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard'), require('./model/PtsV2PaymentsPost201ResponsePaymentInsightsInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformation'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAvs'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationRouting'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection'), require('./model/PtsV2PaymentsPost201ResponseRiskInformation'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationInfoCodes'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationIpAddress'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationProcessorResults'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationProfile'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationRules'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationScore'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravel'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationVelocity'), require('./model/PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing'), require('./model/PtsV2PaymentsPost201ResponseTokenInformation'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationCustomer'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument'), require('./model/PtsV2PaymentsPost201ResponseTokenInformationShippingAddress'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformation'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList'), require('./model/PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches'), require('./model/PtsV2PaymentsPost400Response'), require('./model/PtsV2PaymentsPost502Response'), require('./model/PtsV2PaymentsRefundPost201Response'), require('./model/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseLinks'), require('./model/PtsV2PaymentsRefundPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsRefundPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails'), require('./model/PtsV2PaymentsRefundPost400Response'), require('./model/PtsV2PaymentsReversalsPost201Response'), require('./model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails'), require('./model/PtsV2PaymentsReversalsPost400Response'), require('./model/PtsV2PaymentsVoidsPost201Response'), require('./model/PtsV2PaymentsVoidsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails'), require('./model/PtsV2PaymentsVoidsPost400Response'), require('./model/PtsV2PayoutsPost201Response'), require('./model/PtsV2PayoutsPost201ResponseErrorInformation'), require('./model/PtsV2PayoutsPost201ResponseIssuerInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor'), require('./model/PtsV2PayoutsPost201ResponseOrderInformation'), require('./model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PayoutsPost201ResponseProcessorInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformationCard'), require('./model/PtsV2PayoutsPost400Response'), require('./model/Ptsv1pushfundstransferClientReferenceInformation'), require('./model/Ptsv1pushfundstransferOrderInformation'), require('./model/Ptsv1pushfundstransferOrderInformationAmountDetails'), require('./model/Ptsv1pushfundstransferProcessingInformation'), require('./model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions'), require('./model/Ptsv1pushfundstransferRecipientInformation'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformation'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier'), require('./model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument'), require('./model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification'), require('./model/Ptsv1pushfundstransferSenderInformation'), require('./model/Ptsv1pushfundstransferSenderInformationAccount'), require('./model/Ptsv1pushfundstransferSenderInformationPaymentInformation'), require('./model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard'), require('./model/Ptsv1pushfundstransferSenderInformationPersonalIdentification'), require('./model/Ptsv2billingagreementsAggregatorInformation'), require('./model/Ptsv2billingagreementsAgreementInformation'), require('./model/Ptsv2billingagreementsBuyerInformation'), require('./model/Ptsv2billingagreementsClientReferenceInformation'), require('./model/Ptsv2billingagreementsConsumerAuthenticationInformation'), require('./model/Ptsv2billingagreementsDeviceInformation'), require('./model/Ptsv2billingagreementsInstallmentInformation'), require('./model/Ptsv2billingagreementsMerchantInformation'), require('./model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2billingagreementsOrderInformation'), require('./model/Ptsv2billingagreementsOrderInformationBillTo'), require('./model/Ptsv2billingagreementsPaymentInformation'), require('./model/Ptsv2billingagreementsPaymentInformationBank'), require('./model/Ptsv2billingagreementsPaymentInformationBankAccount'), require('./model/Ptsv2billingagreementsPaymentInformationCard'), require('./model/Ptsv2billingagreementsPaymentInformationPaymentType'), require('./model/Ptsv2billingagreementsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2billingagreementsPaymentInformationTokenizedCard'), require('./model/Ptsv2billingagreementsProcessingInformation'), require('./model/Ptsv2billingagreementsidAgreementInformation'), require('./model/Ptsv2billingagreementsidBuyerInformation'), require('./model/Ptsv2billingagreementsidProcessingInformation'), require('./model/Ptsv2creditsInstallmentInformation'), require('./model/Ptsv2creditsProcessingInformation'), require('./model/Ptsv2creditsProcessingInformationBankTransferOptions'), require('./model/Ptsv2creditsProcessingInformationElectronicBenefitsTransfer'), require('./model/Ptsv2creditsProcessingInformationJapanPaymentOptions'), require('./model/Ptsv2creditsProcessingInformationPurchaseOptions'), require('./model/Ptsv2creditsProcessingInformationRefundOptions'), require('./model/Ptsv2creditsRecipientInformation'), require('./model/Ptsv2creditsSenderInformation'), require('./model/Ptsv2creditsSenderInformationAccount'), require('./model/Ptsv2paymentreferencesAgreementInformation'), require('./model/Ptsv2paymentreferencesBuyerInformation'), require('./model/Ptsv2paymentreferencesDeviceInformation'), require('./model/Ptsv2paymentreferencesMerchantInformation'), require('./model/Ptsv2paymentreferencesOrderInformation'), require('./model/Ptsv2paymentreferencesOrderInformationAmountDetails'), require('./model/Ptsv2paymentreferencesOrderInformationBillTo'), require('./model/Ptsv2paymentreferencesOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentreferencesOrderInformationLineItems'), require('./model/Ptsv2paymentreferencesOrderInformationShipTo'), require('./model/Ptsv2paymentreferencesPaymentInformation'), require('./model/Ptsv2paymentreferencesPaymentInformationBank'), require('./model/Ptsv2paymentreferencesPaymentInformationBankAccount'), require('./model/Ptsv2paymentreferencesPaymentInformationCard'), require('./model/Ptsv2paymentreferencesPaymentInformationEWallet'), require('./model/Ptsv2paymentreferencesPaymentInformationOptions'), require('./model/Ptsv2paymentreferencesProcessingInformation'), require('./model/Ptsv2paymentreferencesTravelInformation'), require('./model/Ptsv2paymentreferencesTravelInformationAutoRental'), require('./model/Ptsv2paymentreferencesUserInterface'), require('./model/Ptsv2paymentreferencesUserInterfaceColor'), require('./model/Ptsv2paymentreferencesidintentsOrderInformation'), require('./model/Ptsv2paymentreferencesidintentsPaymentInformation'), require('./model/Ptsv2paymentreferencesidintentsPaymentInformationEWallet'), require('./model/Ptsv2paymentreferencesidintentsProcessingInformation'), require('./model/Ptsv2paymentsAcquirerInformation'), require('./model/Ptsv2paymentsAggregatorInformation'), require('./model/Ptsv2paymentsAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsAgreementInformation'), require('./model/Ptsv2paymentsBuyerInformation'), require('./model/Ptsv2paymentsBuyerInformationPersonalIdentification'), require('./model/Ptsv2paymentsClientReferenceInformation'), require('./model/Ptsv2paymentsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsConsumerAuthenticationInformation'), require('./model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication'), require('./model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation'), require('./model/Ptsv2paymentsDeviceInformation'), require('./model/Ptsv2paymentsDeviceInformationRawData'), require('./model/Ptsv2paymentsHealthCareInformation'), require('./model/Ptsv2paymentsHealthCareInformationAmountDetails'), require('./model/Ptsv2paymentsHostedPaymentInformation'), require('./model/Ptsv2paymentsHostedPaymentInformationUserAgent'), require('./model/Ptsv2paymentsInstallmentInformation'), require('./model/Ptsv2paymentsInvoiceDetails'), require('./model/Ptsv2paymentsIssuerInformation'), require('./model/Ptsv2paymentsMerchantDefinedInformation'), require('./model/Ptsv2paymentsMerchantDefinedSecureInformation'), require('./model/Ptsv2paymentsMerchantInformation'), require('./model/Ptsv2paymentsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor'), require('./model/Ptsv2paymentsMerchantInformationServiceLocation'), require('./model/Ptsv2paymentsOrderInformation'), require('./model/Ptsv2paymentsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsOrder'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails'), require('./model/Ptsv2paymentsOrderInformationBillTo'), require('./model/Ptsv2paymentsOrderInformationBillToCompany'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum'), require('./model/Ptsv2paymentsOrderInformationLineItems'), require('./model/Ptsv2paymentsOrderInformationPassenger'), require('./model/Ptsv2paymentsOrderInformationShipTo'), require('./model/Ptsv2paymentsOrderInformationShippingDetails'), require('./model/Ptsv2paymentsPaymentInformation'), require('./model/Ptsv2paymentsPaymentInformationBank'), require('./model/Ptsv2paymentsPaymentInformationBankAccount'), require('./model/Ptsv2paymentsPaymentInformationCard'), require('./model/Ptsv2paymentsPaymentInformationCustomer'), require('./model/Ptsv2paymentsPaymentInformationDirectDebit'), require('./model/Ptsv2paymentsPaymentInformationDirectDebitMandate'), require('./model/Ptsv2paymentsPaymentInformationEWallet'), require('./model/Ptsv2paymentsPaymentInformationFluidData'), require('./model/Ptsv2paymentsPaymentInformationInstrumentIdentifier'), require('./model/Ptsv2paymentsPaymentInformationLegacyToken'), require('./model/Ptsv2paymentsPaymentInformationOptions'), require('./model/Ptsv2paymentsPaymentInformationPaymentInstrument'), require('./model/Ptsv2paymentsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsPaymentInformationSepa'), require('./model/Ptsv2paymentsPaymentInformationSepaDirectDebit'), require('./model/Ptsv2paymentsPaymentInformationShippingAddress'), require('./model/Ptsv2paymentsPaymentInformationTokenizedCard'), require('./model/Ptsv2paymentsPointOfSaleInformation'), require('./model/Ptsv2paymentsPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsProcessingInformation'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/Ptsv2paymentsProcessingInformationBankTransferOptions'), require('./model/Ptsv2paymentsProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer'), require('./model/Ptsv2paymentsProcessingInformationJapanPaymentOptions'), require('./model/Ptsv2paymentsProcessingInformationLoanOptions'), require('./model/Ptsv2paymentsProcessingInformationPurchaseOptions'), require('./model/Ptsv2paymentsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsProcessorInformation'), require('./model/Ptsv2paymentsProcessorInformationAuthorizationOptions'), require('./model/Ptsv2paymentsProcessorInformationReversal'), require('./model/Ptsv2paymentsPromotionInformation'), require('./model/Ptsv2paymentsRecipientInformation'), require('./model/Ptsv2paymentsRecurringPaymentInformation'), require('./model/Ptsv2paymentsRiskInformation'), require('./model/Ptsv2paymentsRiskInformationAuxiliaryData'), require('./model/Ptsv2paymentsRiskInformationBuyerHistory'), require('./model/Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory'), require('./model/Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount'), require('./model/Ptsv2paymentsRiskInformationProfile'), require('./model/Ptsv2paymentsTokenInformation'), require('./model/Ptsv2paymentsTokenInformationPaymentInstrument'), require('./model/Ptsv2paymentsTokenInformationShippingAddress'), require('./model/Ptsv2paymentsTokenInformationTokenProvisioningInformation'), require('./model/Ptsv2paymentsTravelInformation'), require('./model/Ptsv2paymentsTravelInformationAgency'), require('./model/Ptsv2paymentsTravelInformationAutoRental'), require('./model/Ptsv2paymentsTravelInformationAutoRentalRentalAddress'), require('./model/Ptsv2paymentsTravelInformationAutoRentalReturnAddress'), require('./model/Ptsv2paymentsTravelInformationAutoRentalTaxDetails'), require('./model/Ptsv2paymentsTravelInformationLodging'), require('./model/Ptsv2paymentsTravelInformationLodgingRoom'), require('./model/Ptsv2paymentsTravelInformationTransit'), require('./model/Ptsv2paymentsTravelInformationTransitAirline'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineLegs'), require('./model/Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer'), require('./model/Ptsv2paymentsTravelInformationVehicleData'), require('./model/Ptsv2paymentsWatchlistScreeningInformation'), require('./model/Ptsv2paymentsWatchlistScreeningInformationWeights'), require('./model/Ptsv2paymentsidClientReferenceInformation'), require('./model/Ptsv2paymentsidClientReferenceInformationPartner'), require('./model/Ptsv2paymentsidMerchantInformation'), require('./model/Ptsv2paymentsidOrderInformation'), require('./model/Ptsv2paymentsidOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidProcessingInformation'), require('./model/Ptsv2paymentsidProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator'), require('./model/Ptsv2paymentsidTravelInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsidcapturesBuyerInformation'), require('./model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification'), require('./model/Ptsv2paymentsidcapturesDeviceInformation'), require('./model/Ptsv2paymentsidcapturesInstallmentInformation'), require('./model/Ptsv2paymentsidcapturesMerchantInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationBillTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationShipTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationShippingDetails'), require('./model/Ptsv2paymentsidcapturesPaymentInformation'), require('./model/Ptsv2paymentsidcapturesPaymentInformationCard'), require('./model/Ptsv2paymentsidcapturesPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformation'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsidcapturesProcessingInformation'), require('./model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsidrefundsClientReferenceInformation'), require('./model/Ptsv2paymentsidrefundsMerchantInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformationLineItems'), require('./model/Ptsv2paymentsidrefundsPaymentInformation'), require('./model/Ptsv2paymentsidrefundsPaymentInformationBank'), require('./model/Ptsv2paymentsidrefundsPaymentInformationBankAccount'), require('./model/Ptsv2paymentsidrefundsPaymentInformationCard'), require('./model/Ptsv2paymentsidrefundsPaymentInformationEWallet'), require('./model/Ptsv2paymentsidrefundsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidrefundsPointOfSaleInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsidrefundsProcessingInformationRefundOptions'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformation'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsidreversalsOrderInformation'), require('./model/Ptsv2paymentsidreversalsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidreversalsOrderInformationLineItems'), require('./model/Ptsv2paymentsidreversalsPaymentInformation'), require('./model/Ptsv2paymentsidreversalsPaymentInformationPaymentType'), require('./model/Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod'), require('./model/Ptsv2paymentsidreversalsPointOfSaleInformation'), require('./model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsidreversalsProcessingInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformationAmountDetails'), require('./model/Ptsv2paymentsidvoidsAgreementInformation'), require('./model/Ptsv2paymentsidvoidsMerchantInformation'), require('./model/Ptsv2paymentsidvoidsOrderInformation'), require('./model/Ptsv2paymentsidvoidsPaymentInformation'), require('./model/Ptsv2paymentsidvoidsProcessingInformation'), require('./model/Ptsv2payoutsClientReferenceInformation'), require('./model/Ptsv2payoutsMerchantInformation'), require('./model/Ptsv2payoutsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2payoutsOrderInformation'), require('./model/Ptsv2payoutsOrderInformationAmountDetails'), require('./model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2payoutsOrderInformationBillTo'), require('./model/Ptsv2payoutsPaymentInformation'), require('./model/Ptsv2payoutsPaymentInformationCard'), require('./model/Ptsv2payoutsProcessingInformation'), require('./model/Ptsv2payoutsProcessingInformationFundingOptions'), require('./model/Ptsv2payoutsProcessingInformationFundingOptionsInitiator'), require('./model/Ptsv2payoutsProcessingInformationPayoutsOptions'), require('./model/Ptsv2payoutsRecipientInformation'), require('./model/Ptsv2payoutsSenderInformation'), require('./model/Ptsv2payoutsSenderInformationAccount'), require('./model/Ptsv2refreshpaymentstatusidAgreementInformation'), require('./model/Ptsv2refreshpaymentstatusidClientReferenceInformation'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformation'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer'), require('./model/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType'), require('./model/Ptsv2refreshpaymentstatusidProcessingInformation'), require('./model/Ptsv2voidsProcessingInformation'), require('./model/PushFunds201Response'), require('./model/PushFunds201ResponseClientReferenceInformation'), require('./model/PushFunds201ResponseErrorInformation'), require('./model/PushFunds201ResponseErrorInformationDetails'), require('./model/PushFunds201ResponseLinks'), require('./model/PushFunds201ResponseLinksCustomer'), require('./model/PushFunds201ResponseLinksInstrumentIdentifier'), require('./model/PushFunds201ResponseLinksPaymentInstrument'), require('./model/PushFunds201ResponseLinksSelf'), require('./model/PushFunds201ResponseMerchantInformation'), require('./model/PushFunds201ResponseMerchantInformationMerchantDescriptor'), require('./model/PushFunds201ResponseOrderInformation'), require('./model/PushFunds201ResponseOrderInformationAmountDetails'), require('./model/PushFunds201ResponseProcessorInformation'), require('./model/PushFunds201ResponseRecipientInformation'), require('./model/PushFunds201ResponseRecipientInformationCard'), require('./model/PushFunds400Response'), require('./model/PushFunds400ResponseDetails'), require('./model/PushFunds401Response'), require('./model/PushFunds404Response'), require('./model/PushFunds502Response'), require('./model/PushFundsRequest'), require('./model/Rbsv1plansClientReferenceInformation'), require('./model/Rbsv1plansOrderInformation'), require('./model/Rbsv1plansOrderInformationAmountDetails'), require('./model/Rbsv1plansPlanInformation'), require('./model/Rbsv1plansPlanInformationBillingCycles'), require('./model/Rbsv1plansidPlanInformation'), require('./model/Rbsv1plansidProcessingInformation'), require('./model/Rbsv1plansidProcessingInformationSubscriptionBillingOptions'), require('./model/Rbsv1subscriptionsClientReferenceInformation'), require('./model/Rbsv1subscriptionsPaymentInformation'), require('./model/Rbsv1subscriptionsPaymentInformationCustomer'), require('./model/Rbsv1subscriptionsPlanInformation'), require('./model/Rbsv1subscriptionsProcessingInformation'), require('./model/Rbsv1subscriptionsProcessingInformationAuthorizationOptions'), require('./model/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator'), require('./model/Rbsv1subscriptionsSubscriptionInformation'), require('./model/Rbsv1subscriptionsidOrderInformation'), require('./model/Rbsv1subscriptionsidOrderInformationAmountDetails'), require('./model/Rbsv1subscriptionsidPlanInformation'), require('./model/Rbsv1subscriptionsidSubscriptionInformation'), require('./model/RefreshPaymentStatusRequest'), require('./model/RefundCaptureRequest'), require('./model/RefundPaymentRequest'), require('./model/ReplayWebhooksRequest'), require('./model/ReportingV3ChargebackDetailsGet200Response'), require('./model/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails'), require('./model/ReportingV3ChargebackSummariesGet200Response'), require('./model/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries'), require('./model/ReportingV3ConversionDetailsGet200Response'), require('./model/ReportingV3ConversionDetailsGet200ResponseConversionDetails'), require('./model/ReportingV3ConversionDetailsGet200ResponseNotes'), require('./model/ReportingV3InterchangeClearingLevelDetailsGet200Response'), require('./model/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails'), require('./model/ReportingV3NetFundingsGet200Response'), require('./model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries'), require('./model/ReportingV3NetFundingsGet200ResponseTotalPurchases'), require('./model/ReportingV3NotificationofChangesGet200Response'), require('./model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges'), require('./model/ReportingV3PaymentBatchSummariesGet200Response'), require('./model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries'), require('./model/ReportingV3PurchaseRefundDetailsGet200Response'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements'), require('./model/ReportingV3ReportDefinitionsGet200Response'), require('./model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions'), require('./model/ReportingV3ReportDefinitionsNameGet200Response'), require('./model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes'), require('./model/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings'), require('./model/ReportingV3ReportSubscriptionsGet200Response'), require('./model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions'), require('./model/ReportingV3ReportsGet200Response'), require('./model/ReportingV3ReportsGet200ResponseLink'), require('./model/ReportingV3ReportsGet200ResponseLinkReportDownload'), require('./model/ReportingV3ReportsGet200ResponseReportSearchResults'), require('./model/ReportingV3ReportsIdGet200Response'), require('./model/ReportingV3RetrievalDetailsGet200Response'), require('./model/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails'), require('./model/ReportingV3RetrievalSummariesGet200Response'), require('./model/Reportingv3ReportDownloadsGet400Response'), require('./model/Reportingv3ReportDownloadsGet400ResponseDetails'), require('./model/Reportingv3reportsReportFilters'), require('./model/Reportingv3reportsReportPreferences'), require('./model/RiskProducts'), require('./model/RiskProductsDecisionManager'), require('./model/RiskProductsDecisionManagerConfigurationInformation'), require('./model/RiskProductsFraudManagementEssentials'), require('./model/RiskProductsFraudManagementEssentialsConfigurationInformation'), require('./model/RiskV1AddressVerificationsPost201Response'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress'), require('./model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1'), require('./model/RiskV1AddressVerificationsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationResultsPost201Response'), require('./model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationSetupsPost201Response'), require('./model/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationSetupsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationsPost201Response'), require('./model/RiskV1AuthenticationsPost201ResponseErrorInformation'), require('./model/RiskV1AuthenticationsPost400Response'), require('./model/RiskV1AuthenticationsPost400Response1'), require('./model/RiskV1DecisionsPost201Response'), require('./model/RiskV1DecisionsPost201ResponseClientReferenceInformation'), require('./model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1DecisionsPost201ResponseErrorInformation'), require('./model/RiskV1DecisionsPost201ResponseOrderInformation'), require('./model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails'), require('./model/RiskV1DecisionsPost201ResponsePaymentInformation'), require('./model/RiskV1DecisionsPost400Response'), require('./model/RiskV1DecisionsPost400Response1'), require('./model/RiskV1ExportComplianceInquiriesPost201Response'), require('./model/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation'), require('./model/RiskV1UpdatePost201Response'), require('./model/Riskv1addressverificationsBuyerInformation'), require('./model/Riskv1addressverificationsOrderInformation'), require('./model/Riskv1addressverificationsOrderInformationBillTo'), require('./model/Riskv1addressverificationsOrderInformationLineItems'), require('./model/Riskv1addressverificationsOrderInformationShipTo'), require('./model/Riskv1authenticationresultsConsumerAuthenticationInformation'), require('./model/Riskv1authenticationresultsDeviceInformation'), require('./model/Riskv1authenticationresultsOrderInformation'), require('./model/Riskv1authenticationresultsOrderInformationAmountDetails'), require('./model/Riskv1authenticationresultsPaymentInformation'), require('./model/Riskv1authenticationresultsPaymentInformationCard'), require('./model/Riskv1authenticationresultsPaymentInformationFluidData'), require('./model/Riskv1authenticationresultsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsBuyerInformation'), require('./model/Riskv1authenticationsDeviceInformation'), require('./model/Riskv1authenticationsOrderInformation'), require('./model/Riskv1authenticationsOrderInformationAmountDetails'), require('./model/Riskv1authenticationsOrderInformationBillTo'), require('./model/Riskv1authenticationsOrderInformationLineItems'), require('./model/Riskv1authenticationsPaymentInformation'), require('./model/Riskv1authenticationsPaymentInformationCard'), require('./model/Riskv1authenticationsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsRiskInformation'), require('./model/Riskv1authenticationsTravelInformation'), require('./model/Riskv1authenticationsetupsPaymentInformation'), require('./model/Riskv1authenticationsetupsPaymentInformationCard'), require('./model/Riskv1authenticationsetupsPaymentInformationCustomer'), require('./model/Riskv1authenticationsetupsPaymentInformationFluidData'), require('./model/Riskv1authenticationsetupsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsetupsProcessingInformation'), require('./model/Riskv1authenticationsetupsTokenInformation'), require('./model/Riskv1decisionsAcquirerInformation'), require('./model/Riskv1decisionsBuyerInformation'), require('./model/Riskv1decisionsClientReferenceInformation'), require('./model/Riskv1decisionsClientReferenceInformationPartner'), require('./model/Riskv1decisionsConsumerAuthenticationInformation'), require('./model/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication'), require('./model/Riskv1decisionsDeviceInformation'), require('./model/Riskv1decisionsMerchantDefinedInformation'), require('./model/Riskv1decisionsMerchantInformation'), require('./model/Riskv1decisionsMerchantInformationMerchantDescriptor'), require('./model/Riskv1decisionsOrderInformation'), require('./model/Riskv1decisionsOrderInformationAmountDetails'), require('./model/Riskv1decisionsOrderInformationBillTo'), require('./model/Riskv1decisionsOrderInformationLineItems'), require('./model/Riskv1decisionsOrderInformationShipTo'), require('./model/Riskv1decisionsOrderInformationShippingDetails'), require('./model/Riskv1decisionsPaymentInformation'), require('./model/Riskv1decisionsPaymentInformationCard'), require('./model/Riskv1decisionsPaymentInformationTokenizedCard'), require('./model/Riskv1decisionsProcessingInformation'), require('./model/Riskv1decisionsProcessorInformation'), require('./model/Riskv1decisionsProcessorInformationAvs'), require('./model/Riskv1decisionsProcessorInformationCardVerification'), require('./model/Riskv1decisionsRiskInformation'), require('./model/Riskv1decisionsTokenInformation'), require('./model/Riskv1decisionsTravelInformation'), require('./model/Riskv1decisionsTravelInformationLegs'), require('./model/Riskv1decisionsTravelInformationPassengers'), require('./model/Riskv1decisionsidactionsDecisionInformation'), require('./model/Riskv1decisionsidactionsProcessingInformation'), require('./model/Riskv1decisionsidmarkingRiskInformation'), require('./model/Riskv1decisionsidmarkingRiskInformationMarkingDetails'), require('./model/Riskv1exportcomplianceinquiriesDeviceInformation'), require('./model/Riskv1exportcomplianceinquiriesExportComplianceInformation'), require('./model/Riskv1exportcomplianceinquiriesOrderInformation'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationBillTo'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationLineItems'), require('./model/Riskv1exportcomplianceinquiriesOrderInformationShipTo'), require('./model/Riskv1liststypeentriesBuyerInformation'), require('./model/Riskv1liststypeentriesClientReferenceInformation'), require('./model/Riskv1liststypeentriesDeviceInformation'), require('./model/Riskv1liststypeentriesOrderInformation'), require('./model/Riskv1liststypeentriesOrderInformationAddress'), require('./model/Riskv1liststypeentriesOrderInformationBillTo'), require('./model/Riskv1liststypeentriesOrderInformationLineItems'), require('./model/Riskv1liststypeentriesOrderInformationShipTo'), require('./model/Riskv1liststypeentriesPaymentInformation'), require('./model/Riskv1liststypeentriesPaymentInformationBank'), require('./model/Riskv1liststypeentriesPaymentInformationCard'), require('./model/Riskv1liststypeentriesRiskInformation'), require('./model/Riskv1liststypeentriesRiskInformationMarkingDetails'), require('./model/SAConfig'), require('./model/SAConfigCheckout'), require('./model/SAConfigContactInformation'), require('./model/SAConfigNotifications'), require('./model/SAConfigNotificationsCustomerNotifications'), require('./model/SAConfigNotificationsMerchantNotifications'), require('./model/SAConfigPaymentMethods'), require('./model/SAConfigPaymentTypes'), require('./model/SAConfigPaymentTypesCardTypes'), require('./model/SAConfigPaymentTypesCardTypesDiscover'), require('./model/SAConfigService'), require('./model/SaveAsymEgressKey'), require('./model/SaveSymEgressKey'), require('./model/SearchRequest'), require('./model/ShippingAddressListForCustomer'), require('./model/ShippingAddressListForCustomerEmbedded'), require('./model/ShippingAddressListForCustomerLinks'), require('./model/ShippingAddressListForCustomerLinksFirst'), require('./model/ShippingAddressListForCustomerLinksLast'), require('./model/ShippingAddressListForCustomerLinksNext'), require('./model/ShippingAddressListForCustomerLinksPrev'), require('./model/ShippingAddressListForCustomerLinksSelf'), require('./model/SuspendSubscriptionResponse'), require('./model/SuspendSubscriptionResponseSubscriptionInformation'), require('./model/TaxRequest'), require('./model/TmsAuthorizationOptions'), require('./model/TmsAuthorizationOptionsInitiator'), require('./model/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/TmsEmbeddedInstrumentIdentifier'), require('./model/TmsEmbeddedInstrumentIdentifierBankAccount'), require('./model/TmsEmbeddedInstrumentIdentifierBillTo'), require('./model/TmsEmbeddedInstrumentIdentifierCard'), require('./model/TmsEmbeddedInstrumentIdentifierIssuer'), require('./model/TmsEmbeddedInstrumentIdentifierLinks'), require('./model/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments'), require('./model/TmsEmbeddedInstrumentIdentifierLinksSelf'), require('./model/TmsEmbeddedInstrumentIdentifierMetadata'), require('./model/TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./model/TmsEmbeddedInstrumentIdentifierTokenizedCard'), require('./model/TmsEmbeddedInstrumentIdentifierTokenizedCardCard'), require('./model/TmsPaymentInstrumentProcessingInfo'), require('./model/TmsPaymentInstrumentProcessingInfoBankTransferOptions'), require('./model/Tmsv2customersBuyerInformation'), require('./model/Tmsv2customersClientReferenceInformation'), require('./model/Tmsv2customersDefaultPaymentInstrument'), require('./model/Tmsv2customersDefaultShippingAddress'), require('./model/Tmsv2customersEmbedded'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrument'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor'), require('./model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddress'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinks'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata'), require('./model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo'), require('./model/Tmsv2customersLinks'), require('./model/Tmsv2customersLinksPaymentInstruments'), require('./model/Tmsv2customersLinksSelf'), require('./model/Tmsv2customersLinksShippingAddress'), require('./model/Tmsv2customersMerchantDefinedInformation'), require('./model/Tmsv2customersMetadata'), require('./model/Tmsv2customersObjectInformation'), require('./model/TssV2GetEmvTags200Response'), require('./model/TssV2GetEmvTags200ResponseEmvTagBreakdownList'), require('./model/TssV2PostEmvTags200Response'), require('./model/TssV2PostEmvTags200ResponseEmvTagBreakdownList'), require('./model/TssV2PostEmvTags200ResponseParsedEMVTagsList'), require('./model/TssV2TransactionsGet200Response'), require('./model/TssV2TransactionsGet200ResponseApplicationInformation'), require('./model/TssV2TransactionsGet200ResponseApplicationInformationApplications'), require('./model/TssV2TransactionsGet200ResponseBuyerInformation'), require('./model/TssV2TransactionsGet200ResponseClientReferenceInformation'), require('./model/TssV2TransactionsGet200ResponseClientReferenceInformationPartner'), require('./model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation'), require('./model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication'), require('./model/TssV2TransactionsGet200ResponseDeviceInformation'), require('./model/TssV2TransactionsGet200ResponseErrorInformation'), require('./model/TssV2TransactionsGet200ResponseFraudMarkingInformation'), require('./model/TssV2TransactionsGet200ResponseInstallmentInformation'), require('./model/TssV2TransactionsGet200ResponseLinks'), require('./model/TssV2TransactionsGet200ResponseMerchantInformation'), require('./model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor'), require('./model/TssV2TransactionsGet200ResponseOrderInformation'), require('./model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails'), require('./model/TssV2TransactionsGet200ResponseOrderInformationBillTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails'), require('./model/TssV2TransactionsGet200ResponseOrderInformationLineItems'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShipTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails'), require('./model/TssV2TransactionsGet200ResponsePaymentInformation'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBank'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBrands'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationCard'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationCustomer'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationFeatures'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationFluidData'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationInvoice'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationNetwork'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType'), require('./model/TssV2TransactionsGet200ResponsePayoutOptions'), require('./model/TssV2TransactionsGet200ResponsePointOfSaleInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions'), require('./model/TssV2TransactionsGet200ResponseProcessorInformation'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationProcessor'), require('./model/TssV2TransactionsGet200ResponseRecurringPaymentInformation'), require('./model/TssV2TransactionsGet200ResponseRiskInformation'), require('./model/TssV2TransactionsGet200ResponseRiskInformationProfile'), require('./model/TssV2TransactionsGet200ResponseRiskInformationRules'), require('./model/TssV2TransactionsGet200ResponseRiskInformationScore'), require('./model/TssV2TransactionsGet200ResponseSenderInformation'), require('./model/TssV2TransactionsGet200ResponseTokenInformation'), require('./model/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation'), require('./model/TssV2TransactionsPost201Response'), require('./model/TssV2TransactionsPost201ResponseEmbedded'), require('./model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications'), require('./model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner'), require('./model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedLinks'), require('./model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint'), require('./model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries'), require('./model/TssV2TransactionsPost400Response'), require('./model/Tssv2transactionsemvTagDetailsEmvDetailsList'), require('./model/UmsV1UsersGet200Response'), require('./model/UmsV1UsersGet200ResponseAccountInformation'), require('./model/UmsV1UsersGet200ResponseContactInformation'), require('./model/UmsV1UsersGet200ResponseOrganizationInformation'), require('./model/UmsV1UsersGet200ResponseUsers'), require('./model/UpdateAsymKeysRequest'), require('./model/UpdateInvoiceRequest'), require('./model/UpdatePGPKeysRequest'), require('./model/UpdatePGPKeysRequest1'), require('./model/UpdatePasswordKeysRequest'), require('./model/UpdatePlanRequest'), require('./model/UpdatePlanResponse'), require('./model/UpdatePlanResponsePlanInformation'), require('./model/UpdateSubscription'), require('./model/UpdateSubscriptionResponse'), require('./model/UpdateWebhookRequest'), require('./model/Upv1capturecontextsCaptureMandate'), require('./model/Upv1capturecontextsCheckoutApiInitialization'), require('./model/Upv1capturecontextsOrderInformation'), require('./model/Upv1capturecontextsOrderInformationAmountDetails'), require('./model/Upv1capturecontextsOrderInformationBillTo'), require('./model/Upv1capturecontextsOrderInformationBillToCompany'), require('./model/Upv1capturecontextsOrderInformationShipTo'), require('./model/V1FileDetailsGet200Response'), require('./model/V1FileDetailsGet200ResponseFileDetails'), require('./model/V1FileDetailsGet200ResponseLinks'), require('./model/V1FileDetailsGet200ResponseLinksFiles'), require('./model/V1FileDetailsGet200ResponseLinksSelf'), require('./model/VTConfig'), require('./model/VTConfigCardNotPresent'), require('./model/VTConfigCardNotPresentGlobalPaymentInformation'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields'), require('./model/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation'), require('./model/VTConfigCardNotPresentReceiptInformation'), require('./model/VTConfigCardNotPresentReceiptInformationEmailReceipt'), require('./model/VTConfigCardNotPresentReceiptInformationHeader'), require('./model/VTConfigCardNotPresentReceiptInformationOrderInformation'), require('./model/ValidateExportComplianceRequest'), require('./model/ValidateRequest'), require('./model/ValueAddedServicesProducts'), require('./model/VasV2PaymentsPost201Response'), require('./model/VasV2PaymentsPost201ResponseLinks'), require('./model/VasV2PaymentsPost201ResponseOrderInformation'), require('./model/VasV2PaymentsPost201ResponseOrderInformationJurisdiction'), require('./model/VasV2PaymentsPost201ResponseOrderInformationLineItems'), require('./model/VasV2PaymentsPost201ResponseOrderInformationTaxDetails'), require('./model/VasV2PaymentsPost201ResponseTaxInformation'), require('./model/VasV2PaymentsPost400Response'), require('./model/VasV2TaxVoid200Response'), require('./model/VasV2TaxVoid200ResponseVoidAmountDetails'), require('./model/VasV2TaxVoidsPost400Response'), require('./model/Vasv2taxBuyerInformation'), require('./model/Vasv2taxClientReferenceInformation'), require('./model/Vasv2taxMerchantInformation'), require('./model/Vasv2taxOrderInformation'), require('./model/Vasv2taxOrderInformationBillTo'), require('./model/Vasv2taxOrderInformationInvoiceDetails'), require('./model/Vasv2taxOrderInformationLineItems'), require('./model/Vasv2taxOrderInformationOrderAcceptance'), require('./model/Vasv2taxOrderInformationOrderOrigin'), require('./model/Vasv2taxOrderInformationShipTo'), require('./model/Vasv2taxOrderInformationShippingDetails'), require('./model/Vasv2taxTaxInformation'), require('./model/Vasv2taxidClientReferenceInformation'), require('./model/Vasv2taxidClientReferenceInformationPartner'), require('./model/VerifyCustomerAddressRequest'), require('./model/VoidCaptureRequest'), require('./model/VoidCreditRequest'), require('./model/VoidPaymentRequest'), require('./model/VoidRefundRequest'), require('./model/VoidTaxRequest'), require('./model/AccessTokenResponse'), require('./model/BadRequestError'), require('./model/CreateAccessTokenRequest'), require('./model/ResourceNotFoundError'), require('./model/UnauthorizedClientError'), require('./api/AsymmetricKeyManagementApi'), require('./api/BatchesApi'), require('./api/BillingAgreementsApi'), require('./api/CaptureApi'), require('./api/ChargebackDetailsApi'), require('./api/ChargebackSummariesApi'), require('./api/ConversionDetailsApi'), require('./api/CreateNewWebhooksApi'), require('./api/CreditApi'), require('./api/CustomerApi'), require('./api/CustomerPaymentInstrumentApi'), require('./api/CustomerShippingAddressApi'), require('./api/DecisionManagerApi'), require('./api/DownloadDTDApi'), require('./api/DownloadXSDApi'), require('./api/EMVTagDetailsApi'), require('./api/InstrumentIdentifierApi'), require('./api/InterchangeClearingLevelDetailsApi'), require('./api/InvoiceSettingsApi'), require('./api/InvoicesApi'), require('./api/KeyManagementApi'), require('./api/KeyManagementPasswordApi'), require('./api/KeyManagementPgpApi'), require('./api/KeyManagementScmpApi'), require('./api/ManageWebhooksApi'), require('./api/MerchantBoardingApi'), require('./api/MicroformIntegrationApi'), require('./api/NetFundingsApi'), require('./api/NotificationOfChangesApi'), require('./api/PayerAuthenticationApi'), require('./api/PaymentBatchSummariesApi'), require('./api/PaymentInstrumentApi'), require('./api/PaymentsApi'), require('./api/PayoutsApi'), require('./api/PlansApi'), require('./api/PurchaseAndRefundDetailsApi'), require('./api/PushFundsApi'), require('./api/RefundApi'), require('./api/ReplayWebhooksApi'), require('./api/ReportDefinitionsApi'), require('./api/ReportDownloadsApi'), require('./api/ReportSubscriptionsApi'), require('./api/ReportsApi'), require('./api/RetrievalDetailsApi'), require('./api/RetrievalSummariesApi'), require('./api/ReversalApi'), require('./api/SearchTransactionsApi'), require('./api/SecureFileShareApi'), require('./api/SubscriptionsApi'), require('./api/SymmetricKeyManagementApi'), require('./api/TaxesApi'), require('./api/TokenApi'), require('./api/TransactionBatchesApi'), require('./api/TransactionDetailsApi'), require('./api/TransientTokenDataApi'), require('./api/UnifiedCheckoutCaptureContextApi'), require('./api/UserManagementApi'), require('./api/UserManagementSearchApi'), require('./api/VerificationApi'), require('./api/VoidApi'), require('./api/OAuthApi')); } -}(function(ApiClient, Accountupdaterv1batchesIncluded, Accountupdaterv1batchesIncludedTokens, ActivateDeactivatePlanResponse, ActivateSubscriptionResponse, ActivateSubscriptionResponseSubscriptionInformation, AddNegativeListRequest, AuthReversalRequest, Boardingv1registrationsDocumentInformation, Boardingv1registrationsDocumentInformationSignedDocuments, Boardingv1registrationsIntegrationInformation, Boardingv1registrationsIntegrationInformationOauth2, Boardingv1registrationsIntegrationInformationTenantConfigurations, Boardingv1registrationsIntegrationInformationTenantInformation, Boardingv1registrationsOrganizationInformation, Boardingv1registrationsOrganizationInformationBusinessInformation, Boardingv1registrationsOrganizationInformationBusinessInformationAddress, Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact, Boardingv1registrationsOrganizationInformationKYC, Boardingv1registrationsOrganizationInformationKYCDepositBankAccount, Boardingv1registrationsOrganizationInformationOwners, Boardingv1registrationsProductInformation, Boardingv1registrationsProductInformationSelectedProducts, Boardingv1registrationsRegistrationInformation, Body, CancelSubscriptionResponse, CancelSubscriptionResponseSubscriptionInformation, CapturePaymentRequest, CardProcessingConfig, CardProcessingConfigCommon, CardProcessingConfigCommonAcquirer, CardProcessingConfigCommonCurrencies, CardProcessingConfigCommonCurrencies1, CardProcessingConfigCommonMerchantDescriptorInformation, CardProcessingConfigCommonPaymentTypes, CardProcessingConfigCommonProcessors, CardProcessingConfigFeatures, CardProcessingConfigFeaturesCardNotPresent, CardProcessingConfigFeaturesCardNotPresentInstallment, CardProcessingConfigFeaturesCardNotPresentPayouts, CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies, CardProcessingConfigFeaturesCardNotPresentProcessors, CardProcessingConfigFeaturesCardPresent, CardProcessingConfigFeaturesCardPresentProcessors, CaseManagementActionsRequest, CaseManagementCommentsRequest, CheckPayerAuthEnrollmentRequest, CommerceSolutionsProducts, CommerceSolutionsProductsAccountUpdater, CommerceSolutionsProductsAccountUpdaterConfigurationInformation, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa, CommerceSolutionsProductsBinLookup, CommerceSolutionsProductsBinLookupConfigurationInformation, CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations, CommerceSolutionsProductsTokenManagement, CommerceSolutionsProductsTokenManagementConfigurationInformation, CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations, CreateAdhocReportRequest, CreateBillingAgreement, CreateBundledDecisionManagerCaseRequest, CreateCreditRequest, CreateInvoiceRequest, CreateP12KeysRequest, CreatePaymentRequest, CreatePlanRequest, CreatePlanResponse, CreatePlanResponsePlanInformation, CreateReportSubscriptionRequest, CreateSearchRequest, CreateSessionReq, CreateSessionRequest, CreateSharedSecretKeysRequest, CreateSharedSecretKeysVerifiRequest, CreateSubscriptionRequest, CreateSubscriptionResponse, CreateSubscriptionResponseLinks, CreateSubscriptionResponseSubscriptionInformation, CreateWebhookRequest, DeleteBulkP12KeysRequest, DeleteBulkSymmetricKeysRequest, DeletePlanResponse, DmConfig, DmConfigOrganization, DmConfigPortfolioControls, DmConfigProcessingOptions, DmConfigThirdparty, DmConfigThirdpartyProvider, DmConfigThirdpartyProviderAccurint, DmConfigThirdpartyProviderAccurintCredentials, DmConfigThirdpartyProviderCredilink, DmConfigThirdpartyProviderCredilinkCredentials, DmConfigThirdpartyProviderEkata, DmConfigThirdpartyProviderEkataCredentials, DmConfigThirdpartyProviderEmailage, DmConfigThirdpartyProviderPerseuss, DmConfigThirdpartyProviderSignifyd, DmConfigThirdpartyProviderSignifydCredentials, DmConfigThirdpartyProviderTargus, DmConfigThirdpartyProviderTargusCredentials, ECheckConfig, ECheckConfigCommon, ECheckConfigCommonInternalOnly, ECheckConfigCommonInternalOnlyProcessors, ECheckConfigCommonProcessors, ECheckConfigFeatures, ECheckConfigFeaturesAccountValidationService, ECheckConfigFeaturesAccountValidationServiceInternalOnly, ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors, ECheckConfigFeaturesAccountValidationServiceProcessors, ECheckConfigUnderwriting, FraudMarkingActionRequest, GenerateCaptureContextRequest, GenerateUnifiedCheckoutCaptureContextRequest, GetAllPlansResponse, GetAllPlansResponseLinks, GetAllPlansResponseOrderInformation, GetAllPlansResponseOrderInformationAmountDetails, GetAllPlansResponsePlanInformation, GetAllPlansResponsePlanInformationBillingCycles, GetAllPlansResponsePlanInformationBillingPeriod, GetAllPlansResponsePlans, GetAllSubscriptionsResponse, GetAllSubscriptionsResponseLinks, GetAllSubscriptionsResponseOrderInformation, GetAllSubscriptionsResponseOrderInformationBillTo, GetAllSubscriptionsResponsePaymentInformation, GetAllSubscriptionsResponsePaymentInformationCustomer, GetAllSubscriptionsResponsePlanInformation, GetAllSubscriptionsResponsePlanInformationBillingCycles, GetAllSubscriptionsResponseSubscriptionInformation, GetAllSubscriptionsResponseSubscriptions, GetPlanCodeResponse, GetPlanResponse, GetSubscriptionCodeResponse, GetSubscriptionResponse, IncrementAuthRequest, InlineResponse200, InlineResponse2001, InlineResponse2001Keys, InlineResponse2002, InlineResponse2002IntegrationInformation, InlineResponse2002IntegrationInformationTenantConfigurations, InlineResponse2003, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2006Embedded, InlineResponse2006EmbeddedBatches, InlineResponse2006EmbeddedLinks, InlineResponse2006EmbeddedLinksReports, InlineResponse2006EmbeddedTotals, InlineResponse2006Links, InlineResponse2007, InlineResponse2007Billing, InlineResponse2007Links, InlineResponse2007LinksReport, InlineResponse2008, InlineResponse2008Records, InlineResponse2008ResponseRecord, InlineResponse2008ResponseRecordAdditionalUpdates, InlineResponse2008SourceRecord, InlineResponse200Embedded, InlineResponse200EmbeddedCapture, InlineResponse200EmbeddedCaptureLinks, InlineResponse200EmbeddedCaptureLinksSelf, InlineResponse200EmbeddedReversal, InlineResponse200EmbeddedReversalLinks, InlineResponse200EmbeddedReversalLinksSelf, InlineResponse201, InlineResponse2011, InlineResponse2011IntegrationInformation, InlineResponse2011IntegrationInformationTenantConfigurations, InlineResponse2011OrganizationInformation, InlineResponse2011ProductInformationSetups, InlineResponse2011RegistrationInformation, InlineResponse2011Setups, InlineResponse2011SetupsCommerceSolutions, InlineResponse2011SetupsPayments, InlineResponse2011SetupsPaymentsCardProcessing, InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus, InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus, InlineResponse2011SetupsPaymentsDigitalPayments, InlineResponse2011SetupsRisk, InlineResponse2011SetupsValueAddedServices, InlineResponse2012, InlineResponse2012KeyInformation, InlineResponse2012KeyInformationErrorInformation, InlineResponse2012KeyInformationErrorInformationDetails, InlineResponse2013, InlineResponse2014, InlineResponse202, InlineResponse202Links, InlineResponse202LinksStatus, InlineResponse400, InlineResponse4001, InlineResponse4002, InlineResponse4003, InlineResponse4004, InlineResponse4004Fields, InlineResponse4005, InlineResponse4006, InlineResponse4007, InlineResponse4007Details, InlineResponse4008, InlineResponse4008Details, InlineResponse400Details, InlineResponse400Errors, InlineResponse401, InlineResponse401Fields, InlineResponse401Links, InlineResponse401LinksSelf, InlineResponse403, InlineResponse4031, InlineResponse403Errors, InlineResponse404, InlineResponse4041, InlineResponse4042, InlineResponse4042Details, InlineResponse409, InlineResponse409Errors, InlineResponse410, InlineResponse410Errors, InlineResponse412, InlineResponse412Errors, InlineResponse422, InlineResponse4221, InlineResponse424, InlineResponse424Errors, InlineResponse500, InlineResponse5001, InlineResponse5002, InlineResponse5003, InlineResponse500Errors, InlineResponse502, InlineResponse5021, InlineResponse503, InlineResponseDefault, InlineResponseDefaultLinks, InlineResponseDefaultLinksNext, InlineResponseDefaultResponseStatus, InlineResponseDefaultResponseStatusDetails, IntimateBillingAgreement, InvoiceSettingsRequest, InvoicingV2InvoiceSettingsGet200Response, InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation, InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle, InvoicingV2InvoicesAllGet200Response, InvoicingV2InvoicesAllGet200ResponseCustomerInformation, InvoicingV2InvoicesAllGet200ResponseInvoiceInformation, InvoicingV2InvoicesAllGet200ResponseInvoices, InvoicingV2InvoicesAllGet200ResponseLinks, InvoicingV2InvoicesAllGet200ResponseOrderInformation, InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails, InvoicingV2InvoicesAllGet400Response, InvoicingV2InvoicesAllGet404Response, InvoicingV2InvoicesAllGet502Response, InvoicingV2InvoicesGet200Response, InvoicingV2InvoicesGet200ResponseInvoiceHistory, InvoicingV2InvoicesGet200ResponseTransactionDetails, InvoicingV2InvoicesPost201Response, InvoicingV2InvoicesPost201ResponseInvoiceInformation, InvoicingV2InvoicesPost201ResponseOrderInformation, InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails, InvoicingV2InvoicesPost202Response, Invoicingv2invoiceSettingsInvoiceSettingsInformation, Invoicingv2invoicesCustomerInformation, Invoicingv2invoicesCustomerInformationCompany, Invoicingv2invoicesInvoiceInformation, Invoicingv2invoicesOrderInformation, Invoicingv2invoicesOrderInformationAmountDetails, Invoicingv2invoicesOrderInformationAmountDetailsFreight, Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails, Invoicingv2invoicesOrderInformationLineItems, Invoicingv2invoicesidInvoiceInformation, KmsV2KeysAsymDeletesPost200Response, KmsV2KeysAsymDeletesPost200ResponseKeyInformation, KmsV2KeysAsymGet200Response, KmsV2KeysAsymGet200ResponseKeyInformation, KmsV2KeysAsymPost201Response, KmsV2KeysAsymPost201ResponseCertificateInformation, KmsV2KeysAsymPost201ResponseKeyInformation, KmsV2KeysSymDeletesPost200Response, KmsV2KeysSymDeletesPost200ResponseKeyInformation, KmsV2KeysSymGet200Response, KmsV2KeysSymGet200ResponseKeyInformation, KmsV2KeysSymPost201Response, KmsV2KeysSymPost201ResponseErrorInformation, KmsV2KeysSymPost201ResponseKeyInformation, Kmsegressv2keysasymClientReferenceInformation, Kmsegressv2keysasymKeyInformation, Kmsegressv2keyssymClientReferenceInformation, Kmsegressv2keyssymKeyInformation, Kmsv2keysasymKeyInformation, Kmsv2keyssymClientReferenceInformation, Kmsv2keyssymKeyInformation, Kmsv2keyssymdeletesKeyInformation, Kmsv2keyssymverifiKeyInformation, MerchantInitiatedTransactionObject, Microformv2sessionsCheckoutApiInitialization, MitReversalRequest, MitVoidRequest, ModifyBillingAgreement, Notificationsubscriptionsv1productsorganizationIdEventTypes, Notificationsubscriptionsv1webhooksNotificationScope, Notificationsubscriptionsv1webhooksProducts, Notificationsubscriptionsv1webhooksRetryPolicy, Notificationsubscriptionsv1webhooksSecurityPolicy, Notificationsubscriptionsv1webhooksSecurityPolicy1, Notificationsubscriptionsv1webhooksSecurityPolicy1Config, Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig, Notificationsubscriptionsv1webhooksSecurityPolicyConfig, Nrtfv1webhookswebhookIdreplaysByDeliveryStatus, OctCreatePaymentRequest, OrderPaymentRequest, PatchCustomerPaymentInstrumentRequest, PatchCustomerRequest, PatchCustomerShippingAddressRequest, PatchInstrumentIdentifierRequest, PatchPaymentInstrumentRequest, PayerAuthConfig, PayerAuthConfigCardTypes, PayerAuthConfigCardTypesCB, PayerAuthConfigCardTypesJCBJSecure, PayerAuthConfigCardTypesVerifiedByVisa, PayerAuthConfigCardTypesVerifiedByVisaCurrencies, PayerAuthSetupRequest, PaymentInstrumentList, PaymentInstrumentList1, PaymentInstrumentList1Embedded, PaymentInstrumentList1EmbeddedEmbedded, PaymentInstrumentList1EmbeddedPaymentInstruments, PaymentInstrumentListEmbedded, PaymentInstrumentListLinks, PaymentInstrumentListLinksFirst, PaymentInstrumentListLinksLast, PaymentInstrumentListLinksNext, PaymentInstrumentListLinksPrev, PaymentInstrumentListLinksSelf, PaymentsProducts, PaymentsProductsCardPresentConnect, PaymentsProductsCardPresentConnectConfigurationInformation, PaymentsProductsCardPresentConnectConfigurationInformationConfigurations, PaymentsProductsCardPresentConnectSubscriptionInformation, PaymentsProductsCardProcessing, PaymentsProductsCardProcessingConfigurationInformation, PaymentsProductsCardProcessingSubscriptionInformation, PaymentsProductsCardProcessingSubscriptionInformationFeatures, PaymentsProductsCurrencyConversion, PaymentsProductsCurrencyConversionConfigurationInformation, PaymentsProductsCurrencyConversionConfigurationInformationConfigurations, PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors, PaymentsProductsCybsReadyTerminal, PaymentsProductsDifferentialFee, PaymentsProductsDifferentialFeeSubscriptionInformation, PaymentsProductsDifferentialFeeSubscriptionInformationFeatures, PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge, PaymentsProductsDigitalPayments, PaymentsProductsDigitalPaymentsSubscriptionInformation, PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures, PaymentsProductsECheck, PaymentsProductsECheckConfigurationInformation, PaymentsProductsECheckSubscriptionInformation, PaymentsProductsPayerAuthentication, PaymentsProductsPayerAuthenticationConfigurationInformation, PaymentsProductsPayerAuthenticationSubscriptionInformation, PaymentsProductsPayouts, PaymentsProductsPayoutsConfigurationInformation, PaymentsProductsPayoutsConfigurationInformationConfigurations, PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount, PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds, PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds, PaymentsProductsSecureAcceptance, PaymentsProductsSecureAcceptanceConfigurationInformation, PaymentsProductsTax, PaymentsProductsVirtualTerminal, PaymentsProductsVirtualTerminalConfigurationInformation, PaymentsStrongAuthIssuerInformation, PostCustomerPaymentInstrumentRequest, PostCustomerRequest, PostCustomerShippingAddressRequest, PostInstrumentIdentifierEnrollmentRequest, PostInstrumentIdentifierRequest, PostPaymentCredentialsRequest, PostPaymentInstrumentRequest, PostRegistrationBody, PredefinedSubscriptionRequestBean, PtsV1TransactionBatchesGet200Response, PtsV1TransactionBatchesGet200ResponseLinks, PtsV1TransactionBatchesGet200ResponseLinksSelf, PtsV1TransactionBatchesGet200ResponseTransactionBatches, PtsV1TransactionBatchesGet400Response, PtsV1TransactionBatchesGet400ResponseErrorInformation, PtsV1TransactionBatchesGet400ResponseErrorInformationDetails, PtsV1TransactionBatchesGet500Response, PtsV1TransactionBatchesGet500ResponseErrorInformation, PtsV1TransactionBatchesIdGet200Response, PtsV1TransactionBatchesIdGet200ResponseLinks, PtsV1TransactionBatchesIdGet200ResponseLinksTransactions, PtsV2CreateBillingAgreementPost201Response, PtsV2CreateBillingAgreementPost201ResponseAgreementInformation, PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation, PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation, PtsV2CreateBillingAgreementPost201ResponseLinks, PtsV2CreateBillingAgreementPost201ResponseProcessorInformation, PtsV2CreateBillingAgreementPost201ResponseRiskInformation, PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults, PtsV2CreateBillingAgreementPost400Response, PtsV2CreateBillingAgreementPost502Response, PtsV2CreditsPost201Response, PtsV2CreditsPost201Response1, PtsV2CreditsPost201Response1ProcessorInformation, PtsV2CreditsPost201ResponseCreditAmountDetails, PtsV2CreditsPost201ResponsePaymentInformation, PtsV2CreditsPost201ResponseProcessingInformation, PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions, PtsV2IncrementalAuthorizationPatch201Response, PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation, PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation, PtsV2IncrementalAuthorizationPatch201ResponseLinks, PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation, PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails, PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation, PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures, PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation, PtsV2IncrementalAuthorizationPatch400Response, PtsV2ModifyBillingAgreementPost201Response, PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation, PtsV2ModifyBillingAgreementPost201ResponseLinks, PtsV2ModifyBillingAgreementPost201ResponseOrderInformation, PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo, PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet, PtsV2PaymentsCapturesPost201Response, PtsV2PaymentsCapturesPost201ResponseLinks, PtsV2PaymentsCapturesPost201ResponseOrderInformation, PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails, PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation, PtsV2PaymentsCapturesPost201ResponseProcessingInformation, PtsV2PaymentsCapturesPost201ResponseProcessorInformation, PtsV2PaymentsCapturesPost400Response, PtsV2PaymentsOrderPost201Response, PtsV2PaymentsOrderPost201ResponseBuyerInformation, PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification, PtsV2PaymentsOrderPost201ResponseOrderInformation, PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo, PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo, PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails, PtsV2PaymentsOrderPost201ResponsePaymentInformation, PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet, PtsV2PaymentsOrderPost201ResponseProcessingInformation, PtsV2PaymentsOrderPost201ResponseProcessorInformation, PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection, PtsV2PaymentsPost201Response, PtsV2PaymentsPost201Response1, PtsV2PaymentsPost201Response1OrderInformation, PtsV2PaymentsPost201Response1OrderInformationBillTo, PtsV2PaymentsPost201Response1OrderInformationShipTo, PtsV2PaymentsPost201Response1PaymentInformation, PtsV2PaymentsPost201Response1PaymentInformationBank, PtsV2PaymentsPost201Response1PaymentInformationBankAccount, PtsV2PaymentsPost201Response1PaymentInformationPaymentType, PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod, PtsV2PaymentsPost201Response1ProcessorInformation, PtsV2PaymentsPost201Response1ProcessorInformationAvs, PtsV2PaymentsPost201Response2, PtsV2PaymentsPost201Response2OrderInformation, PtsV2PaymentsPost201Response2OrderInformationAmountDetails, PtsV2PaymentsPost201Response2PaymentInformation, PtsV2PaymentsPost201Response2PaymentInformationEWallet, PtsV2PaymentsPost201Response2ProcessorInformation, PtsV2PaymentsPost201ResponseBuyerInformation, PtsV2PaymentsPost201ResponseClientReferenceInformation, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication, PtsV2PaymentsPost201ResponseEmbeddedActions, PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE, PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION, PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION, PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING, PtsV2PaymentsPost201ResponseErrorInformation, PtsV2PaymentsPost201ResponseErrorInformationDetails, PtsV2PaymentsPost201ResponseInstallmentInformation, PtsV2PaymentsPost201ResponseIssuerInformation, PtsV2PaymentsPost201ResponseLinks, PtsV2PaymentsPost201ResponseLinksSelf, PtsV2PaymentsPost201ResponseMerchantInformation, PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor, PtsV2PaymentsPost201ResponseOrderInformation, PtsV2PaymentsPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsPost201ResponseOrderInformationBillTo, PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails, PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails, PtsV2PaymentsPost201ResponseOrderInformationShipTo, PtsV2PaymentsPost201ResponsePaymentAccountInformation, PtsV2PaymentsPost201ResponsePaymentAccountInformationCard, PtsV2PaymentsPost201ResponsePaymentInformation, PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures, PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances, PtsV2PaymentsPost201ResponsePaymentInformationBank, PtsV2PaymentsPost201ResponsePaymentInformationBankAccount, PtsV2PaymentsPost201ResponsePaymentInformationEWallet, PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier, PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard, PtsV2PaymentsPost201ResponsePaymentInsightsInformation, PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights, PtsV2PaymentsPost201ResponsePointOfSaleInformation, PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv, PtsV2PaymentsPost201ResponseProcessingInformation, PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions, PtsV2PaymentsPost201ResponseProcessorInformation, PtsV2PaymentsPost201ResponseProcessorInformationAchVerification, PtsV2PaymentsPost201ResponseProcessorInformationAvs, PtsV2PaymentsPost201ResponseProcessorInformationCardVerification, PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse, PtsV2PaymentsPost201ResponseProcessorInformationCustomer, PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults, PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice, PtsV2PaymentsPost201ResponseProcessorInformationRouting, PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection, PtsV2PaymentsPost201ResponseRiskInformation, PtsV2PaymentsPost201ResponseRiskInformationInfoCodes, PtsV2PaymentsPost201ResponseRiskInformationIpAddress, PtsV2PaymentsPost201ResponseRiskInformationProcessorResults, PtsV2PaymentsPost201ResponseRiskInformationProfile, PtsV2PaymentsPost201ResponseRiskInformationRules, PtsV2PaymentsPost201ResponseRiskInformationScore, PtsV2PaymentsPost201ResponseRiskInformationTravel, PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination, PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture, PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination, PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination, PtsV2PaymentsPost201ResponseRiskInformationVelocity, PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing, PtsV2PaymentsPost201ResponseTokenInformation, PtsV2PaymentsPost201ResponseTokenInformationCustomer, PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier, PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument, PtsV2PaymentsPost201ResponseTokenInformationShippingAddress, PtsV2PaymentsPost201ResponseWatchlistScreeningInformation, PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList, PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches, PtsV2PaymentsPost400Response, PtsV2PaymentsPost502Response, PtsV2PaymentsRefundPost201Response, PtsV2PaymentsRefundPost201ResponseClientReferenceInformation, PtsV2PaymentsRefundPost201ResponseLinks, PtsV2PaymentsRefundPost201ResponseOrderInformation, PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsRefundPost201ResponseProcessorInformation, PtsV2PaymentsRefundPost201ResponseRefundAmountDetails, PtsV2PaymentsRefundPost400Response, PtsV2PaymentsReversalsPost201Response, PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation, PtsV2PaymentsReversalsPost201ResponseIssuerInformation, PtsV2PaymentsReversalsPost201ResponseProcessorInformation, PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails, PtsV2PaymentsReversalsPost400Response, PtsV2PaymentsVoidsPost201Response, PtsV2PaymentsVoidsPost201ResponseProcessorInformation, PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails, PtsV2PaymentsVoidsPost400Response, PtsV2PayoutsPost201Response, PtsV2PayoutsPost201ResponseErrorInformation, PtsV2PayoutsPost201ResponseIssuerInformation, PtsV2PayoutsPost201ResponseMerchantInformation, PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor, PtsV2PayoutsPost201ResponseOrderInformation, PtsV2PayoutsPost201ResponseOrderInformationAmountDetails, PtsV2PayoutsPost201ResponseProcessorInformation, PtsV2PayoutsPost201ResponseRecipientInformation, PtsV2PayoutsPost201ResponseRecipientInformationCard, PtsV2PayoutsPost400Response, Ptsv1pushfundstransferAggregatorInformation, Ptsv1pushfundstransferAggregatorInformationSubMerchant, Ptsv1pushfundstransferClientReferenceInformation, Ptsv1pushfundstransferMerchantDefinedInformation, Ptsv1pushfundstransferMerchantInformation, Ptsv1pushfundstransferMerchantInformationMerchantDescriptor, Ptsv1pushfundstransferOrderInformation, Ptsv1pushfundstransferOrderInformationAmountDetails, Ptsv1pushfundstransferOrderInformationSurcharge, Ptsv1pushfundstransferPointOfServiceInformation, Ptsv1pushfundstransferProcessingInformation, Ptsv1pushfundstransferProcessingInformationPayoutsOptions, Ptsv1pushfundstransferProcessingInformationRecurringOptions, Ptsv1pushfundstransferProcessingOptions, Ptsv1pushfundstransferProcessingOptionsFundingOptions, Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator, Ptsv1pushfundstransferRecipientInformation, Ptsv1pushfundstransferRecipientInformationPaymentInformation, Ptsv1pushfundstransferRecipientInformationPaymentInformationCard, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument, Ptsv1pushfundstransferRecipientInformationPersonalIdentification, Ptsv1pushfundstransferSenderInformation, Ptsv1pushfundstransferSenderInformationAccount, Ptsv1pushfundstransferSenderInformationPaymentInformation, Ptsv1pushfundstransferSenderInformationPaymentInformationCard, Ptsv1pushfundstransferSenderInformationPersonalIdentification, Ptsv2billingagreementsAggregatorInformation, Ptsv2billingagreementsAgreementInformation, Ptsv2billingagreementsBuyerInformation, Ptsv2billingagreementsClientReferenceInformation, Ptsv2billingagreementsConsumerAuthenticationInformation, Ptsv2billingagreementsDeviceInformation, Ptsv2billingagreementsInstallmentInformation, Ptsv2billingagreementsMerchantInformation, Ptsv2billingagreementsMerchantInformationMerchantDescriptor, Ptsv2billingagreementsOrderInformation, Ptsv2billingagreementsOrderInformationBillTo, Ptsv2billingagreementsPaymentInformation, Ptsv2billingagreementsPaymentInformationBank, Ptsv2billingagreementsPaymentInformationBankAccount, Ptsv2billingagreementsPaymentInformationCard, Ptsv2billingagreementsPaymentInformationPaymentType, Ptsv2billingagreementsPaymentInformationPaymentTypeMethod, Ptsv2billingagreementsPaymentInformationTokenizedCard, Ptsv2billingagreementsProcessingInformation, Ptsv2billingagreementsidAgreementInformation, Ptsv2billingagreementsidBuyerInformation, Ptsv2billingagreementsidProcessingInformation, Ptsv2creditsInstallmentInformation, Ptsv2creditsProcessingInformation, Ptsv2creditsProcessingInformationBankTransferOptions, Ptsv2creditsProcessingInformationElectronicBenefitsTransfer, Ptsv2creditsProcessingInformationJapanPaymentOptions, Ptsv2creditsProcessingInformationPurchaseOptions, Ptsv2creditsProcessingInformationRefundOptions, Ptsv2creditsRecipientInformation, Ptsv2creditsSenderInformation, Ptsv2creditsSenderInformationAccount, Ptsv2paymentreferencesAgreementInformation, Ptsv2paymentreferencesBuyerInformation, Ptsv2paymentreferencesDeviceInformation, Ptsv2paymentreferencesMerchantInformation, Ptsv2paymentreferencesOrderInformation, Ptsv2paymentreferencesOrderInformationAmountDetails, Ptsv2paymentreferencesOrderInformationBillTo, Ptsv2paymentreferencesOrderInformationInvoiceDetails, Ptsv2paymentreferencesOrderInformationLineItems, Ptsv2paymentreferencesOrderInformationShipTo, Ptsv2paymentreferencesPaymentInformation, Ptsv2paymentreferencesPaymentInformationBank, Ptsv2paymentreferencesPaymentInformationBankAccount, Ptsv2paymentreferencesPaymentInformationCard, Ptsv2paymentreferencesPaymentInformationEWallet, Ptsv2paymentreferencesPaymentInformationOptions, Ptsv2paymentreferencesProcessingInformation, Ptsv2paymentreferencesTravelInformation, Ptsv2paymentreferencesTravelInformationAutoRental, Ptsv2paymentreferencesUserInterface, Ptsv2paymentreferencesUserInterfaceColor, Ptsv2paymentreferencesidintentsOrderInformation, Ptsv2paymentreferencesidintentsPaymentInformation, Ptsv2paymentreferencesidintentsPaymentInformationEWallet, Ptsv2paymentreferencesidintentsProcessingInformation, Ptsv2paymentsAcquirerInformation, Ptsv2paymentsAggregatorInformation, Ptsv2paymentsAggregatorInformationSubMerchant, Ptsv2paymentsAgreementInformation, Ptsv2paymentsBuyerInformation, Ptsv2paymentsBuyerInformationPersonalIdentification, Ptsv2paymentsClientReferenceInformation, Ptsv2paymentsClientReferenceInformationPartner, Ptsv2paymentsConsumerAuthenticationInformation, Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication, Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation, Ptsv2paymentsDeviceInformation, Ptsv2paymentsDeviceInformationRawData, Ptsv2paymentsHealthCareInformation, Ptsv2paymentsHealthCareInformationAmountDetails, Ptsv2paymentsHostedPaymentInformation, Ptsv2paymentsHostedPaymentInformationUserAgent, Ptsv2paymentsInstallmentInformation, Ptsv2paymentsInvoiceDetails, Ptsv2paymentsIssuerInformation, Ptsv2paymentsMerchantDefinedInformation, Ptsv2paymentsMerchantDefinedSecureInformation, Ptsv2paymentsMerchantInformation, Ptsv2paymentsMerchantInformationMerchantDescriptor, Ptsv2paymentsMerchantInformationServiceFeeDescriptor, Ptsv2paymentsMerchantInformationServiceLocation, Ptsv2paymentsOrderInformation, Ptsv2paymentsOrderInformationAmountDetails, Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts, Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion, Ptsv2paymentsOrderInformationAmountDetailsOrder, Ptsv2paymentsOrderInformationAmountDetailsSurcharge, Ptsv2paymentsOrderInformationAmountDetailsTaxDetails, Ptsv2paymentsOrderInformationBillTo, Ptsv2paymentsOrderInformationBillToCompany, Ptsv2paymentsOrderInformationInvoiceDetails, Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum, Ptsv2paymentsOrderInformationLineItems, Ptsv2paymentsOrderInformationPassenger, Ptsv2paymentsOrderInformationShipTo, Ptsv2paymentsOrderInformationShippingDetails, Ptsv2paymentsPaymentInformation, Ptsv2paymentsPaymentInformationBank, Ptsv2paymentsPaymentInformationBankAccount, Ptsv2paymentsPaymentInformationCard, Ptsv2paymentsPaymentInformationCustomer, Ptsv2paymentsPaymentInformationDirectDebit, Ptsv2paymentsPaymentInformationDirectDebitMandate, Ptsv2paymentsPaymentInformationEWallet, Ptsv2paymentsPaymentInformationFluidData, Ptsv2paymentsPaymentInformationInstrumentIdentifier, Ptsv2paymentsPaymentInformationLegacyToken, Ptsv2paymentsPaymentInformationOptions, Ptsv2paymentsPaymentInformationPaymentInstrument, Ptsv2paymentsPaymentInformationPaymentType, Ptsv2paymentsPaymentInformationPaymentTypeMethod, Ptsv2paymentsPaymentInformationSepa, Ptsv2paymentsPaymentInformationSepaDirectDebit, Ptsv2paymentsPaymentInformationShippingAddress, Ptsv2paymentsPaymentInformationTokenizedCard, Ptsv2paymentsPointOfSaleInformation, Ptsv2paymentsPointOfSaleInformationEmv, Ptsv2paymentsProcessingInformation, Ptsv2paymentsProcessingInformationAuthorizationOptions, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, Ptsv2paymentsProcessingInformationBankTransferOptions, Ptsv2paymentsProcessingInformationCaptureOptions, Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer, Ptsv2paymentsProcessingInformationJapanPaymentOptions, Ptsv2paymentsProcessingInformationLoanOptions, Ptsv2paymentsProcessingInformationPurchaseOptions, Ptsv2paymentsProcessingInformationRecurringOptions, Ptsv2paymentsProcessorInformation, Ptsv2paymentsProcessorInformationAuthorizationOptions, Ptsv2paymentsProcessorInformationReversal, Ptsv2paymentsPromotionInformation, Ptsv2paymentsRecipientInformation, Ptsv2paymentsRecurringPaymentInformation, Ptsv2paymentsRiskInformation, Ptsv2paymentsRiskInformationAuxiliaryData, Ptsv2paymentsRiskInformationBuyerHistory, Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory, Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount, Ptsv2paymentsRiskInformationProfile, Ptsv2paymentsTokenInformation, Ptsv2paymentsTokenInformationPaymentInstrument, Ptsv2paymentsTokenInformationShippingAddress, Ptsv2paymentsTravelInformation, Ptsv2paymentsTravelInformationAgency, Ptsv2paymentsTravelInformationAutoRental, Ptsv2paymentsTravelInformationAutoRentalRentalAddress, Ptsv2paymentsTravelInformationAutoRentalReturnAddress, Ptsv2paymentsTravelInformationAutoRentalTaxDetails, Ptsv2paymentsTravelInformationLodging, Ptsv2paymentsTravelInformationLodgingRoom, Ptsv2paymentsTravelInformationTransit, Ptsv2paymentsTravelInformationTransitAirline, Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation, Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService, Ptsv2paymentsTravelInformationTransitAirlineLegs, Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer, Ptsv2paymentsTravelInformationVehicleData, Ptsv2paymentsWatchlistScreeningInformation, Ptsv2paymentsWatchlistScreeningInformationWeights, Ptsv2paymentsidClientReferenceInformation, Ptsv2paymentsidClientReferenceInformationPartner, Ptsv2paymentsidMerchantInformation, Ptsv2paymentsidOrderInformation, Ptsv2paymentsidOrderInformationAmountDetails, Ptsv2paymentsidProcessingInformation, Ptsv2paymentsidProcessingInformationAuthorizationOptions, Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator, Ptsv2paymentsidTravelInformation, Ptsv2paymentsidcapturesAggregatorInformation, Ptsv2paymentsidcapturesAggregatorInformationSubMerchant, Ptsv2paymentsidcapturesBuyerInformation, Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification, Ptsv2paymentsidcapturesDeviceInformation, Ptsv2paymentsidcapturesInstallmentInformation, Ptsv2paymentsidcapturesMerchantInformation, Ptsv2paymentsidcapturesOrderInformation, Ptsv2paymentsidcapturesOrderInformationAmountDetails, Ptsv2paymentsidcapturesOrderInformationBillTo, Ptsv2paymentsidcapturesOrderInformationInvoiceDetails, Ptsv2paymentsidcapturesOrderInformationShipTo, Ptsv2paymentsidcapturesOrderInformationShippingDetails, Ptsv2paymentsidcapturesPaymentInformation, Ptsv2paymentsidcapturesPaymentInformationCard, Ptsv2paymentsidcapturesPaymentInformationPaymentType, Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod, Ptsv2paymentsidcapturesPointOfSaleInformation, Ptsv2paymentsidcapturesPointOfSaleInformationEmv, Ptsv2paymentsidcapturesProcessingInformation, Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions, Ptsv2paymentsidcapturesProcessingInformationCaptureOptions, Ptsv2paymentsidrefundsClientReferenceInformation, Ptsv2paymentsidrefundsMerchantInformation, Ptsv2paymentsidrefundsOrderInformation, Ptsv2paymentsidrefundsOrderInformationLineItems, Ptsv2paymentsidrefundsPaymentInformation, Ptsv2paymentsidrefundsPaymentInformationBank, Ptsv2paymentsidrefundsPaymentInformationBankAccount, Ptsv2paymentsidrefundsPaymentInformationCard, Ptsv2paymentsidrefundsPaymentInformationEWallet, Ptsv2paymentsidrefundsPaymentInformationPaymentType, Ptsv2paymentsidrefundsPointOfSaleInformation, Ptsv2paymentsidrefundsProcessingInformation, Ptsv2paymentsidrefundsProcessingInformationRecurringOptions, Ptsv2paymentsidrefundsProcessingInformationRefundOptions, Ptsv2paymentsidreversalsClientReferenceInformation, Ptsv2paymentsidreversalsClientReferenceInformationPartner, Ptsv2paymentsidreversalsOrderInformation, Ptsv2paymentsidreversalsOrderInformationAmountDetails, Ptsv2paymentsidreversalsOrderInformationLineItems, Ptsv2paymentsidreversalsPaymentInformation, Ptsv2paymentsidreversalsPaymentInformationPaymentType, Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod, Ptsv2paymentsidreversalsPointOfSaleInformation, Ptsv2paymentsidreversalsPointOfSaleInformationEmv, Ptsv2paymentsidreversalsProcessingInformation, Ptsv2paymentsidreversalsReversalInformation, Ptsv2paymentsidreversalsReversalInformationAmountDetails, Ptsv2paymentsidvoidsAgreementInformation, Ptsv2paymentsidvoidsMerchantInformation, Ptsv2paymentsidvoidsOrderInformation, Ptsv2paymentsidvoidsPaymentInformation, Ptsv2paymentsidvoidsProcessingInformation, Ptsv2payoutsClientReferenceInformation, Ptsv2payoutsMerchantInformation, Ptsv2payoutsMerchantInformationMerchantDescriptor, Ptsv2payoutsOrderInformation, Ptsv2payoutsOrderInformationAmountDetails, Ptsv2payoutsOrderInformationAmountDetailsSurcharge, Ptsv2payoutsOrderInformationBillTo, Ptsv2payoutsPaymentInformation, Ptsv2payoutsPaymentInformationCard, Ptsv2payoutsProcessingInformation, Ptsv2payoutsProcessingInformationFundingOptions, Ptsv2payoutsProcessingInformationFundingOptionsInitiator, Ptsv2payoutsProcessingInformationPayoutsOptions, Ptsv2payoutsRecipientInformation, Ptsv2payoutsSenderInformation, Ptsv2payoutsSenderInformationAccount, Ptsv2refreshpaymentstatusidAgreementInformation, Ptsv2refreshpaymentstatusidClientReferenceInformation, Ptsv2refreshpaymentstatusidPaymentInformation, Ptsv2refreshpaymentstatusidPaymentInformationCustomer, Ptsv2refreshpaymentstatusidPaymentInformationPaymentType, Ptsv2refreshpaymentstatusidProcessingInformation, Ptsv2voidsProcessingInformation, PushFunds201Response, PushFunds201ResponseClientReferenceInformation, PushFunds201ResponseErrorInformation, PushFunds201ResponseErrorInformationDetails, PushFunds201ResponseLinks, PushFunds201ResponseLinksCustomer, PushFunds201ResponseLinksInstrumentIdentifier, PushFunds201ResponseLinksPaymentInstrument, PushFunds201ResponseLinksSelf, PushFunds201ResponseMerchantInformation, PushFunds201ResponseMerchantInformationMerchantDescriptor, PushFunds201ResponseOrderInformation, PushFunds201ResponseOrderInformationAmountDetails, PushFunds201ResponseProcessorInformation, PushFunds201ResponseRecipientInformation, PushFunds201ResponseRecipientInformationCard, PushFunds400Response, PushFunds400ResponseDetails, PushFunds401Response, PushFunds404Response, PushFunds502Response, PushFundsRequest, Rbsv1plansClientReferenceInformation, Rbsv1plansOrderInformation, Rbsv1plansOrderInformationAmountDetails, Rbsv1plansPlanInformation, Rbsv1plansPlanInformationBillingCycles, Rbsv1plansidPlanInformation, Rbsv1plansidProcessingInformation, Rbsv1plansidProcessingInformationSubscriptionBillingOptions, Rbsv1subscriptionsClientReferenceInformation, Rbsv1subscriptionsPaymentInformation, Rbsv1subscriptionsPaymentInformationCustomer, Rbsv1subscriptionsPlanInformation, Rbsv1subscriptionsProcessingInformation, Rbsv1subscriptionsProcessingInformationAuthorizationOptions, Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator, Rbsv1subscriptionsSubscriptionInformation, Rbsv1subscriptionsidOrderInformation, Rbsv1subscriptionsidOrderInformationAmountDetails, Rbsv1subscriptionsidPlanInformation, Rbsv1subscriptionsidSubscriptionInformation, RefreshPaymentStatusRequest, RefundCaptureRequest, RefundPaymentRequest, ReplayWebhooksRequest, ReportingV3ChargebackDetailsGet200Response, ReportingV3ChargebackDetailsGet200ResponseChargebackDetails, ReportingV3ChargebackSummariesGet200Response, ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries, ReportingV3ConversionDetailsGet200Response, ReportingV3ConversionDetailsGet200ResponseConversionDetails, ReportingV3ConversionDetailsGet200ResponseNotes, ReportingV3InterchangeClearingLevelDetailsGet200Response, ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails, ReportingV3NetFundingsGet200Response, ReportingV3NetFundingsGet200ResponseNetFundingSummaries, ReportingV3NetFundingsGet200ResponseTotalPurchases, ReportingV3NotificationofChangesGet200Response, ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges, ReportingV3PaymentBatchSummariesGet200Response, ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries, ReportingV3PurchaseRefundDetailsGet200Response, ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations, ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails, ReportingV3PurchaseRefundDetailsGet200ResponseOthers, ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails, ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses, ReportingV3PurchaseRefundDetailsGet200ResponseSettlements, ReportingV3ReportDefinitionsGet200Response, ReportingV3ReportDefinitionsGet200ResponseReportDefinitions, ReportingV3ReportDefinitionsNameGet200Response, ReportingV3ReportDefinitionsNameGet200ResponseAttributes, ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings, ReportingV3ReportSubscriptionsGet200Response, ReportingV3ReportSubscriptionsGet200ResponseSubscriptions, ReportingV3ReportsGet200Response, ReportingV3ReportsGet200ResponseLink, ReportingV3ReportsGet200ResponseLinkReportDownload, ReportingV3ReportsGet200ResponseReportSearchResults, ReportingV3ReportsIdGet200Response, ReportingV3RetrievalDetailsGet200Response, ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails, ReportingV3RetrievalSummariesGet200Response, Reportingv3ReportDownloadsGet400Response, Reportingv3ReportDownloadsGet400ResponseDetails, Reportingv3reportsReportFilters, Reportingv3reportsReportPreferences, RiskProducts, RiskProductsDecisionManager, RiskProductsDecisionManagerConfigurationInformation, RiskProductsFraudManagementEssentials, RiskProductsFraudManagementEssentialsConfigurationInformation, RiskV1AddressVerificationsPost201Response, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1, RiskV1AddressVerificationsPost201ResponseErrorInformation, RiskV1AuthenticationResultsPost201Response, RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationSetupsPost201Response, RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationSetupsPost201ResponseErrorInformation, RiskV1AuthenticationsPost201Response, RiskV1AuthenticationsPost201ResponseErrorInformation, RiskV1AuthenticationsPost400Response, RiskV1AuthenticationsPost400Response1, RiskV1DecisionsPost201Response, RiskV1DecisionsPost201ResponseClientReferenceInformation, RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation, RiskV1DecisionsPost201ResponseErrorInformation, RiskV1DecisionsPost201ResponseOrderInformation, RiskV1DecisionsPost201ResponseOrderInformationAmountDetails, RiskV1DecisionsPost201ResponsePaymentInformation, RiskV1DecisionsPost400Response, RiskV1DecisionsPost400Response1, RiskV1ExportComplianceInquiriesPost201Response, RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation, RiskV1UpdatePost201Response, Riskv1addressverificationsBuyerInformation, Riskv1addressverificationsOrderInformation, Riskv1addressverificationsOrderInformationBillTo, Riskv1addressverificationsOrderInformationLineItems, Riskv1addressverificationsOrderInformationShipTo, Riskv1authenticationresultsConsumerAuthenticationInformation, Riskv1authenticationresultsDeviceInformation, Riskv1authenticationresultsOrderInformation, Riskv1authenticationresultsOrderInformationAmountDetails, Riskv1authenticationresultsPaymentInformation, Riskv1authenticationresultsPaymentInformationCard, Riskv1authenticationresultsPaymentInformationFluidData, Riskv1authenticationresultsPaymentInformationTokenizedCard, Riskv1authenticationsBuyerInformation, Riskv1authenticationsDeviceInformation, Riskv1authenticationsOrderInformation, Riskv1authenticationsOrderInformationAmountDetails, Riskv1authenticationsOrderInformationBillTo, Riskv1authenticationsOrderInformationLineItems, Riskv1authenticationsPaymentInformation, Riskv1authenticationsPaymentInformationCard, Riskv1authenticationsPaymentInformationTokenizedCard, Riskv1authenticationsRiskInformation, Riskv1authenticationsTravelInformation, Riskv1authenticationsetupsPaymentInformation, Riskv1authenticationsetupsPaymentInformationCard, Riskv1authenticationsetupsPaymentInformationCustomer, Riskv1authenticationsetupsPaymentInformationFluidData, Riskv1authenticationsetupsPaymentInformationTokenizedCard, Riskv1authenticationsetupsProcessingInformation, Riskv1authenticationsetupsTokenInformation, Riskv1decisionsAcquirerInformation, Riskv1decisionsBuyerInformation, Riskv1decisionsClientReferenceInformation, Riskv1decisionsClientReferenceInformationPartner, Riskv1decisionsConsumerAuthenticationInformation, Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication, Riskv1decisionsDeviceInformation, Riskv1decisionsMerchantDefinedInformation, Riskv1decisionsMerchantInformation, Riskv1decisionsMerchantInformationMerchantDescriptor, Riskv1decisionsOrderInformation, Riskv1decisionsOrderInformationAmountDetails, Riskv1decisionsOrderInformationBillTo, Riskv1decisionsOrderInformationLineItems, Riskv1decisionsOrderInformationShipTo, Riskv1decisionsOrderInformationShippingDetails, Riskv1decisionsPaymentInformation, Riskv1decisionsPaymentInformationCard, Riskv1decisionsPaymentInformationTokenizedCard, Riskv1decisionsProcessingInformation, Riskv1decisionsProcessorInformation, Riskv1decisionsProcessorInformationAvs, Riskv1decisionsProcessorInformationCardVerification, Riskv1decisionsRiskInformation, Riskv1decisionsTokenInformation, Riskv1decisionsTravelInformation, Riskv1decisionsTravelInformationLegs, Riskv1decisionsTravelInformationPassengers, Riskv1decisionsidactionsDecisionInformation, Riskv1decisionsidactionsProcessingInformation, Riskv1decisionsidmarkingRiskInformation, Riskv1decisionsidmarkingRiskInformationMarkingDetails, Riskv1exportcomplianceinquiriesDeviceInformation, Riskv1exportcomplianceinquiriesExportComplianceInformation, Riskv1exportcomplianceinquiriesOrderInformation, Riskv1exportcomplianceinquiriesOrderInformationBillTo, Riskv1exportcomplianceinquiriesOrderInformationBillToCompany, Riskv1exportcomplianceinquiriesOrderInformationLineItems, Riskv1exportcomplianceinquiriesOrderInformationShipTo, Riskv1liststypeentriesBuyerInformation, Riskv1liststypeentriesClientReferenceInformation, Riskv1liststypeentriesDeviceInformation, Riskv1liststypeentriesOrderInformation, Riskv1liststypeentriesOrderInformationAddress, Riskv1liststypeentriesOrderInformationBillTo, Riskv1liststypeentriesOrderInformationLineItems, Riskv1liststypeentriesOrderInformationShipTo, Riskv1liststypeentriesPaymentInformation, Riskv1liststypeentriesPaymentInformationBank, Riskv1liststypeentriesPaymentInformationCard, Riskv1liststypeentriesRiskInformation, Riskv1liststypeentriesRiskInformationMarkingDetails, SAConfig, SAConfigCheckout, SAConfigContactInformation, SAConfigNotifications, SAConfigNotificationsCustomerNotifications, SAConfigNotificationsMerchantNotifications, SAConfigPaymentMethods, SAConfigPaymentTypes, SAConfigPaymentTypesCardTypes, SAConfigPaymentTypesCardTypesDiscover, SAConfigService, SaveAsymEgressKey, SaveSymEgressKey, SearchRequest, ShippingAddressListForCustomer, ShippingAddressListForCustomerEmbedded, ShippingAddressListForCustomerLinks, ShippingAddressListForCustomerLinksFirst, ShippingAddressListForCustomerLinksLast, ShippingAddressListForCustomerLinksNext, ShippingAddressListForCustomerLinksPrev, ShippingAddressListForCustomerLinksSelf, SuspendSubscriptionResponse, SuspendSubscriptionResponseSubscriptionInformation, TaxRequest, TmsAuthorizationOptions, TmsAuthorizationOptionsInitiator, TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction, TmsEmbeddedInstrumentIdentifier, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments, TmsEmbeddedInstrumentIdentifierLinksSelf, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard, TmsEmbeddedInstrumentIdentifierTokenizedCardCard, TmsPaymentInstrumentProcessingInfo, TmsPaymentInstrumentProcessingInfoBankTransferOptions, Tmsv2customersBuyerInformation, Tmsv2customersClientReferenceInformation, Tmsv2customersDefaultPaymentInstrument, Tmsv2customersDefaultShippingAddress, Tmsv2customersEmbedded, Tmsv2customersEmbeddedDefaultPaymentInstrument, Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount, Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification, Tmsv2customersEmbeddedDefaultPaymentInstrumentCard, Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded, Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier, Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks, Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf, Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor, Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata, Tmsv2customersEmbeddedDefaultShippingAddress, Tmsv2customersEmbeddedDefaultShippingAddressLinks, Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer, Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf, Tmsv2customersEmbeddedDefaultShippingAddressMetadata, Tmsv2customersEmbeddedDefaultShippingAddressShipTo, Tmsv2customersLinks, Tmsv2customersLinksPaymentInstruments, Tmsv2customersLinksSelf, Tmsv2customersLinksShippingAddress, Tmsv2customersMerchantDefinedInformation, Tmsv2customersMetadata, Tmsv2customersObjectInformation, TssV2GetEmvTags200Response, TssV2GetEmvTags200ResponseEmvTagBreakdownList, TssV2PostEmvTags200Response, TssV2PostEmvTags200ResponseEmvTagBreakdownList, TssV2PostEmvTags200ResponseParsedEMVTagsList, TssV2TransactionsGet200Response, TssV2TransactionsGet200ResponseApplicationInformation, TssV2TransactionsGet200ResponseApplicationInformationApplications, TssV2TransactionsGet200ResponseBuyerInformation, TssV2TransactionsGet200ResponseClientReferenceInformation, TssV2TransactionsGet200ResponseClientReferenceInformationPartner, TssV2TransactionsGet200ResponseConsumerAuthenticationInformation, TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication, TssV2TransactionsGet200ResponseDeviceInformation, TssV2TransactionsGet200ResponseErrorInformation, TssV2TransactionsGet200ResponseFraudMarkingInformation, TssV2TransactionsGet200ResponseInstallmentInformation, TssV2TransactionsGet200ResponseLinks, TssV2TransactionsGet200ResponseMerchantInformation, TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor, TssV2TransactionsGet200ResponseOrderInformation, TssV2TransactionsGet200ResponseOrderInformationAmountDetails, TssV2TransactionsGet200ResponseOrderInformationBillTo, TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails, TssV2TransactionsGet200ResponseOrderInformationLineItems, TssV2TransactionsGet200ResponseOrderInformationShipTo, TssV2TransactionsGet200ResponseOrderInformationShippingDetails, TssV2TransactionsGet200ResponsePaymentInformation, TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures, TssV2TransactionsGet200ResponsePaymentInformationBank, TssV2TransactionsGet200ResponsePaymentInformationBankAccount, TssV2TransactionsGet200ResponsePaymentInformationBankMandate, TssV2TransactionsGet200ResponsePaymentInformationBrands, TssV2TransactionsGet200ResponsePaymentInformationCard, TssV2TransactionsGet200ResponsePaymentInformationCustomer, TssV2TransactionsGet200ResponsePaymentInformationFeatures, TssV2TransactionsGet200ResponsePaymentInformationFluidData, TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier, TssV2TransactionsGet200ResponsePaymentInformationInvoice, TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation, TssV2TransactionsGet200ResponsePaymentInformationNetwork, TssV2TransactionsGet200ResponsePaymentInformationPaymentType, TssV2TransactionsGet200ResponsePayoutOptions, TssV2TransactionsGet200ResponsePointOfSaleInformation, TssV2TransactionsGet200ResponseProcessingInformation, TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions, TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator, TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions, TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions, TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions, TssV2TransactionsGet200ResponseProcessorInformation, TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults, TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting, TssV2TransactionsGet200ResponseProcessorInformationProcessor, TssV2TransactionsGet200ResponseRecurringPaymentInformation, TssV2TransactionsGet200ResponseRiskInformation, TssV2TransactionsGet200ResponseRiskInformationProfile, TssV2TransactionsGet200ResponseRiskInformationRules, TssV2TransactionsGet200ResponseRiskInformationScore, TssV2TransactionsGet200ResponseSenderInformation, TssV2TransactionsGet200ResponseTokenInformation, TssV2TransactionsGet200ResponseUnscheduledPaymentInformation, TssV2TransactionsPost201Response, TssV2TransactionsPost201ResponseEmbedded, TssV2TransactionsPost201ResponseEmbeddedApplicationInformation, TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications, TssV2TransactionsPost201ResponseEmbeddedBuyerInformation, TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation, TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner, TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation, TssV2TransactionsPost201ResponseEmbeddedErrorInformation, TssV2TransactionsPost201ResponseEmbeddedLinks, TssV2TransactionsPost201ResponseEmbeddedMerchantInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo, TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo, TssV2TransactionsPost201ResponseEmbeddedPaymentInformation, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType, TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation, TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner, TssV2TransactionsPost201ResponseEmbeddedProcessingInformation, TssV2TransactionsPost201ResponseEmbeddedProcessorInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint, TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries, TssV2TransactionsPost400Response, Tssv2transactionsemvTagDetailsEmvDetailsList, UmsV1UsersGet200Response, UmsV1UsersGet200ResponseAccountInformation, UmsV1UsersGet200ResponseContactInformation, UmsV1UsersGet200ResponseOrganizationInformation, UmsV1UsersGet200ResponseUsers, UpdateAsymKeysRequest, UpdateInvoiceRequest, UpdatePGPKeysRequest, UpdatePGPKeysRequest1, UpdatePasswordKeysRequest, UpdatePlanRequest, UpdatePlanResponse, UpdatePlanResponsePlanInformation, UpdateSubscription, UpdateSubscriptionResponse, UpdateWebhookRequest, Upv1capturecontextsCaptureMandate, Upv1capturecontextsCheckoutApiInitialization, Upv1capturecontextsOrderInformation, Upv1capturecontextsOrderInformationAmountDetails, Upv1capturecontextsOrderInformationBillTo, Upv1capturecontextsOrderInformationBillToCompany, Upv1capturecontextsOrderInformationShipTo, V1FileDetailsGet200Response, V1FileDetailsGet200ResponseFileDetails, V1FileDetailsGet200ResponseLinks, V1FileDetailsGet200ResponseLinksFiles, V1FileDetailsGet200ResponseLinksSelf, VTConfig, VTConfigCardNotPresent, VTConfigCardNotPresentGlobalPaymentInformation, VTConfigCardNotPresentGlobalPaymentInformationBasicInformation, VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields, VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation, VTConfigCardNotPresentReceiptInformation, VTConfigCardNotPresentReceiptInformationEmailReceipt, VTConfigCardNotPresentReceiptInformationHeader, VTConfigCardNotPresentReceiptInformationOrderInformation, ValidateExportComplianceRequest, ValidateRequest, ValueAddedServicesProducts, VasV2PaymentsPost201Response, VasV2PaymentsPost201ResponseLinks, VasV2PaymentsPost201ResponseOrderInformation, VasV2PaymentsPost201ResponseOrderInformationJurisdiction, VasV2PaymentsPost201ResponseOrderInformationLineItems, VasV2PaymentsPost201ResponseOrderInformationTaxDetails, VasV2PaymentsPost201ResponseTaxInformation, VasV2PaymentsPost400Response, VasV2TaxVoid200Response, VasV2TaxVoid200ResponseVoidAmountDetails, VasV2TaxVoidsPost400Response, Vasv2taxBuyerInformation, Vasv2taxClientReferenceInformation, Vasv2taxMerchantInformation, Vasv2taxOrderInformation, Vasv2taxOrderInformationBillTo, Vasv2taxOrderInformationInvoiceDetails, Vasv2taxOrderInformationLineItems, Vasv2taxOrderInformationOrderAcceptance, Vasv2taxOrderInformationOrderOrigin, Vasv2taxOrderInformationShipTo, Vasv2taxOrderInformationShippingDetails, Vasv2taxTaxInformation, Vasv2taxidClientReferenceInformation, Vasv2taxidClientReferenceInformationPartner, VerifyCustomerAddressRequest, VoidCaptureRequest, VoidCreditRequest, VoidPaymentRequest, VoidRefundRequest, VoidTaxRequest, AccessTokenResponse, BadRequestError, CreateAccessTokenRequest, ResourceNotFoundError, UnauthorizedClientError, AsymmetricKeyManagementApi, BatchesApi, BillingAgreementsApi, CaptureApi, ChargebackDetailsApi, ChargebackSummariesApi, ConversionDetailsApi, CreateNewWebhooksApi, CreditApi, CustomerApi, CustomerPaymentInstrumentApi, CustomerShippingAddressApi, DecisionManagerApi, DownloadDTDApi, DownloadXSDApi, EMVTagDetailsApi, InstrumentIdentifierApi, InterchangeClearingLevelDetailsApi, InvoiceSettingsApi, InvoicesApi, KeyManagementApi, KeyManagementPasswordApi, KeyManagementPgpApi, KeyManagementScmpApi, ManageWebhooksApi, MerchantBoardingApi, MicroformIntegrationApi, NetFundingsApi, NotificationOfChangesApi, PayerAuthenticationApi, PaymentBatchSummariesApi, PaymentInstrumentApi, PaymentsApi, PayoutsApi, PlansApi, PurchaseAndRefundDetailsApi, PushFundsApi, RefundApi, ReplayWebhooksApi, ReportDefinitionsApi, ReportDownloadsApi, ReportSubscriptionsApi, ReportsApi, RetrievalDetailsApi, RetrievalSummariesApi, ReversalApi, SearchTransactionsApi, SecureFileShareApi, SubscriptionsApi, SymmetricKeyManagementApi, TaxesApi, TokenApi, TransactionBatchesApi, TransactionDetailsApi, TransientTokenDataApi, UnifiedCheckoutCaptureContextApi, UserManagementApi, UserManagementSearchApi, VerificationApi, VoidApi, OAuthApi) { +}(function(ApiClient, Accountupdaterv1batchesIncluded, Accountupdaterv1batchesIncludedTokens, ActivateDeactivatePlanResponse, ActivateSubscriptionResponse, ActivateSubscriptionResponseSubscriptionInformation, AddNegativeListRequest, AuthReversalRequest, Boardingv1registrationsDocumentInformation, Boardingv1registrationsDocumentInformationSignedDocuments, Boardingv1registrationsIntegrationInformation, Boardingv1registrationsIntegrationInformationOauth2, Boardingv1registrationsIntegrationInformationTenantConfigurations, Boardingv1registrationsIntegrationInformationTenantInformation, Boardingv1registrationsOrganizationInformation, Boardingv1registrationsOrganizationInformationBusinessInformation, Boardingv1registrationsOrganizationInformationBusinessInformationAddress, Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact, Boardingv1registrationsOrganizationInformationKYC, Boardingv1registrationsOrganizationInformationKYCDepositBankAccount, Boardingv1registrationsOrganizationInformationOwners, Boardingv1registrationsProductInformation, Boardingv1registrationsProductInformationSelectedProducts, Boardingv1registrationsRegistrationInformation, Body, CancelSubscriptionResponse, CancelSubscriptionResponseSubscriptionInformation, CapturePaymentRequest, CardProcessingConfig, CardProcessingConfigCommon, CardProcessingConfigCommonAcquirer, CardProcessingConfigCommonCurrencies, CardProcessingConfigCommonCurrencies1, CardProcessingConfigCommonMerchantDescriptorInformation, CardProcessingConfigCommonPaymentTypes, CardProcessingConfigCommonProcessors, CardProcessingConfigFeatures, CardProcessingConfigFeaturesCardNotPresent, CardProcessingConfigFeaturesCardNotPresentInstallment, CardProcessingConfigFeaturesCardNotPresentPayouts, CardProcessingConfigFeaturesCardNotPresentPayoutsCurrencies, CardProcessingConfigFeaturesCardNotPresentProcessors, CardProcessingConfigFeaturesCardPresent, CardProcessingConfigFeaturesCardPresentProcessors, CaseManagementActionsRequest, CaseManagementCommentsRequest, CheckPayerAuthEnrollmentRequest, CommerceSolutionsProducts, CommerceSolutionsProductsAccountUpdater, CommerceSolutionsProductsAccountUpdaterConfigurationInformation, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurations, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsAmex, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsMasterCard, CommerceSolutionsProductsAccountUpdaterConfigurationInformationConfigurationsVisa, CommerceSolutionsProductsBinLookup, CommerceSolutionsProductsBinLookupConfigurationInformation, CommerceSolutionsProductsBinLookupConfigurationInformationConfigurations, CommerceSolutionsProductsTokenManagement, CommerceSolutionsProductsTokenManagementConfigurationInformation, CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations, CreateAdhocReportRequest, CreateBillingAgreement, CreateBundledDecisionManagerCaseRequest, CreateCreditRequest, CreateInvoiceRequest, CreateP12KeysRequest, CreatePaymentRequest, CreatePlanRequest, CreatePlanResponse, CreatePlanResponsePlanInformation, CreateReportSubscriptionRequest, CreateSearchRequest, CreateSessionReq, CreateSessionRequest, CreateSharedSecretKeysRequest, CreateSharedSecretKeysVerifiRequest, CreateSubscriptionRequest, CreateSubscriptionResponse, CreateSubscriptionResponseLinks, CreateSubscriptionResponseSubscriptionInformation, CreateWebhookRequest, DeleteBulkP12KeysRequest, DeleteBulkSymmetricKeysRequest, DeletePlanResponse, DmConfig, DmConfigOrganization, DmConfigPortfolioControls, DmConfigProcessingOptions, DmConfigThirdparty, DmConfigThirdpartyProvider, DmConfigThirdpartyProviderAccurint, DmConfigThirdpartyProviderAccurintCredentials, DmConfigThirdpartyProviderCredilink, DmConfigThirdpartyProviderCredilinkCredentials, DmConfigThirdpartyProviderEkata, DmConfigThirdpartyProviderEkataCredentials, DmConfigThirdpartyProviderEmailage, DmConfigThirdpartyProviderPerseuss, DmConfigThirdpartyProviderSignifyd, DmConfigThirdpartyProviderSignifydCredentials, DmConfigThirdpartyProviderTargus, DmConfigThirdpartyProviderTargusCredentials, ECheckConfig, ECheckConfigCommon, ECheckConfigCommonInternalOnly, ECheckConfigCommonInternalOnlyProcessors, ECheckConfigCommonProcessors, ECheckConfigFeatures, ECheckConfigFeaturesAccountValidationService, ECheckConfigFeaturesAccountValidationServiceInternalOnly, ECheckConfigFeaturesAccountValidationServiceInternalOnlyProcessors, ECheckConfigFeaturesAccountValidationServiceProcessors, ECheckConfigUnderwriting, FraudMarkingActionRequest, GenerateCaptureContextRequest, GenerateUnifiedCheckoutCaptureContextRequest, GetAllPlansResponse, GetAllPlansResponseLinks, GetAllPlansResponseOrderInformation, GetAllPlansResponseOrderInformationAmountDetails, GetAllPlansResponsePlanInformation, GetAllPlansResponsePlanInformationBillingCycles, GetAllPlansResponsePlanInformationBillingPeriod, GetAllPlansResponsePlans, GetAllSubscriptionsResponse, GetAllSubscriptionsResponseLinks, GetAllSubscriptionsResponseOrderInformation, GetAllSubscriptionsResponseOrderInformationBillTo, GetAllSubscriptionsResponsePaymentInformation, GetAllSubscriptionsResponsePaymentInformationCustomer, GetAllSubscriptionsResponsePlanInformation, GetAllSubscriptionsResponsePlanInformationBillingCycles, GetAllSubscriptionsResponseSubscriptionInformation, GetAllSubscriptionsResponseSubscriptions, GetPlanCodeResponse, GetPlanResponse, GetSubscriptionCodeResponse, GetSubscriptionResponse, IncrementAuthRequest, InlineResponse200, InlineResponse2001, InlineResponse2001Keys, InlineResponse2002, InlineResponse2002IntegrationInformation, InlineResponse2002IntegrationInformationTenantConfigurations, InlineResponse2003, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2006Embedded, InlineResponse2006EmbeddedBatches, InlineResponse2006EmbeddedLinks, InlineResponse2006EmbeddedLinksReports, InlineResponse2006EmbeddedTotals, InlineResponse2006Links, InlineResponse2007, InlineResponse2007Billing, InlineResponse2007Links, InlineResponse2007LinksReport, InlineResponse2008, InlineResponse2008Records, InlineResponse2008ResponseRecord, InlineResponse2008ResponseRecordAdditionalUpdates, InlineResponse2008SourceRecord, InlineResponse200Embedded, InlineResponse200EmbeddedCapture, InlineResponse200EmbeddedCaptureLinks, InlineResponse200EmbeddedCaptureLinksSelf, InlineResponse200EmbeddedReversal, InlineResponse200EmbeddedReversalLinks, InlineResponse200EmbeddedReversalLinksSelf, InlineResponse201, InlineResponse2011, InlineResponse2011IntegrationInformation, InlineResponse2011IntegrationInformationTenantConfigurations, InlineResponse2011OrganizationInformation, InlineResponse2011ProductInformationSetups, InlineResponse2011RegistrationInformation, InlineResponse2011Setups, InlineResponse2011SetupsCommerceSolutions, InlineResponse2011SetupsPayments, InlineResponse2011SetupsPaymentsCardProcessing, InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus, InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus, InlineResponse2011SetupsPaymentsDigitalPayments, InlineResponse2011SetupsRisk, InlineResponse2011SetupsValueAddedServices, InlineResponse2012, InlineResponse2012KeyInformation, InlineResponse2012KeyInformationErrorInformation, InlineResponse2012KeyInformationErrorInformationDetails, InlineResponse2013, InlineResponse2014, InlineResponse202, InlineResponse202Links, InlineResponse202LinksStatus, InlineResponse400, InlineResponse4001, InlineResponse4002, InlineResponse4003, InlineResponse4004, InlineResponse4004Fields, InlineResponse4005, InlineResponse4006, InlineResponse4007, InlineResponse4007Details, InlineResponse4008, InlineResponse4008Details, InlineResponse400Details, InlineResponse400Errors, InlineResponse401, InlineResponse401Fields, InlineResponse401Links, InlineResponse401LinksSelf, InlineResponse403, InlineResponse4031, InlineResponse403Errors, InlineResponse404, InlineResponse4041, InlineResponse4042, InlineResponse4042Details, InlineResponse409, InlineResponse409Errors, InlineResponse410, InlineResponse410Errors, InlineResponse412, InlineResponse412Errors, InlineResponse422, InlineResponse4221, InlineResponse424, InlineResponse424Errors, InlineResponse500, InlineResponse5001, InlineResponse5002, InlineResponse5003, InlineResponse500Errors, InlineResponse502, InlineResponse5021, InlineResponse503, InlineResponseDefault, InlineResponseDefaultLinks, InlineResponseDefaultLinksNext, InlineResponseDefaultResponseStatus, InlineResponseDefaultResponseStatusDetails, IntimateBillingAgreement, InvoiceSettingsRequest, InvoicingV2InvoiceSettingsGet200Response, InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation, InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle, InvoicingV2InvoicesAllGet200Response, InvoicingV2InvoicesAllGet200ResponseCustomerInformation, InvoicingV2InvoicesAllGet200ResponseInvoiceInformation, InvoicingV2InvoicesAllGet200ResponseInvoices, InvoicingV2InvoicesAllGet200ResponseLinks, InvoicingV2InvoicesAllGet200ResponseOrderInformation, InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails, InvoicingV2InvoicesAllGet400Response, InvoicingV2InvoicesAllGet404Response, InvoicingV2InvoicesAllGet502Response, InvoicingV2InvoicesGet200Response, InvoicingV2InvoicesGet200ResponseInvoiceHistory, InvoicingV2InvoicesGet200ResponseTransactionDetails, InvoicingV2InvoicesPost201Response, InvoicingV2InvoicesPost201ResponseInvoiceInformation, InvoicingV2InvoicesPost201ResponseOrderInformation, InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails, InvoicingV2InvoicesPost202Response, Invoicingv2invoiceSettingsInvoiceSettingsInformation, Invoicingv2invoicesCustomerInformation, Invoicingv2invoicesCustomerInformationCompany, Invoicingv2invoicesInvoiceInformation, Invoicingv2invoicesOrderInformation, Invoicingv2invoicesOrderInformationAmountDetails, Invoicingv2invoicesOrderInformationAmountDetailsFreight, Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails, Invoicingv2invoicesOrderInformationLineItems, Invoicingv2invoicesidInvoiceInformation, KmsV2KeysAsymDeletesPost200Response, KmsV2KeysAsymDeletesPost200ResponseKeyInformation, KmsV2KeysAsymGet200Response, KmsV2KeysAsymGet200ResponseKeyInformation, KmsV2KeysAsymPost201Response, KmsV2KeysAsymPost201ResponseCertificateInformation, KmsV2KeysAsymPost201ResponseKeyInformation, KmsV2KeysSymDeletesPost200Response, KmsV2KeysSymDeletesPost200ResponseKeyInformation, KmsV2KeysSymGet200Response, KmsV2KeysSymGet200ResponseKeyInformation, KmsV2KeysSymPost201Response, KmsV2KeysSymPost201ResponseErrorInformation, KmsV2KeysSymPost201ResponseKeyInformation, Kmsegressv2keysasymClientReferenceInformation, Kmsegressv2keysasymKeyInformation, Kmsegressv2keyssymClientReferenceInformation, Kmsegressv2keyssymKeyInformation, Kmsv2keysasymKeyInformation, Kmsv2keyssymClientReferenceInformation, Kmsv2keyssymKeyInformation, Kmsv2keyssymdeletesKeyInformation, Kmsv2keyssymverifiKeyInformation, MerchantInitiatedTransactionObject, Microformv2sessionsCheckoutApiInitialization, MitReversalRequest, MitVoidRequest, ModifyBillingAgreement, Notificationsubscriptionsv1productsorganizationIdEventTypes, Notificationsubscriptionsv1webhooksNotificationScope, Notificationsubscriptionsv1webhooksProducts, Notificationsubscriptionsv1webhooksRetryPolicy, Notificationsubscriptionsv1webhooksSecurityPolicy, Notificationsubscriptionsv1webhooksSecurityPolicy1, Notificationsubscriptionsv1webhooksSecurityPolicy1Config, Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig, Notificationsubscriptionsv1webhooksSecurityPolicyConfig, Nrtfv1webhookswebhookIdreplaysByDeliveryStatus, OctCreatePaymentRequest, OrderPaymentRequest, PatchCustomerPaymentInstrumentRequest, PatchCustomerRequest, PatchCustomerShippingAddressRequest, PatchInstrumentIdentifierRequest, PatchPaymentInstrumentRequest, PayerAuthConfig, PayerAuthConfigCardTypes, PayerAuthConfigCardTypesCB, PayerAuthConfigCardTypesJCBJSecure, PayerAuthConfigCardTypesVerifiedByVisa, PayerAuthConfigCardTypesVerifiedByVisaCurrencies, PayerAuthSetupRequest, PaymentInstrumentList, PaymentInstrumentList1, PaymentInstrumentList1Embedded, PaymentInstrumentList1EmbeddedEmbedded, PaymentInstrumentList1EmbeddedPaymentInstruments, PaymentInstrumentListEmbedded, PaymentInstrumentListLinks, PaymentInstrumentListLinksFirst, PaymentInstrumentListLinksLast, PaymentInstrumentListLinksNext, PaymentInstrumentListLinksPrev, PaymentInstrumentListLinksSelf, PaymentsProducts, PaymentsProductsCardPresentConnect, PaymentsProductsCardPresentConnectConfigurationInformation, PaymentsProductsCardPresentConnectConfigurationInformationConfigurations, PaymentsProductsCardPresentConnectSubscriptionInformation, PaymentsProductsCardProcessing, PaymentsProductsCardProcessingConfigurationInformation, PaymentsProductsCardProcessingSubscriptionInformation, PaymentsProductsCardProcessingSubscriptionInformationFeatures, PaymentsProductsCurrencyConversion, PaymentsProductsCurrencyConversionConfigurationInformation, PaymentsProductsCurrencyConversionConfigurationInformationConfigurations, PaymentsProductsCurrencyConversionConfigurationInformationConfigurationsProcessors, PaymentsProductsCybsReadyTerminal, PaymentsProductsDifferentialFee, PaymentsProductsDifferentialFeeSubscriptionInformation, PaymentsProductsDifferentialFeeSubscriptionInformationFeatures, PaymentsProductsDifferentialFeeSubscriptionInformationFeaturesSurcharge, PaymentsProductsDigitalPayments, PaymentsProductsDigitalPaymentsSubscriptionInformation, PaymentsProductsDigitalPaymentsSubscriptionInformationFeatures, PaymentsProductsECheck, PaymentsProductsECheckConfigurationInformation, PaymentsProductsECheckSubscriptionInformation, PaymentsProductsPayerAuthentication, PaymentsProductsPayerAuthenticationConfigurationInformation, PaymentsProductsPayerAuthenticationSubscriptionInformation, PaymentsProductsPayouts, PaymentsProductsPayoutsConfigurationInformation, PaymentsProductsPayoutsConfigurationInformationConfigurations, PaymentsProductsPayoutsConfigurationInformationConfigurationsProcessorAccount, PaymentsProductsPayoutsConfigurationInformationConfigurationsPullfunds, PaymentsProductsPayoutsConfigurationInformationConfigurationsPushfunds, PaymentsProductsSecureAcceptance, PaymentsProductsSecureAcceptanceConfigurationInformation, PaymentsProductsTax, PaymentsProductsVirtualTerminal, PaymentsProductsVirtualTerminalConfigurationInformation, PaymentsStrongAuthIssuerInformation, PostCustomerPaymentInstrumentRequest, PostCustomerRequest, PostCustomerShippingAddressRequest, PostInstrumentIdentifierEnrollmentRequest, PostInstrumentIdentifierRequest, PostPaymentCredentialsRequest, PostPaymentInstrumentRequest, PostRegistrationBody, PredefinedSubscriptionRequestBean, PtsV1TransactionBatchesGet200Response, PtsV1TransactionBatchesGet200ResponseLinks, PtsV1TransactionBatchesGet200ResponseLinksSelf, PtsV1TransactionBatchesGet200ResponseTransactionBatches, PtsV1TransactionBatchesGet400Response, PtsV1TransactionBatchesGet400ResponseErrorInformation, PtsV1TransactionBatchesGet400ResponseErrorInformationDetails, PtsV1TransactionBatchesGet500Response, PtsV1TransactionBatchesGet500ResponseErrorInformation, PtsV1TransactionBatchesIdGet200Response, PtsV1TransactionBatchesIdGet200ResponseLinks, PtsV1TransactionBatchesIdGet200ResponseLinksTransactions, PtsV2CreateBillingAgreementPost201Response, PtsV2CreateBillingAgreementPost201ResponseAgreementInformation, PtsV2CreateBillingAgreementPost201ResponseClientReferenceInformation, PtsV2CreateBillingAgreementPost201ResponseInstallmentInformation, PtsV2CreateBillingAgreementPost201ResponseLinks, PtsV2CreateBillingAgreementPost201ResponseProcessorInformation, PtsV2CreateBillingAgreementPost201ResponseRiskInformation, PtsV2CreateBillingAgreementPost201ResponseRiskInformationProcessorResults, PtsV2CreateBillingAgreementPost400Response, PtsV2CreateBillingAgreementPost502Response, PtsV2CreditsPost201Response, PtsV2CreditsPost201Response1, PtsV2CreditsPost201Response1ProcessorInformation, PtsV2CreditsPost201ResponseCreditAmountDetails, PtsV2CreditsPost201ResponsePaymentInformation, PtsV2CreditsPost201ResponseProcessingInformation, PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions, PtsV2IncrementalAuthorizationPatch201Response, PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation, PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation, PtsV2IncrementalAuthorizationPatch201ResponseLinks, PtsV2IncrementalAuthorizationPatch201ResponseOrderInformation, PtsV2IncrementalAuthorizationPatch201ResponseOrderInformationInvoiceDetails, PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformation, PtsV2IncrementalAuthorizationPatch201ResponsePaymentInformationAccountFeatures, PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation, PtsV2IncrementalAuthorizationPatch400Response, PtsV2ModifyBillingAgreementPost201Response, PtsV2ModifyBillingAgreementPost201ResponseAgreementInformation, PtsV2ModifyBillingAgreementPost201ResponseLinks, PtsV2ModifyBillingAgreementPost201ResponseOrderInformation, PtsV2ModifyBillingAgreementPost201ResponseOrderInformationBillTo, PtsV2ModifyBillingAgreementPost201ResponseOrderInformationShipTo, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformation, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationBank, PtsV2ModifyBillingAgreementPost201ResponsePaymentInformationEWallet, PtsV2PaymentsCapturesPost201Response, PtsV2PaymentsCapturesPost201ResponseLinks, PtsV2PaymentsCapturesPost201ResponseOrderInformation, PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsCapturesPost201ResponseOrderInformationInvoiceDetails, PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation, PtsV2PaymentsCapturesPost201ResponseProcessingInformation, PtsV2PaymentsCapturesPost201ResponseProcessorInformation, PtsV2PaymentsCapturesPost400Response, PtsV2PaymentsOrderPost201Response, PtsV2PaymentsOrderPost201ResponseBuyerInformation, PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification, PtsV2PaymentsOrderPost201ResponseOrderInformation, PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo, PtsV2PaymentsOrderPost201ResponseOrderInformationShipTo, PtsV2PaymentsOrderPost201ResponseOrderInformationShippingDetails, PtsV2PaymentsOrderPost201ResponsePaymentInformation, PtsV2PaymentsOrderPost201ResponsePaymentInformationEWallet, PtsV2PaymentsOrderPost201ResponseProcessingInformation, PtsV2PaymentsOrderPost201ResponseProcessorInformation, PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection, PtsV2PaymentsPost201Response, PtsV2PaymentsPost201Response1, PtsV2PaymentsPost201Response1OrderInformation, PtsV2PaymentsPost201Response1OrderInformationBillTo, PtsV2PaymentsPost201Response1OrderInformationShipTo, PtsV2PaymentsPost201Response1PaymentInformation, PtsV2PaymentsPost201Response1PaymentInformationBank, PtsV2PaymentsPost201Response1PaymentInformationBankAccount, PtsV2PaymentsPost201Response1PaymentInformationPaymentType, PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod, PtsV2PaymentsPost201Response1ProcessorInformation, PtsV2PaymentsPost201Response1ProcessorInformationAvs, PtsV2PaymentsPost201Response2, PtsV2PaymentsPost201Response2OrderInformation, PtsV2PaymentsPost201Response2OrderInformationAmountDetails, PtsV2PaymentsPost201Response2PaymentInformation, PtsV2PaymentsPost201Response2PaymentInformationEWallet, PtsV2PaymentsPost201Response2ProcessorInformation, PtsV2PaymentsPost201ResponseBuyerInformation, PtsV2PaymentsPost201ResponseClientReferenceInformation, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr, PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationStrongAuthentication, PtsV2PaymentsPost201ResponseEmbeddedActions, PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE, PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION, PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION, PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING, PtsV2PaymentsPost201ResponseErrorInformation, PtsV2PaymentsPost201ResponseErrorInformationDetails, PtsV2PaymentsPost201ResponseInstallmentInformation, PtsV2PaymentsPost201ResponseIssuerInformation, PtsV2PaymentsPost201ResponseLinks, PtsV2PaymentsPost201ResponseLinksSelf, PtsV2PaymentsPost201ResponseMerchantInformation, PtsV2PaymentsPost201ResponseMerchantInformationMerchantDescriptor, PtsV2PaymentsPost201ResponseOrderInformation, PtsV2PaymentsPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsPost201ResponseOrderInformationBillTo, PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails, PtsV2PaymentsPost201ResponseOrderInformationRewardPointsDetails, PtsV2PaymentsPost201ResponseOrderInformationShipTo, PtsV2PaymentsPost201ResponsePaymentAccountInformation, PtsV2PaymentsPost201ResponsePaymentAccountInformationCard, PtsV2PaymentsPost201ResponsePaymentInformation, PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures, PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances, PtsV2PaymentsPost201ResponsePaymentInformationBank, PtsV2PaymentsPost201ResponsePaymentInformationBankAccount, PtsV2PaymentsPost201ResponsePaymentInformationEWallet, PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier, PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard, PtsV2PaymentsPost201ResponsePaymentInsightsInformation, PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights, PtsV2PaymentsPost201ResponsePointOfSaleInformation, PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv, PtsV2PaymentsPost201ResponseProcessingInformation, PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions, PtsV2PaymentsPost201ResponseProcessorInformation, PtsV2PaymentsPost201ResponseProcessorInformationAchVerification, PtsV2PaymentsPost201ResponseProcessorInformationAvs, PtsV2PaymentsPost201ResponseProcessorInformationCardVerification, PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse, PtsV2PaymentsPost201ResponseProcessorInformationCustomer, PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults, PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice, PtsV2PaymentsPost201ResponseProcessorInformationRouting, PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection, PtsV2PaymentsPost201ResponseRiskInformation, PtsV2PaymentsPost201ResponseRiskInformationInfoCodes, PtsV2PaymentsPost201ResponseRiskInformationIpAddress, PtsV2PaymentsPost201ResponseRiskInformationProcessorResults, PtsV2PaymentsPost201ResponseRiskInformationProfile, PtsV2PaymentsPost201ResponseRiskInformationRules, PtsV2PaymentsPost201ResponseRiskInformationScore, PtsV2PaymentsPost201ResponseRiskInformationTravel, PtsV2PaymentsPost201ResponseRiskInformationTravelActualFinalDestination, PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDeparture, PtsV2PaymentsPost201ResponseRiskInformationTravelFirstDestination, PtsV2PaymentsPost201ResponseRiskInformationTravelLastDestination, PtsV2PaymentsPost201ResponseRiskInformationVelocity, PtsV2PaymentsPost201ResponseRiskInformationVelocityMorphing, PtsV2PaymentsPost201ResponseTokenInformation, PtsV2PaymentsPost201ResponseTokenInformationCustomer, PtsV2PaymentsPost201ResponseTokenInformationInstrumentIdentifier, PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument, PtsV2PaymentsPost201ResponseTokenInformationShippingAddress, PtsV2PaymentsPost201ResponseWatchlistScreeningInformation, PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList, PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchListMatches, PtsV2PaymentsPost400Response, PtsV2PaymentsPost502Response, PtsV2PaymentsRefundPost201Response, PtsV2PaymentsRefundPost201ResponseClientReferenceInformation, PtsV2PaymentsRefundPost201ResponseLinks, PtsV2PaymentsRefundPost201ResponseOrderInformation, PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsRefundPost201ResponseProcessorInformation, PtsV2PaymentsRefundPost201ResponseRefundAmountDetails, PtsV2PaymentsRefundPost400Response, PtsV2PaymentsReversalsPost201Response, PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation, PtsV2PaymentsReversalsPost201ResponseIssuerInformation, PtsV2PaymentsReversalsPost201ResponseProcessorInformation, PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails, PtsV2PaymentsReversalsPost400Response, PtsV2PaymentsVoidsPost201Response, PtsV2PaymentsVoidsPost201ResponseProcessorInformation, PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails, PtsV2PaymentsVoidsPost400Response, PtsV2PayoutsPost201Response, PtsV2PayoutsPost201ResponseErrorInformation, PtsV2PayoutsPost201ResponseIssuerInformation, PtsV2PayoutsPost201ResponseMerchantInformation, PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor, PtsV2PayoutsPost201ResponseOrderInformation, PtsV2PayoutsPost201ResponseOrderInformationAmountDetails, PtsV2PayoutsPost201ResponseProcessorInformation, PtsV2PayoutsPost201ResponseRecipientInformation, PtsV2PayoutsPost201ResponseRecipientInformationCard, PtsV2PayoutsPost400Response, Ptsv1pushfundstransferClientReferenceInformation, Ptsv1pushfundstransferOrderInformation, Ptsv1pushfundstransferOrderInformationAmountDetails, Ptsv1pushfundstransferProcessingInformation, Ptsv1pushfundstransferProcessingInformationPayoutsOptions, Ptsv1pushfundstransferRecipientInformation, Ptsv1pushfundstransferRecipientInformationPaymentInformation, Ptsv1pushfundstransferRecipientInformationPaymentInformationCard, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier, Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument, Ptsv1pushfundstransferRecipientInformationPersonalIdentification, Ptsv1pushfundstransferSenderInformation, Ptsv1pushfundstransferSenderInformationAccount, Ptsv1pushfundstransferSenderInformationPaymentInformation, Ptsv1pushfundstransferSenderInformationPaymentInformationCard, Ptsv1pushfundstransferSenderInformationPersonalIdentification, Ptsv2billingagreementsAggregatorInformation, Ptsv2billingagreementsAgreementInformation, Ptsv2billingagreementsBuyerInformation, Ptsv2billingagreementsClientReferenceInformation, Ptsv2billingagreementsConsumerAuthenticationInformation, Ptsv2billingagreementsDeviceInformation, Ptsv2billingagreementsInstallmentInformation, Ptsv2billingagreementsMerchantInformation, Ptsv2billingagreementsMerchantInformationMerchantDescriptor, Ptsv2billingagreementsOrderInformation, Ptsv2billingagreementsOrderInformationBillTo, Ptsv2billingagreementsPaymentInformation, Ptsv2billingagreementsPaymentInformationBank, Ptsv2billingagreementsPaymentInformationBankAccount, Ptsv2billingagreementsPaymentInformationCard, Ptsv2billingagreementsPaymentInformationPaymentType, Ptsv2billingagreementsPaymentInformationPaymentTypeMethod, Ptsv2billingagreementsPaymentInformationTokenizedCard, Ptsv2billingagreementsProcessingInformation, Ptsv2billingagreementsidAgreementInformation, Ptsv2billingagreementsidBuyerInformation, Ptsv2billingagreementsidProcessingInformation, Ptsv2creditsInstallmentInformation, Ptsv2creditsProcessingInformation, Ptsv2creditsProcessingInformationBankTransferOptions, Ptsv2creditsProcessingInformationElectronicBenefitsTransfer, Ptsv2creditsProcessingInformationJapanPaymentOptions, Ptsv2creditsProcessingInformationPurchaseOptions, Ptsv2creditsProcessingInformationRefundOptions, Ptsv2creditsRecipientInformation, Ptsv2creditsSenderInformation, Ptsv2creditsSenderInformationAccount, Ptsv2paymentreferencesAgreementInformation, Ptsv2paymentreferencesBuyerInformation, Ptsv2paymentreferencesDeviceInformation, Ptsv2paymentreferencesMerchantInformation, Ptsv2paymentreferencesOrderInformation, Ptsv2paymentreferencesOrderInformationAmountDetails, Ptsv2paymentreferencesOrderInformationBillTo, Ptsv2paymentreferencesOrderInformationInvoiceDetails, Ptsv2paymentreferencesOrderInformationLineItems, Ptsv2paymentreferencesOrderInformationShipTo, Ptsv2paymentreferencesPaymentInformation, Ptsv2paymentreferencesPaymentInformationBank, Ptsv2paymentreferencesPaymentInformationBankAccount, Ptsv2paymentreferencesPaymentInformationCard, Ptsv2paymentreferencesPaymentInformationEWallet, Ptsv2paymentreferencesPaymentInformationOptions, Ptsv2paymentreferencesProcessingInformation, Ptsv2paymentreferencesTravelInformation, Ptsv2paymentreferencesTravelInformationAutoRental, Ptsv2paymentreferencesUserInterface, Ptsv2paymentreferencesUserInterfaceColor, Ptsv2paymentreferencesidintentsOrderInformation, Ptsv2paymentreferencesidintentsPaymentInformation, Ptsv2paymentreferencesidintentsPaymentInformationEWallet, Ptsv2paymentreferencesidintentsProcessingInformation, Ptsv2paymentsAcquirerInformation, Ptsv2paymentsAggregatorInformation, Ptsv2paymentsAggregatorInformationSubMerchant, Ptsv2paymentsAgreementInformation, Ptsv2paymentsBuyerInformation, Ptsv2paymentsBuyerInformationPersonalIdentification, Ptsv2paymentsClientReferenceInformation, Ptsv2paymentsClientReferenceInformationPartner, Ptsv2paymentsConsumerAuthenticationInformation, Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication, Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation, Ptsv2paymentsDeviceInformation, Ptsv2paymentsDeviceInformationRawData, Ptsv2paymentsHealthCareInformation, Ptsv2paymentsHealthCareInformationAmountDetails, Ptsv2paymentsHostedPaymentInformation, Ptsv2paymentsHostedPaymentInformationUserAgent, Ptsv2paymentsInstallmentInformation, Ptsv2paymentsInvoiceDetails, Ptsv2paymentsIssuerInformation, Ptsv2paymentsMerchantDefinedInformation, Ptsv2paymentsMerchantDefinedSecureInformation, Ptsv2paymentsMerchantInformation, Ptsv2paymentsMerchantInformationMerchantDescriptor, Ptsv2paymentsMerchantInformationServiceFeeDescriptor, Ptsv2paymentsMerchantInformationServiceLocation, Ptsv2paymentsOrderInformation, Ptsv2paymentsOrderInformationAmountDetails, Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts, Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion, Ptsv2paymentsOrderInformationAmountDetailsOrder, Ptsv2paymentsOrderInformationAmountDetailsSurcharge, Ptsv2paymentsOrderInformationAmountDetailsTaxDetails, Ptsv2paymentsOrderInformationBillTo, Ptsv2paymentsOrderInformationBillToCompany, Ptsv2paymentsOrderInformationInvoiceDetails, Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum, Ptsv2paymentsOrderInformationLineItems, Ptsv2paymentsOrderInformationPassenger, Ptsv2paymentsOrderInformationShipTo, Ptsv2paymentsOrderInformationShippingDetails, Ptsv2paymentsPaymentInformation, Ptsv2paymentsPaymentInformationBank, Ptsv2paymentsPaymentInformationBankAccount, Ptsv2paymentsPaymentInformationCard, Ptsv2paymentsPaymentInformationCustomer, Ptsv2paymentsPaymentInformationDirectDebit, Ptsv2paymentsPaymentInformationDirectDebitMandate, Ptsv2paymentsPaymentInformationEWallet, Ptsv2paymentsPaymentInformationFluidData, Ptsv2paymentsPaymentInformationInstrumentIdentifier, Ptsv2paymentsPaymentInformationLegacyToken, Ptsv2paymentsPaymentInformationOptions, Ptsv2paymentsPaymentInformationPaymentInstrument, Ptsv2paymentsPaymentInformationPaymentType, Ptsv2paymentsPaymentInformationPaymentTypeMethod, Ptsv2paymentsPaymentInformationSepa, Ptsv2paymentsPaymentInformationSepaDirectDebit, Ptsv2paymentsPaymentInformationShippingAddress, Ptsv2paymentsPaymentInformationTokenizedCard, Ptsv2paymentsPointOfSaleInformation, Ptsv2paymentsPointOfSaleInformationEmv, Ptsv2paymentsProcessingInformation, Ptsv2paymentsProcessingInformationAuthorizationOptions, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, Ptsv2paymentsProcessingInformationBankTransferOptions, Ptsv2paymentsProcessingInformationCaptureOptions, Ptsv2paymentsProcessingInformationElectronicBenefitsTransfer, Ptsv2paymentsProcessingInformationJapanPaymentOptions, Ptsv2paymentsProcessingInformationLoanOptions, Ptsv2paymentsProcessingInformationPurchaseOptions, Ptsv2paymentsProcessingInformationRecurringOptions, Ptsv2paymentsProcessorInformation, Ptsv2paymentsProcessorInformationAuthorizationOptions, Ptsv2paymentsProcessorInformationReversal, Ptsv2paymentsPromotionInformation, Ptsv2paymentsRecipientInformation, Ptsv2paymentsRecurringPaymentInformation, Ptsv2paymentsRiskInformation, Ptsv2paymentsRiskInformationAuxiliaryData, Ptsv2paymentsRiskInformationBuyerHistory, Ptsv2paymentsRiskInformationBuyerHistoryAccountHistory, Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount, Ptsv2paymentsRiskInformationProfile, Ptsv2paymentsTokenInformation, Ptsv2paymentsTokenInformationPaymentInstrument, Ptsv2paymentsTokenInformationShippingAddress, Ptsv2paymentsTokenInformationTokenProvisioningInformation, Ptsv2paymentsTravelInformation, Ptsv2paymentsTravelInformationAgency, Ptsv2paymentsTravelInformationAutoRental, Ptsv2paymentsTravelInformationAutoRentalRentalAddress, Ptsv2paymentsTravelInformationAutoRentalReturnAddress, Ptsv2paymentsTravelInformationAutoRentalTaxDetails, Ptsv2paymentsTravelInformationLodging, Ptsv2paymentsTravelInformationLodgingRoom, Ptsv2paymentsTravelInformationTransit, Ptsv2paymentsTravelInformationTransitAirline, Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation, Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService, Ptsv2paymentsTravelInformationTransitAirlineLegs, Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer, Ptsv2paymentsTravelInformationVehicleData, Ptsv2paymentsWatchlistScreeningInformation, Ptsv2paymentsWatchlistScreeningInformationWeights, Ptsv2paymentsidClientReferenceInformation, Ptsv2paymentsidClientReferenceInformationPartner, Ptsv2paymentsidMerchantInformation, Ptsv2paymentsidOrderInformation, Ptsv2paymentsidOrderInformationAmountDetails, Ptsv2paymentsidProcessingInformation, Ptsv2paymentsidProcessingInformationAuthorizationOptions, Ptsv2paymentsidProcessingInformationAuthorizationOptionsInitiator, Ptsv2paymentsidTravelInformation, Ptsv2paymentsidcapturesAggregatorInformation, Ptsv2paymentsidcapturesAggregatorInformationSubMerchant, Ptsv2paymentsidcapturesBuyerInformation, Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification, Ptsv2paymentsidcapturesDeviceInformation, Ptsv2paymentsidcapturesInstallmentInformation, Ptsv2paymentsidcapturesMerchantInformation, Ptsv2paymentsidcapturesOrderInformation, Ptsv2paymentsidcapturesOrderInformationAmountDetails, Ptsv2paymentsidcapturesOrderInformationBillTo, Ptsv2paymentsidcapturesOrderInformationInvoiceDetails, Ptsv2paymentsidcapturesOrderInformationShipTo, Ptsv2paymentsidcapturesOrderInformationShippingDetails, Ptsv2paymentsidcapturesPaymentInformation, Ptsv2paymentsidcapturesPaymentInformationCard, Ptsv2paymentsidcapturesPaymentInformationPaymentType, Ptsv2paymentsidcapturesPaymentInformationPaymentTypeMethod, Ptsv2paymentsidcapturesPointOfSaleInformation, Ptsv2paymentsidcapturesPointOfSaleInformationEmv, Ptsv2paymentsidcapturesProcessingInformation, Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions, Ptsv2paymentsidcapturesProcessingInformationCaptureOptions, Ptsv2paymentsidrefundsClientReferenceInformation, Ptsv2paymentsidrefundsMerchantInformation, Ptsv2paymentsidrefundsOrderInformation, Ptsv2paymentsidrefundsOrderInformationLineItems, Ptsv2paymentsidrefundsPaymentInformation, Ptsv2paymentsidrefundsPaymentInformationBank, Ptsv2paymentsidrefundsPaymentInformationBankAccount, Ptsv2paymentsidrefundsPaymentInformationCard, Ptsv2paymentsidrefundsPaymentInformationEWallet, Ptsv2paymentsidrefundsPaymentInformationPaymentType, Ptsv2paymentsidrefundsPointOfSaleInformation, Ptsv2paymentsidrefundsProcessingInformation, Ptsv2paymentsidrefundsProcessingInformationRecurringOptions, Ptsv2paymentsidrefundsProcessingInformationRefundOptions, Ptsv2paymentsidreversalsClientReferenceInformation, Ptsv2paymentsidreversalsClientReferenceInformationPartner, Ptsv2paymentsidreversalsOrderInformation, Ptsv2paymentsidreversalsOrderInformationAmountDetails, Ptsv2paymentsidreversalsOrderInformationLineItems, Ptsv2paymentsidreversalsPaymentInformation, Ptsv2paymentsidreversalsPaymentInformationPaymentType, Ptsv2paymentsidreversalsPaymentInformationPaymentTypeMethod, Ptsv2paymentsidreversalsPointOfSaleInformation, Ptsv2paymentsidreversalsPointOfSaleInformationEmv, Ptsv2paymentsidreversalsProcessingInformation, Ptsv2paymentsidreversalsReversalInformation, Ptsv2paymentsidreversalsReversalInformationAmountDetails, Ptsv2paymentsidvoidsAgreementInformation, Ptsv2paymentsidvoidsMerchantInformation, Ptsv2paymentsidvoidsOrderInformation, Ptsv2paymentsidvoidsPaymentInformation, Ptsv2paymentsidvoidsProcessingInformation, Ptsv2payoutsClientReferenceInformation, Ptsv2payoutsMerchantInformation, Ptsv2payoutsMerchantInformationMerchantDescriptor, Ptsv2payoutsOrderInformation, Ptsv2payoutsOrderInformationAmountDetails, Ptsv2payoutsOrderInformationAmountDetailsSurcharge, Ptsv2payoutsOrderInformationBillTo, Ptsv2payoutsPaymentInformation, Ptsv2payoutsPaymentInformationCard, Ptsv2payoutsProcessingInformation, Ptsv2payoutsProcessingInformationFundingOptions, Ptsv2payoutsProcessingInformationFundingOptionsInitiator, Ptsv2payoutsProcessingInformationPayoutsOptions, Ptsv2payoutsRecipientInformation, Ptsv2payoutsSenderInformation, Ptsv2payoutsSenderInformationAccount, Ptsv2refreshpaymentstatusidAgreementInformation, Ptsv2refreshpaymentstatusidClientReferenceInformation, Ptsv2refreshpaymentstatusidPaymentInformation, Ptsv2refreshpaymentstatusidPaymentInformationCustomer, Ptsv2refreshpaymentstatusidPaymentInformationPaymentType, Ptsv2refreshpaymentstatusidProcessingInformation, Ptsv2voidsProcessingInformation, PushFunds201Response, PushFunds201ResponseClientReferenceInformation, PushFunds201ResponseErrorInformation, PushFunds201ResponseErrorInformationDetails, PushFunds201ResponseLinks, PushFunds201ResponseLinksCustomer, PushFunds201ResponseLinksInstrumentIdentifier, PushFunds201ResponseLinksPaymentInstrument, PushFunds201ResponseLinksSelf, PushFunds201ResponseMerchantInformation, PushFunds201ResponseMerchantInformationMerchantDescriptor, PushFunds201ResponseOrderInformation, PushFunds201ResponseOrderInformationAmountDetails, PushFunds201ResponseProcessorInformation, PushFunds201ResponseRecipientInformation, PushFunds201ResponseRecipientInformationCard, PushFunds400Response, PushFunds400ResponseDetails, PushFunds401Response, PushFunds404Response, PushFunds502Response, PushFundsRequest, Rbsv1plansClientReferenceInformation, Rbsv1plansOrderInformation, Rbsv1plansOrderInformationAmountDetails, Rbsv1plansPlanInformation, Rbsv1plansPlanInformationBillingCycles, Rbsv1plansidPlanInformation, Rbsv1plansidProcessingInformation, Rbsv1plansidProcessingInformationSubscriptionBillingOptions, Rbsv1subscriptionsClientReferenceInformation, Rbsv1subscriptionsPaymentInformation, Rbsv1subscriptionsPaymentInformationCustomer, Rbsv1subscriptionsPlanInformation, Rbsv1subscriptionsProcessingInformation, Rbsv1subscriptionsProcessingInformationAuthorizationOptions, Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator, Rbsv1subscriptionsSubscriptionInformation, Rbsv1subscriptionsidOrderInformation, Rbsv1subscriptionsidOrderInformationAmountDetails, Rbsv1subscriptionsidPlanInformation, Rbsv1subscriptionsidSubscriptionInformation, RefreshPaymentStatusRequest, RefundCaptureRequest, RefundPaymentRequest, ReplayWebhooksRequest, ReportingV3ChargebackDetailsGet200Response, ReportingV3ChargebackDetailsGet200ResponseChargebackDetails, ReportingV3ChargebackSummariesGet200Response, ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries, ReportingV3ConversionDetailsGet200Response, ReportingV3ConversionDetailsGet200ResponseConversionDetails, ReportingV3ConversionDetailsGet200ResponseNotes, ReportingV3InterchangeClearingLevelDetailsGet200Response, ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails, ReportingV3NetFundingsGet200Response, ReportingV3NetFundingsGet200ResponseNetFundingSummaries, ReportingV3NetFundingsGet200ResponseTotalPurchases, ReportingV3NotificationofChangesGet200Response, ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges, ReportingV3PaymentBatchSummariesGet200Response, ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries, ReportingV3PurchaseRefundDetailsGet200Response, ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations, ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails, ReportingV3PurchaseRefundDetailsGet200ResponseOthers, ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails, ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses, ReportingV3PurchaseRefundDetailsGet200ResponseSettlements, ReportingV3ReportDefinitionsGet200Response, ReportingV3ReportDefinitionsGet200ResponseReportDefinitions, ReportingV3ReportDefinitionsNameGet200Response, ReportingV3ReportDefinitionsNameGet200ResponseAttributes, ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings, ReportingV3ReportSubscriptionsGet200Response, ReportingV3ReportSubscriptionsGet200ResponseSubscriptions, ReportingV3ReportsGet200Response, ReportingV3ReportsGet200ResponseLink, ReportingV3ReportsGet200ResponseLinkReportDownload, ReportingV3ReportsGet200ResponseReportSearchResults, ReportingV3ReportsIdGet200Response, ReportingV3RetrievalDetailsGet200Response, ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails, ReportingV3RetrievalSummariesGet200Response, Reportingv3ReportDownloadsGet400Response, Reportingv3ReportDownloadsGet400ResponseDetails, Reportingv3reportsReportFilters, Reportingv3reportsReportPreferences, RiskProducts, RiskProductsDecisionManager, RiskProductsDecisionManagerConfigurationInformation, RiskProductsFraudManagementEssentials, RiskProductsFraudManagementEssentialsConfigurationInformation, RiskV1AddressVerificationsPost201Response, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress, RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1, RiskV1AddressVerificationsPost201ResponseErrorInformation, RiskV1AuthenticationResultsPost201Response, RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationSetupsPost201Response, RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationSetupsPost201ResponseErrorInformation, RiskV1AuthenticationsPost201Response, RiskV1AuthenticationsPost201ResponseErrorInformation, RiskV1AuthenticationsPost400Response, RiskV1AuthenticationsPost400Response1, RiskV1DecisionsPost201Response, RiskV1DecisionsPost201ResponseClientReferenceInformation, RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation, RiskV1DecisionsPost201ResponseErrorInformation, RiskV1DecisionsPost201ResponseOrderInformation, RiskV1DecisionsPost201ResponseOrderInformationAmountDetails, RiskV1DecisionsPost201ResponsePaymentInformation, RiskV1DecisionsPost400Response, RiskV1DecisionsPost400Response1, RiskV1ExportComplianceInquiriesPost201Response, RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation, RiskV1UpdatePost201Response, Riskv1addressverificationsBuyerInformation, Riskv1addressverificationsOrderInformation, Riskv1addressverificationsOrderInformationBillTo, Riskv1addressverificationsOrderInformationLineItems, Riskv1addressverificationsOrderInformationShipTo, Riskv1authenticationresultsConsumerAuthenticationInformation, Riskv1authenticationresultsDeviceInformation, Riskv1authenticationresultsOrderInformation, Riskv1authenticationresultsOrderInformationAmountDetails, Riskv1authenticationresultsPaymentInformation, Riskv1authenticationresultsPaymentInformationCard, Riskv1authenticationresultsPaymentInformationFluidData, Riskv1authenticationresultsPaymentInformationTokenizedCard, Riskv1authenticationsBuyerInformation, Riskv1authenticationsDeviceInformation, Riskv1authenticationsOrderInformation, Riskv1authenticationsOrderInformationAmountDetails, Riskv1authenticationsOrderInformationBillTo, Riskv1authenticationsOrderInformationLineItems, Riskv1authenticationsPaymentInformation, Riskv1authenticationsPaymentInformationCard, Riskv1authenticationsPaymentInformationTokenizedCard, Riskv1authenticationsRiskInformation, Riskv1authenticationsTravelInformation, Riskv1authenticationsetupsPaymentInformation, Riskv1authenticationsetupsPaymentInformationCard, Riskv1authenticationsetupsPaymentInformationCustomer, Riskv1authenticationsetupsPaymentInformationFluidData, Riskv1authenticationsetupsPaymentInformationTokenizedCard, Riskv1authenticationsetupsProcessingInformation, Riskv1authenticationsetupsTokenInformation, Riskv1decisionsAcquirerInformation, Riskv1decisionsBuyerInformation, Riskv1decisionsClientReferenceInformation, Riskv1decisionsClientReferenceInformationPartner, Riskv1decisionsConsumerAuthenticationInformation, Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication, Riskv1decisionsDeviceInformation, Riskv1decisionsMerchantDefinedInformation, Riskv1decisionsMerchantInformation, Riskv1decisionsMerchantInformationMerchantDescriptor, Riskv1decisionsOrderInformation, Riskv1decisionsOrderInformationAmountDetails, Riskv1decisionsOrderInformationBillTo, Riskv1decisionsOrderInformationLineItems, Riskv1decisionsOrderInformationShipTo, Riskv1decisionsOrderInformationShippingDetails, Riskv1decisionsPaymentInformation, Riskv1decisionsPaymentInformationCard, Riskv1decisionsPaymentInformationTokenizedCard, Riskv1decisionsProcessingInformation, Riskv1decisionsProcessorInformation, Riskv1decisionsProcessorInformationAvs, Riskv1decisionsProcessorInformationCardVerification, Riskv1decisionsRiskInformation, Riskv1decisionsTokenInformation, Riskv1decisionsTravelInformation, Riskv1decisionsTravelInformationLegs, Riskv1decisionsTravelInformationPassengers, Riskv1decisionsidactionsDecisionInformation, Riskv1decisionsidactionsProcessingInformation, Riskv1decisionsidmarkingRiskInformation, Riskv1decisionsidmarkingRiskInformationMarkingDetails, Riskv1exportcomplianceinquiriesDeviceInformation, Riskv1exportcomplianceinquiriesExportComplianceInformation, Riskv1exportcomplianceinquiriesOrderInformation, Riskv1exportcomplianceinquiriesOrderInformationBillTo, Riskv1exportcomplianceinquiriesOrderInformationBillToCompany, Riskv1exportcomplianceinquiriesOrderInformationLineItems, Riskv1exportcomplianceinquiriesOrderInformationShipTo, Riskv1liststypeentriesBuyerInformation, Riskv1liststypeentriesClientReferenceInformation, Riskv1liststypeentriesDeviceInformation, Riskv1liststypeentriesOrderInformation, Riskv1liststypeentriesOrderInformationAddress, Riskv1liststypeentriesOrderInformationBillTo, Riskv1liststypeentriesOrderInformationLineItems, Riskv1liststypeentriesOrderInformationShipTo, Riskv1liststypeentriesPaymentInformation, Riskv1liststypeentriesPaymentInformationBank, Riskv1liststypeentriesPaymentInformationCard, Riskv1liststypeentriesRiskInformation, Riskv1liststypeentriesRiskInformationMarkingDetails, SAConfig, SAConfigCheckout, SAConfigContactInformation, SAConfigNotifications, SAConfigNotificationsCustomerNotifications, SAConfigNotificationsMerchantNotifications, SAConfigPaymentMethods, SAConfigPaymentTypes, SAConfigPaymentTypesCardTypes, SAConfigPaymentTypesCardTypesDiscover, SAConfigService, SaveAsymEgressKey, SaveSymEgressKey, SearchRequest, ShippingAddressListForCustomer, ShippingAddressListForCustomerEmbedded, ShippingAddressListForCustomerLinks, ShippingAddressListForCustomerLinksFirst, ShippingAddressListForCustomerLinksLast, ShippingAddressListForCustomerLinksNext, ShippingAddressListForCustomerLinksPrev, ShippingAddressListForCustomerLinksSelf, SuspendSubscriptionResponse, SuspendSubscriptionResponseSubscriptionInformation, TaxRequest, TmsAuthorizationOptions, TmsAuthorizationOptionsInitiator, TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction, TmsEmbeddedInstrumentIdentifier, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments, TmsEmbeddedInstrumentIdentifierLinksSelf, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard, TmsEmbeddedInstrumentIdentifierTokenizedCardCard, TmsPaymentInstrumentProcessingInfo, TmsPaymentInstrumentProcessingInfoBankTransferOptions, Tmsv2customersBuyerInformation, Tmsv2customersClientReferenceInformation, Tmsv2customersDefaultPaymentInstrument, Tmsv2customersDefaultShippingAddress, Tmsv2customersEmbedded, Tmsv2customersEmbeddedDefaultPaymentInstrument, Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount, Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy, Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification, Tmsv2customersEmbeddedDefaultPaymentInstrumentCard, Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded, Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier, Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks, Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf, Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation, Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor, Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata, Tmsv2customersEmbeddedDefaultShippingAddress, Tmsv2customersEmbeddedDefaultShippingAddressLinks, Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer, Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf, Tmsv2customersEmbeddedDefaultShippingAddressMetadata, Tmsv2customersEmbeddedDefaultShippingAddressShipTo, Tmsv2customersLinks, Tmsv2customersLinksPaymentInstruments, Tmsv2customersLinksSelf, Tmsv2customersLinksShippingAddress, Tmsv2customersMerchantDefinedInformation, Tmsv2customersMetadata, Tmsv2customersObjectInformation, TssV2GetEmvTags200Response, TssV2GetEmvTags200ResponseEmvTagBreakdownList, TssV2PostEmvTags200Response, TssV2PostEmvTags200ResponseEmvTagBreakdownList, TssV2PostEmvTags200ResponseParsedEMVTagsList, TssV2TransactionsGet200Response, TssV2TransactionsGet200ResponseApplicationInformation, TssV2TransactionsGet200ResponseApplicationInformationApplications, TssV2TransactionsGet200ResponseBuyerInformation, TssV2TransactionsGet200ResponseClientReferenceInformation, TssV2TransactionsGet200ResponseClientReferenceInformationPartner, TssV2TransactionsGet200ResponseConsumerAuthenticationInformation, TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication, TssV2TransactionsGet200ResponseDeviceInformation, TssV2TransactionsGet200ResponseErrorInformation, TssV2TransactionsGet200ResponseFraudMarkingInformation, TssV2TransactionsGet200ResponseInstallmentInformation, TssV2TransactionsGet200ResponseLinks, TssV2TransactionsGet200ResponseMerchantInformation, TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor, TssV2TransactionsGet200ResponseOrderInformation, TssV2TransactionsGet200ResponseOrderInformationAmountDetails, TssV2TransactionsGet200ResponseOrderInformationBillTo, TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails, TssV2TransactionsGet200ResponseOrderInformationLineItems, TssV2TransactionsGet200ResponseOrderInformationShipTo, TssV2TransactionsGet200ResponseOrderInformationShippingDetails, TssV2TransactionsGet200ResponsePaymentInformation, TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures, TssV2TransactionsGet200ResponsePaymentInformationBank, TssV2TransactionsGet200ResponsePaymentInformationBankAccount, TssV2TransactionsGet200ResponsePaymentInformationBankMandate, TssV2TransactionsGet200ResponsePaymentInformationBrands, TssV2TransactionsGet200ResponsePaymentInformationCard, TssV2TransactionsGet200ResponsePaymentInformationCustomer, TssV2TransactionsGet200ResponsePaymentInformationFeatures, TssV2TransactionsGet200ResponsePaymentInformationFluidData, TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier, TssV2TransactionsGet200ResponsePaymentInformationInvoice, TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation, TssV2TransactionsGet200ResponsePaymentInformationNetwork, TssV2TransactionsGet200ResponsePaymentInformationPaymentType, TssV2TransactionsGet200ResponsePayoutOptions, TssV2TransactionsGet200ResponsePointOfSaleInformation, TssV2TransactionsGet200ResponseProcessingInformation, TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions, TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator, TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions, TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions, TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions, TssV2TransactionsGet200ResponseProcessorInformation, TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults, TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting, TssV2TransactionsGet200ResponseProcessorInformationProcessor, TssV2TransactionsGet200ResponseRecurringPaymentInformation, TssV2TransactionsGet200ResponseRiskInformation, TssV2TransactionsGet200ResponseRiskInformationProfile, TssV2TransactionsGet200ResponseRiskInformationRules, TssV2TransactionsGet200ResponseRiskInformationScore, TssV2TransactionsGet200ResponseSenderInformation, TssV2TransactionsGet200ResponseTokenInformation, TssV2TransactionsGet200ResponseUnscheduledPaymentInformation, TssV2TransactionsPost201Response, TssV2TransactionsPost201ResponseEmbedded, TssV2TransactionsPost201ResponseEmbeddedApplicationInformation, TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications, TssV2TransactionsPost201ResponseEmbeddedBuyerInformation, TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation, TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner, TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation, TssV2TransactionsPost201ResponseEmbeddedErrorInformation, TssV2TransactionsPost201ResponseEmbeddedLinks, TssV2TransactionsPost201ResponseEmbeddedMerchantInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo, TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo, TssV2TransactionsPost201ResponseEmbeddedPaymentInformation, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType, TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation, TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner, TssV2TransactionsPost201ResponseEmbeddedProcessingInformation, TssV2TransactionsPost201ResponseEmbeddedProcessorInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint, TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries, TssV2TransactionsPost400Response, Tssv2transactionsemvTagDetailsEmvDetailsList, UmsV1UsersGet200Response, UmsV1UsersGet200ResponseAccountInformation, UmsV1UsersGet200ResponseContactInformation, UmsV1UsersGet200ResponseOrganizationInformation, UmsV1UsersGet200ResponseUsers, UpdateAsymKeysRequest, UpdateInvoiceRequest, UpdatePGPKeysRequest, UpdatePGPKeysRequest1, UpdatePasswordKeysRequest, UpdatePlanRequest, UpdatePlanResponse, UpdatePlanResponsePlanInformation, UpdateSubscription, UpdateSubscriptionResponse, UpdateWebhookRequest, Upv1capturecontextsCaptureMandate, Upv1capturecontextsCheckoutApiInitialization, Upv1capturecontextsOrderInformation, Upv1capturecontextsOrderInformationAmountDetails, Upv1capturecontextsOrderInformationBillTo, Upv1capturecontextsOrderInformationBillToCompany, Upv1capturecontextsOrderInformationShipTo, V1FileDetailsGet200Response, V1FileDetailsGet200ResponseFileDetails, V1FileDetailsGet200ResponseLinks, V1FileDetailsGet200ResponseLinksFiles, V1FileDetailsGet200ResponseLinksSelf, VTConfig, VTConfigCardNotPresent, VTConfigCardNotPresentGlobalPaymentInformation, VTConfigCardNotPresentGlobalPaymentInformationBasicInformation, VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields, VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation, VTConfigCardNotPresentReceiptInformation, VTConfigCardNotPresentReceiptInformationEmailReceipt, VTConfigCardNotPresentReceiptInformationHeader, VTConfigCardNotPresentReceiptInformationOrderInformation, ValidateExportComplianceRequest, ValidateRequest, ValueAddedServicesProducts, VasV2PaymentsPost201Response, VasV2PaymentsPost201ResponseLinks, VasV2PaymentsPost201ResponseOrderInformation, VasV2PaymentsPost201ResponseOrderInformationJurisdiction, VasV2PaymentsPost201ResponseOrderInformationLineItems, VasV2PaymentsPost201ResponseOrderInformationTaxDetails, VasV2PaymentsPost201ResponseTaxInformation, VasV2PaymentsPost400Response, VasV2TaxVoid200Response, VasV2TaxVoid200ResponseVoidAmountDetails, VasV2TaxVoidsPost400Response, Vasv2taxBuyerInformation, Vasv2taxClientReferenceInformation, Vasv2taxMerchantInformation, Vasv2taxOrderInformation, Vasv2taxOrderInformationBillTo, Vasv2taxOrderInformationInvoiceDetails, Vasv2taxOrderInformationLineItems, Vasv2taxOrderInformationOrderAcceptance, Vasv2taxOrderInformationOrderOrigin, Vasv2taxOrderInformationShipTo, Vasv2taxOrderInformationShippingDetails, Vasv2taxTaxInformation, Vasv2taxidClientReferenceInformation, Vasv2taxidClientReferenceInformationPartner, VerifyCustomerAddressRequest, VoidCaptureRequest, VoidCreditRequest, VoidPaymentRequest, VoidRefundRequest, VoidTaxRequest, AccessTokenResponse, BadRequestError, CreateAccessTokenRequest, ResourceNotFoundError, UnauthorizedClientError, AsymmetricKeyManagementApi, BatchesApi, BillingAgreementsApi, CaptureApi, ChargebackDetailsApi, ChargebackSummariesApi, ConversionDetailsApi, CreateNewWebhooksApi, CreditApi, CustomerApi, CustomerPaymentInstrumentApi, CustomerShippingAddressApi, DecisionManagerApi, DownloadDTDApi, DownloadXSDApi, EMVTagDetailsApi, InstrumentIdentifierApi, InterchangeClearingLevelDetailsApi, InvoiceSettingsApi, InvoicesApi, KeyManagementApi, KeyManagementPasswordApi, KeyManagementPgpApi, KeyManagementScmpApi, ManageWebhooksApi, MerchantBoardingApi, MicroformIntegrationApi, NetFundingsApi, NotificationOfChangesApi, PayerAuthenticationApi, PaymentBatchSummariesApi, PaymentInstrumentApi, PaymentsApi, PayoutsApi, PlansApi, PurchaseAndRefundDetailsApi, PushFundsApi, RefundApi, ReplayWebhooksApi, ReportDefinitionsApi, ReportDownloadsApi, ReportSubscriptionsApi, ReportsApi, RetrievalDetailsApi, RetrievalSummariesApi, ReversalApi, SearchTransactionsApi, SecureFileShareApi, SubscriptionsApi, SymmetricKeyManagementApi, TaxesApi, TokenApi, TransactionBatchesApi, TransactionDetailsApi, TransientTokenDataApi, UnifiedCheckoutCaptureContextApi, UserManagementApi, UserManagementSearchApi, VerificationApi, VoidApi, OAuthApi) { 'use strict'; /** @@ -2956,36 +2956,11 @@ * @property {module:model/PtsV2PayoutsPost400Response} */ PtsV2PayoutsPost400Response: PtsV2PayoutsPost400Response, - /** - * The Ptsv1pushfundstransferAggregatorInformation model constructor. - * @property {module:model/Ptsv1pushfundstransferAggregatorInformation} - */ - Ptsv1pushfundstransferAggregatorInformation: Ptsv1pushfundstransferAggregatorInformation, - /** - * The Ptsv1pushfundstransferAggregatorInformationSubMerchant model constructor. - * @property {module:model/Ptsv1pushfundstransferAggregatorInformationSubMerchant} - */ - Ptsv1pushfundstransferAggregatorInformationSubMerchant: Ptsv1pushfundstransferAggregatorInformationSubMerchant, /** * The Ptsv1pushfundstransferClientReferenceInformation model constructor. * @property {module:model/Ptsv1pushfundstransferClientReferenceInformation} */ Ptsv1pushfundstransferClientReferenceInformation: Ptsv1pushfundstransferClientReferenceInformation, - /** - * The Ptsv1pushfundstransferMerchantDefinedInformation model constructor. - * @property {module:model/Ptsv1pushfundstransferMerchantDefinedInformation} - */ - Ptsv1pushfundstransferMerchantDefinedInformation: Ptsv1pushfundstransferMerchantDefinedInformation, - /** - * The Ptsv1pushfundstransferMerchantInformation model constructor. - * @property {module:model/Ptsv1pushfundstransferMerchantInformation} - */ - Ptsv1pushfundstransferMerchantInformation: Ptsv1pushfundstransferMerchantInformation, - /** - * The Ptsv1pushfundstransferMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor} - */ - Ptsv1pushfundstransferMerchantInformationMerchantDescriptor: Ptsv1pushfundstransferMerchantInformationMerchantDescriptor, /** * The Ptsv1pushfundstransferOrderInformation model constructor. * @property {module:model/Ptsv1pushfundstransferOrderInformation} @@ -2996,16 +2971,6 @@ * @property {module:model/Ptsv1pushfundstransferOrderInformationAmountDetails} */ Ptsv1pushfundstransferOrderInformationAmountDetails: Ptsv1pushfundstransferOrderInformationAmountDetails, - /** - * The Ptsv1pushfundstransferOrderInformationSurcharge model constructor. - * @property {module:model/Ptsv1pushfundstransferOrderInformationSurcharge} - */ - Ptsv1pushfundstransferOrderInformationSurcharge: Ptsv1pushfundstransferOrderInformationSurcharge, - /** - * The Ptsv1pushfundstransferPointOfServiceInformation model constructor. - * @property {module:model/Ptsv1pushfundstransferPointOfServiceInformation} - */ - Ptsv1pushfundstransferPointOfServiceInformation: Ptsv1pushfundstransferPointOfServiceInformation, /** * The Ptsv1pushfundstransferProcessingInformation model constructor. * @property {module:model/Ptsv1pushfundstransferProcessingInformation} @@ -3016,26 +2981,6 @@ * @property {module:model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions} */ Ptsv1pushfundstransferProcessingInformationPayoutsOptions: Ptsv1pushfundstransferProcessingInformationPayoutsOptions, - /** - * The Ptsv1pushfundstransferProcessingInformationRecurringOptions model constructor. - * @property {module:model/Ptsv1pushfundstransferProcessingInformationRecurringOptions} - */ - Ptsv1pushfundstransferProcessingInformationRecurringOptions: Ptsv1pushfundstransferProcessingInformationRecurringOptions, - /** - * The Ptsv1pushfundstransferProcessingOptions model constructor. - * @property {module:model/Ptsv1pushfundstransferProcessingOptions} - */ - Ptsv1pushfundstransferProcessingOptions: Ptsv1pushfundstransferProcessingOptions, - /** - * The Ptsv1pushfundstransferProcessingOptionsFundingOptions model constructor. - * @property {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptions} - */ - Ptsv1pushfundstransferProcessingOptionsFundingOptions: Ptsv1pushfundstransferProcessingOptionsFundingOptions, - /** - * The Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator model constructor. - * @property {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator} - */ - Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator: Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator, /** * The Ptsv1pushfundstransferRecipientInformation model constructor. * @property {module:model/Ptsv1pushfundstransferRecipientInformation} @@ -3821,6 +3766,11 @@ * @property {module:model/Ptsv2paymentsTokenInformationShippingAddress} */ Ptsv2paymentsTokenInformationShippingAddress: Ptsv2paymentsTokenInformationShippingAddress, + /** + * The Ptsv2paymentsTokenInformationTokenProvisioningInformation model constructor. + * @property {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} + */ + Ptsv2paymentsTokenInformationTokenProvisioningInformation: Ptsv2paymentsTokenInformationTokenProvisioningInformation, /** * The Ptsv2paymentsTravelInformation model constructor. * @property {module:model/Ptsv2paymentsTravelInformation} @@ -5541,11 +5491,6 @@ * @property {module:model/TmsEmbeddedInstrumentIdentifierProcessingInformation} */ TmsEmbeddedInstrumentIdentifierProcessingInformation: TmsEmbeddedInstrumentIdentifierProcessingInformation, - /** - * The TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation model constructor. - * @property {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} - */ - TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation: TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, /** * The TmsEmbeddedInstrumentIdentifierTokenizedCard model constructor. * @property {module:model/TmsEmbeddedInstrumentIdentifierTokenizedCard} diff --git a/src/model/GetAllPlansResponseOrderInformationAmountDetails.js b/src/model/GetAllPlansResponseOrderInformationAmountDetails.js index fa1e7f1a..4348b06a 100644 --- a/src/model/GetAllPlansResponseOrderInformationAmountDetails.js +++ b/src/model/GetAllPlansResponseOrderInformationAmountDetails.js @@ -77,7 +77,7 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js b/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js index a3be978f..e64a85c2 100644 --- a/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js +++ b/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js @@ -134,7 +134,7 @@ */ exports.prototype['deliveryLanguage'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} defaultCurrencyCode */ exports.prototype['defaultCurrencyCode'] = undefined; diff --git a/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js b/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js index e33d636f..dee6d1cb 100644 --- a/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js +++ b/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js @@ -78,7 +78,7 @@ */ exports.prototype['name'] = undefined; /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; diff --git a/src/model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.js b/src/model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.js index e73ac036..88fa4082 100644 --- a/src/model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.js +++ b/src/model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.js @@ -74,12 +74,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/InvoicingV2InvoicesGet200ResponseTransactionDetails.js b/src/model/InvoicingV2InvoicesGet200ResponseTransactionDetails.js index 1b10f8a4..acbeaaaa 100644 --- a/src/model/InvoicingV2InvoicesGet200ResponseTransactionDetails.js +++ b/src/model/InvoicingV2InvoicesGet200ResponseTransactionDetails.js @@ -79,7 +79,7 @@ */ exports.prototype['transactionId'] = undefined; /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} amount */ exports.prototype['amount'] = undefined; diff --git a/src/model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.js b/src/model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.js index 7b323c1d..4eb2bcc5 100644 --- a/src/model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.js @@ -102,12 +102,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js b/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js index c85a1055..ad4a975c 100644 --- a/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js +++ b/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js @@ -134,7 +134,7 @@ */ exports.prototype['deliveryLanguage'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} defaultCurrencyCode */ exports.prototype['defaultCurrencyCode'] = undefined; diff --git a/src/model/Invoicingv2invoicesCustomerInformation.js b/src/model/Invoicingv2invoicesCustomerInformation.js index a1949bbe..008d4421 100644 --- a/src/model/Invoicingv2invoicesCustomerInformation.js +++ b/src/model/Invoicingv2invoicesCustomerInformation.js @@ -87,12 +87,12 @@ */ exports.prototype['name'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; diff --git a/src/model/Invoicingv2invoicesCustomerInformationCompany.js b/src/model/Invoicingv2invoicesCustomerInformationCompany.js index f3455ece..51e8de31 100644 --- a/src/model/Invoicingv2invoicesCustomerInformationCompany.js +++ b/src/model/Invoicingv2invoicesCustomerInformationCompany.js @@ -69,7 +69,7 @@ } /** - * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @member {String} name */ exports.prototype['name'] = undefined; diff --git a/src/model/Invoicingv2invoicesOrderInformationAmountDetails.js b/src/model/Invoicingv2invoicesOrderInformationAmountDetails.js index 41da2cbf..270b1c90 100644 --- a/src/model/Invoicingv2invoicesOrderInformationAmountDetails.js +++ b/src/model/Invoicingv2invoicesOrderInformationAmountDetails.js @@ -98,12 +98,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js b/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js index 55ab1eb0..28fb5471 100644 --- a/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js +++ b/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js @@ -78,7 +78,7 @@ } /** - * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. * @member {String} amount */ exports.prototype['amount'] = undefined; diff --git a/src/model/Kmsv2keyssymClientReferenceInformation.js b/src/model/Kmsv2keyssymClientReferenceInformation.js index c52e9bb1..95687a17 100644 --- a/src/model/Kmsv2keyssymClientReferenceInformation.js +++ b/src/model/Kmsv2keyssymClientReferenceInformation.js @@ -82,7 +82,7 @@ */ exports.prototype['code'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/PatchInstrumentIdentifierRequest.js b/src/model/PatchInstrumentIdentifierRequest.js index cb2876d5..d34b23ed 100644 --- a/src/model/PatchInstrumentIdentifierRequest.js +++ b/src/model/PatchInstrumentIdentifierRequest.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); + define(['ApiClient', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); + module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.PatchInstrumentIdentifierRequest = factory(root.CyberSource.ApiClient, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); + root.CyberSource.PatchInstrumentIdentifierRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); } -}(this, function(ApiClient, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { +}(this, function(ApiClient, Ptsv2paymentsTokenInformationTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { 'use strict'; @@ -89,7 +89,7 @@ obj['type'] = ApiClient.convertToType(data['type'], 'String'); } if (data.hasOwnProperty('tokenProvisioningInformation')) { - obj['tokenProvisioningInformation'] = TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); + obj['tokenProvisioningInformation'] = Ptsv2paymentsTokenInformationTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); } if (data.hasOwnProperty('card')) { obj['card'] = TmsEmbeddedInstrumentIdentifierCard.constructFromObject(data['card']); @@ -136,12 +136,12 @@ */ exports.prototype['state'] = undefined; /** - * The type of Instrument Identifier. Possible Values: - enrollable card + * The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @member {String} type */ exports.prototype['type'] = undefined; /** - * @member {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} tokenProvisioningInformation + * @member {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} tokenProvisioningInformation */ exports.prototype['tokenProvisioningInformation'] = undefined; /** diff --git a/src/model/PostInstrumentIdentifierEnrollmentRequest.js b/src/model/PostInstrumentIdentifierEnrollmentRequest.js index bc5814e5..ce4d6968 100644 --- a/src/model/PostInstrumentIdentifierEnrollmentRequest.js +++ b/src/model/PostInstrumentIdentifierEnrollmentRequest.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); + define(['ApiClient', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); + module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.PostInstrumentIdentifierEnrollmentRequest = factory(root.CyberSource.ApiClient, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); + root.CyberSource.PostInstrumentIdentifierEnrollmentRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); } -}(this, function(ApiClient, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { +}(this, function(ApiClient, Ptsv2paymentsTokenInformationTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { 'use strict'; @@ -89,7 +89,7 @@ obj['type'] = ApiClient.convertToType(data['type'], 'String'); } if (data.hasOwnProperty('tokenProvisioningInformation')) { - obj['tokenProvisioningInformation'] = TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); + obj['tokenProvisioningInformation'] = Ptsv2paymentsTokenInformationTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); } if (data.hasOwnProperty('card')) { obj['card'] = TmsEmbeddedInstrumentIdentifierCard.constructFromObject(data['card']); @@ -136,12 +136,12 @@ */ exports.prototype['state'] = undefined; /** - * The type of Instrument Identifier. Possible Values: - enrollable card + * The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @member {String} type */ exports.prototype['type'] = undefined; /** - * @member {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} tokenProvisioningInformation + * @member {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} tokenProvisioningInformation */ exports.prototype['tokenProvisioningInformation'] = undefined; /** diff --git a/src/model/PostInstrumentIdentifierRequest.js b/src/model/PostInstrumentIdentifierRequest.js index d3620336..46303605 100644 --- a/src/model/PostInstrumentIdentifierRequest.js +++ b/src/model/PostInstrumentIdentifierRequest.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); + define(['ApiClient', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); + module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.PostInstrumentIdentifierRequest = factory(root.CyberSource.ApiClient, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); + root.CyberSource.PostInstrumentIdentifierRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); } -}(this, function(ApiClient, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { +}(this, function(ApiClient, Ptsv2paymentsTokenInformationTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { 'use strict'; @@ -89,7 +89,7 @@ obj['type'] = ApiClient.convertToType(data['type'], 'String'); } if (data.hasOwnProperty('tokenProvisioningInformation')) { - obj['tokenProvisioningInformation'] = TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); + obj['tokenProvisioningInformation'] = Ptsv2paymentsTokenInformationTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); } if (data.hasOwnProperty('card')) { obj['card'] = TmsEmbeddedInstrumentIdentifierCard.constructFromObject(data['card']); @@ -136,12 +136,12 @@ */ exports.prototype['state'] = undefined; /** - * The type of Instrument Identifier. Possible Values: - enrollable card + * The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @member {String} type */ exports.prototype['type'] = undefined; /** - * @member {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} tokenProvisioningInformation + * @member {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} tokenProvisioningInformation */ exports.prototype['tokenProvisioningInformation'] = undefined; /** diff --git a/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js b/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js index 6a48eb7b..131911c4 100644 --- a/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js +++ b/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js @@ -78,7 +78,7 @@ */ exports.prototype['creditAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js b/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js index 21336eb6..9f6629d7 100644 --- a/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js +++ b/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js @@ -69,7 +69,7 @@ } /** - * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @member {String} settlementMethod */ exports.prototype['settlementMethod'] = undefined; diff --git a/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js index c45d3cf0..3251febe 100644 --- a/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js @@ -82,7 +82,7 @@ */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.js b/src/model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.js index 7aa1c873..569dbd23 100644 --- a/src/model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.js +++ b/src/model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.js @@ -73,12 +73,12 @@ } /** - * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. * @member {String} type */ exports.prototype['type'] = undefined; /** - * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. + * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @member {String} id */ exports.prototype['id'] = undefined; diff --git a/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.js index 46896795..5ec2cb60 100644 --- a/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.js @@ -73,7 +73,7 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js b/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js index 9d4f1708..5228aad8 100644 --- a/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js +++ b/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js @@ -154,7 +154,7 @@ */ exports.prototype['country'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.js b/src/model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.js index d3890a07..f5972429 100644 --- a/src/model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.js +++ b/src/model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.js @@ -69,7 +69,7 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseBuyerInformation.js b/src/model/PtsV2PaymentsPost201ResponseBuyerInformation.js index 7d5e9310..ceec5b65 100644 --- a/src/model/PtsV2PaymentsPost201ResponseBuyerInformation.js +++ b/src/model/PtsV2PaymentsPost201ResponseBuyerInformation.js @@ -89,17 +89,17 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; /** - * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @member {String} vatRegistrationNumber */ exports.prototype['vatRegistrationNumber'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js b/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js index 8e5fe7fb..e2546cd3 100644 --- a/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js +++ b/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js @@ -253,7 +253,7 @@ */ exports.prototype['acsUrl'] = undefined; /** - * Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. * @member {String} authenticationPath */ exports.prototype['authenticationPath'] = undefined; @@ -351,7 +351,7 @@ */ exports.prototype['paresStatus'] = undefined; /** - * Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. + * Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. * @member {String} proofXml */ exports.prototype['proofXml'] = undefined; @@ -396,7 +396,7 @@ */ exports.prototype['ucafCollectionIndicator'] = undefined; /** - * Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. * @member {String} veresEnrolled */ exports.prototype['veresEnrolled'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js index 9704426d..99d45e07 100644 --- a/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js @@ -118,12 +118,12 @@ */ exports.prototype['totalAmount'] = undefined; /** - * Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. + * Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. * @member {String} authorizedAmount */ exports.prototype['authorizedAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js index ea33ea2d..f2259bb5 100644 --- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js +++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js @@ -153,27 +153,27 @@ */ exports.prototype['shippingAddress'] = undefined; /** - * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. * @member {String} scheme */ exports.prototype['scheme'] = undefined; /** - * Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. * @member {String} bin */ exports.prototype['bin'] = undefined; /** - * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. * @member {String} accountType */ exports.prototype['accountType'] = undefined; /** - * Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Name of the bank or entity that issued the card account. * @member {String} issuer */ exports.prototype['issuer'] = undefined; /** - * Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. * @member {String} binCountry */ exports.prototype['binCountry'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBank.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBank.js index 523b037b..d9f1688a 100644 --- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBank.js +++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBank.js @@ -77,7 +77,7 @@ */ exports.prototype['account'] = undefined; /** - * Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Corrected account number from the ACH verification service. * @member {String} correctedRoutingNumber */ exports.prototype['correctedRoutingNumber'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js index 13008880..9b7dcafe 100644 --- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js +++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js @@ -69,7 +69,7 @@ } /** - * Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Corrected account number from the ACH verification service. * @member {String} correctedAccountNumber */ exports.prototype['correctedAccountNumber'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js b/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js index 10b37f08..b5f0c573 100644 --- a/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js +++ b/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js @@ -73,12 +73,12 @@ } /** - * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @member {String} settlementMethod */ exports.prototype['settlementMethod'] = undefined; /** - * Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification * @member {String} fraudScreeningLevel */ exports.prototype['fraudScreeningLevel'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js index 9e526379..2a95ca70 100644 --- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js +++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js @@ -73,12 +73,12 @@ } /** - * Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * Results from the ACH verification service. * @member {String} resultCode */ exports.prototype['resultCode'] = undefined; /** - * Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * Raw results from the ACH verification service. * @member {String} resultCodeRaw */ exports.prototype['resultCodeRaw'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js index 8c39cf4f..b3e8f868 100644 --- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js +++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js @@ -73,7 +73,7 @@ } /** - * CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * CVN result code. * @member {String} resultCode */ exports.prototype['resultCode'] = undefined; diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js index ac33a5f7..16805e92 100644 --- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js +++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js @@ -137,7 +137,7 @@ } /** - * Mapped Electronic Verification response code for the customer's name. For details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's name. * @member {String} code */ exports.prototype['code'] = undefined; @@ -147,7 +147,7 @@ */ exports.prototype['codeRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's email address. * @member {String} email */ exports.prototype['email'] = undefined; @@ -157,7 +157,7 @@ */ exports.prototype['emailRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's phone number. * @member {String} phoneNumber */ exports.prototype['phoneNumber'] = undefined; @@ -167,7 +167,7 @@ */ exports.prototype['phoneNumberRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's postal code. * @member {String} postalCode */ exports.prototype['postalCode'] = undefined; @@ -177,7 +177,7 @@ */ exports.prototype['postalCodeRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's street address. * @member {String} street */ exports.prototype['street'] = undefined; diff --git a/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js index 688e75f0..634c4f90 100644 --- a/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js @@ -95,12 +95,12 @@ */ exports.prototype['settlementCurrency'] = undefined; /** - * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) + * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @member {String} exchangeRate */ exports.prototype['exchangeRate'] = undefined; /** - * Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Set this field to the converted amount that was returned by the DCC provider. * @member {String} foreignAmount */ exports.prototype['foreignAmount'] = undefined; diff --git a/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js b/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js index a4ac22b7..3aea7b3d 100644 --- a/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js +++ b/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js @@ -87,7 +87,7 @@ */ exports.prototype['creditAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js b/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js index 36c5a36e..9413d385 100644 --- a/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js +++ b/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js @@ -87,7 +87,7 @@ */ exports.prototype['originalTransactionAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js b/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js index a1e1b719..7d6df08b 100644 --- a/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js +++ b/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js @@ -87,7 +87,7 @@ */ exports.prototype['originalTransactionAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js index 25ad2aa1..e8ec970f 100644 --- a/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js @@ -81,12 +81,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferAggregatorInformation.js b/src/model/Ptsv1pushfundstransferAggregatorInformation.js deleted file mode 100644 index 726f306a..00000000 --- a/src/model/Ptsv1pushfundstransferAggregatorInformation.js +++ /dev/null @@ -1,99 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferAggregatorInformationSubMerchant'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferAggregatorInformationSubMerchant')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferAggregatorInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant); - } -}(this, function(ApiClient, Ptsv1pushfundstransferAggregatorInformationSubMerchant) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferAggregatorInformation model module. - * @module model/Ptsv1pushfundstransferAggregatorInformation - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferAggregatorInformation. - * @alias module:model/Ptsv1pushfundstransferAggregatorInformation - * @class - */ - var exports = function() { - var _this = this; - - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferAggregatorInformation from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferAggregatorInformation} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferAggregatorInformation} The populated Ptsv1pushfundstransferAggregatorInformation instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('aggregatorId')) { - obj['aggregatorId'] = ApiClient.convertToType(data['aggregatorId'], 'String'); - } - if (data.hasOwnProperty('name')) { - obj['name'] = ApiClient.convertToType(data['name'], 'String'); - } - if (data.hasOwnProperty('subMerchant')) { - obj['subMerchant'] = Ptsv1pushfundstransferAggregatorInformationSubMerchant.constructFromObject(data['subMerchant']); - } - } - return obj; - } - - /** - * Value that identifies you as a payment aggregator. Get this value from the processor. FDC Compass This value must consist of uppercase letters. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - `Record`: CP01 TCR6 - `Position`: 95-105 - `Field`: Market Identifier / Payment Facilitator ID - * @member {String} aggregatorId - */ - exports.prototype['aggregatorId'] = undefined; - /** - * Your payment aggregator business name. Visa Platform COnnect With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API. - * @member {String} name - */ - exports.prototype['name'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferAggregatorInformationSubMerchant} subMerchant - */ - exports.prototype['subMerchant'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js b/src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js deleted file mode 100644 index 16ba4c09..00000000 --- a/src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js +++ /dev/null @@ -1,154 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferAggregatorInformationSubMerchant model module. - * @module model/Ptsv1pushfundstransferAggregatorInformationSubMerchant - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferAggregatorInformationSubMerchant. - * @alias module:model/Ptsv1pushfundstransferAggregatorInformationSubMerchant - * @class - */ - var exports = function() { - var _this = this; - - - - - - - - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferAggregatorInformationSubMerchant from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferAggregatorInformationSubMerchant} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferAggregatorInformationSubMerchant} The populated Ptsv1pushfundstransferAggregatorInformationSubMerchant instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('id')) { - obj['id'] = ApiClient.convertToType(data['id'], 'String'); - } - if (data.hasOwnProperty('name')) { - obj['name'] = ApiClient.convertToType(data['name'], 'String'); - } - if (data.hasOwnProperty('address1')) { - obj['address1'] = ApiClient.convertToType(data['address1'], 'String'); - } - if (data.hasOwnProperty('locality')) { - obj['locality'] = ApiClient.convertToType(data['locality'], 'String'); - } - if (data.hasOwnProperty('administrativeArea')) { - obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String'); - } - if (data.hasOwnProperty('postalCode')) { - obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String'); - } - if (data.hasOwnProperty('country')) { - obj['country'] = ApiClient.convertToType(data['country'], 'String'); - } - if (data.hasOwnProperty('email')) { - obj['email'] = ApiClient.convertToType(data['email'], 'String'); - } - if (data.hasOwnProperty('phoneNumber')) { - obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String'); - } - } - return obj; - } - - /** - * The ID you assigned to your sub-merchant. FDC Compass: This value must consist of uppercase characters. Visa Platform Connect with Mastercard: String (15) FDC Compass: String (20) - * @member {String} id - */ - exports.prototype['id'] = undefined; - /** - * Sub-merchant's business name. Visa Platform Connect With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @member {String} name - */ - exports.prototype['name'] = undefined; - /** - * First line of the sub-merchant's street address. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @member {String} address1 - */ - exports.prototype['address1'] = undefined; - /** - * Sub-merchant's city. For processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @member {String} locality - */ - exports.prototype['locality'] = undefined; - /** - * Sub-merchant's state or province. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. - * @member {String} administrativeArea - */ - exports.prototype['administrativeArea'] = undefined; - /** - * Partial postal code for the sub-merchant's address. For processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @member {String} postalCode - */ - exports.prototype['postalCode'] = undefined; - /** - * Sub-merchant's country. Use the ISO Standard numeric Country Codes. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. - * @member {String} country - */ - exports.prototype['country'] = undefined; - /** - * Sub-merchant's email address. CyberSource through VisaNet | With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address - Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. - * @member {String} email - */ - exports.prototype['email'] = undefined; - /** - * Sub-merchant's telephone number. Maximum length for procesors Visa Platform Connect: 20 FDC Compass: 13 FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA - * @member {String} phoneNumber - */ - exports.prototype['phoneNumber'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js b/src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js deleted file mode 100644 index 8bf5ee27..00000000 --- a/src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js +++ /dev/null @@ -1,91 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferMerchantDefinedInformation model module. - * @module model/Ptsv1pushfundstransferMerchantDefinedInformation - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferMerchantDefinedInformation. - * @alias module:model/Ptsv1pushfundstransferMerchantDefinedInformation - * @class - */ - var exports = function() { - var _this = this; - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferMerchantDefinedInformation from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferMerchantDefinedInformation} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferMerchantDefinedInformation} The populated Ptsv1pushfundstransferMerchantDefinedInformation instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('key')) { - obj['key'] = ApiClient.convertToType(data['key'], 'String'); - } - if (data.hasOwnProperty('value')) { - obj['value'] = ApiClient.convertToType(data['value'], 'String'); - } - } - return obj; - } - - /** - * The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key. For Mastercard Send: Name to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report. - * @member {String} key - */ - exports.prototype['key'] = undefined; - /** - * The value you assign for your merchant-defined data field. For details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. For Mastercard Send: Value to be displayed in the reconciliation report for this disbursement. - * @member {String} value - */ - exports.prototype['value'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferMerchantInformation.js b/src/model/Ptsv1pushfundstransferMerchantInformation.js deleted file mode 100644 index 421e9141..00000000 --- a/src/model/Ptsv1pushfundstransferMerchantInformation.js +++ /dev/null @@ -1,108 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferMerchantInformationMerchantDescriptor')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferMerchantInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor); - } -}(this, function(ApiClient, Ptsv1pushfundstransferMerchantInformationMerchantDescriptor) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferMerchantInformation model module. - * @module model/Ptsv1pushfundstransferMerchantInformation - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferMerchantInformation. - * @alias module:model/Ptsv1pushfundstransferMerchantInformation - * @class - */ - var exports = function() { - var _this = this; - - - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferMerchantInformation from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferMerchantInformation} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferMerchantInformation} The populated Ptsv1pushfundstransferMerchantInformation instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('categoryCode')) { - obj['categoryCode'] = ApiClient.convertToType(data['categoryCode'], 'Number'); - } - if (data.hasOwnProperty('submitLocalDateTime')) { - obj['submitLocalDateTime'] = ApiClient.convertToType(data['submitLocalDateTime'], 'String'); - } - if (data.hasOwnProperty('vatRegistrationNumber')) { - obj['vatRegistrationNumber'] = ApiClient.convertToType(data['vatRegistrationNumber'], 'String'); - } - if (data.hasOwnProperty('merchantDescriptor')) { - obj['merchantDescriptor'] = Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.constructFromObject(data['merchantDescriptor']); - } - } - return obj; - } - - /** - * The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR4 Position: 150-153 Field: Merchant Category Code - * @member {Number} categoryCode - */ - exports.prototype['categoryCode'] = undefined; - /** - * Time that the transaction was submitted in local time. The time is in hhmmss format. - * @member {String} submitLocalDateTime - */ - exports.prototype['submitLocalDateTime'] = undefined; - /** - * Your government-assigned tax identification number. Visa Platform Connect: max length is 20 - * @member {String} vatRegistrationNumber - */ - exports.prototype['vatRegistrationNumber'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor} merchantDescriptor - */ - exports.prototype['merchantDescriptor'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js b/src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js deleted file mode 100644 index 50926ca5..00000000 --- a/src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js +++ /dev/null @@ -1,136 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferMerchantInformationMerchantDescriptor model module. - * @module model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferMerchantInformationMerchantDescriptor. - * @alias module:model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - * @class - */ - var exports = function() { - var _this = this; - - - - - - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferMerchantInformationMerchantDescriptor from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor} The populated Ptsv1pushfundstransferMerchantInformationMerchantDescriptor instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('administrativeArea')) { - obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String'); - } - if (data.hasOwnProperty('contact')) { - obj['contact'] = ApiClient.convertToType(data['contact'], 'String'); - } - if (data.hasOwnProperty('country')) { - obj['country'] = ApiClient.convertToType(data['country'], 'String'); - } - if (data.hasOwnProperty('locality')) { - obj['locality'] = ApiClient.convertToType(data['locality'], 'String'); - } - if (data.hasOwnProperty('name')) { - obj['name'] = ApiClient.convertToType(data['name'], 'String'); - } - if (data.hasOwnProperty('storeId')) { - obj['storeId'] = ApiClient.convertToType(data['storeId'], 'String'); - } - if (data.hasOwnProperty('postalCode')) { - obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String'); - } - } - return obj; - } - - /** - * The state where the merchant is located. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Note This field is supported only for businesses located in the U.S. or Canada. - * @member {String} administrativeArea - */ - exports.prototype['administrativeArea'] = undefined; - /** - * For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: FDC Compass (13) Chase Paymentech (13). - * @member {String} contact - */ - exports.prototype['contact'] = undefined; - /** - * Merchant's country. Country code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea. - * @member {String} country - */ - exports.prototype['country'] = undefined; - /** - * Merchant's City. City for your business location. This value might be displayed on the cardholder's statement. - * @member {String} locality - */ - exports.prototype['locality'] = undefined; - /** - * Merchant's business name. This name is displayed on the cardholder's statement. Chase Paymentech, Visa Platform Connect: length 22 - * @member {String} name - */ - exports.prototype['name'] = undefined; - /** - * The unique id of the merchant's shop which assigned by the merchant. - * @member {String} storeId - */ - exports.prototype['storeId'] = undefined; - /** - * Merchant's postal code. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3 - * @member {String} postalCode - */ - exports.prototype['postalCode'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferOrderInformation.js b/src/model/Ptsv1pushfundstransferOrderInformation.js index 9f989293..7ad1761e 100644 --- a/src/model/Ptsv1pushfundstransferOrderInformation.js +++ b/src/model/Ptsv1pushfundstransferOrderInformation.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferOrderInformationAmountDetails', 'model/Ptsv1pushfundstransferOrderInformationSurcharge'], factory); + define(['ApiClient', 'model/Ptsv1pushfundstransferOrderInformationAmountDetails'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferOrderInformationAmountDetails'), require('./Ptsv1pushfundstransferOrderInformationSurcharge')); + module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferOrderInformationAmountDetails')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.Ptsv1pushfundstransferOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferOrderInformationAmountDetails, root.CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge); + root.CyberSource.Ptsv1pushfundstransferOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferOrderInformationAmountDetails); } -}(this, function(ApiClient, Ptsv1pushfundstransferOrderInformationAmountDetails, Ptsv1pushfundstransferOrderInformationSurcharge) { +}(this, function(ApiClient, Ptsv1pushfundstransferOrderInformationAmountDetails) { 'use strict'; @@ -49,8 +49,6 @@ var _this = this; _this['amountDetails'] = amountDetails; - - }; /** @@ -67,12 +65,6 @@ if (data.hasOwnProperty('amountDetails')) { obj['amountDetails'] = Ptsv1pushfundstransferOrderInformationAmountDetails.constructFromObject(data['amountDetails']); } - if (data.hasOwnProperty('isCryptocurrencyPurchase')) { - obj['isCryptocurrencyPurchase'] = ApiClient.convertToType(data['isCryptocurrencyPurchase'], 'String'); - } - if (data.hasOwnProperty('surcharge')) { - obj['surcharge'] = Ptsv1pushfundstransferOrderInformationSurcharge.constructFromObject(data['surcharge']); - } } return obj; } @@ -81,15 +73,6 @@ * @member {module:model/Ptsv1pushfundstransferOrderInformationAmountDetails} amountDetails */ exports.prototype['amountDetails'] = undefined; - /** - * This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false - * @member {String} isCryptocurrencyPurchase - */ - exports.prototype['isCryptocurrencyPurchase'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferOrderInformationSurcharge} surcharge - */ - exports.prototype['surcharge'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js b/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js index f6b76648..fa1fb9af 100644 --- a/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js +++ b/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js @@ -43,14 +43,16 @@ * Constructs a new Ptsv1pushfundstransferOrderInformationAmountDetails. * @alias module:model/Ptsv1pushfundstransferOrderInformationAmountDetails * @class - * @param totalAmount {String} Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 - * @param currency {String} Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. + * @param totalAmount {String} Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. + * @param currency {String} Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. */ var exports = function(totalAmount, currency) { var _this = this; _this['totalAmount'] = totalAmount; _this['currency'] = currency; + + }; /** @@ -70,20 +72,36 @@ if (data.hasOwnProperty('currency')) { obj['currency'] = ApiClient.convertToType(data['currency'], 'String'); } + if (data.hasOwnProperty('sourceCurrency')) { + obj['sourceCurrency'] = ApiClient.convertToType(data['sourceCurrency'], 'String'); + } + if (data.hasOwnProperty('destinationCurrency')) { + obj['destinationCurrency'] = ApiClient.convertToType(data['destinationCurrency'], 'String'); + } } return obj; } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. + * Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. * @member {String} currency */ exports.prototype['currency'] = undefined; + /** + * Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf + * @member {String} sourceCurrency + */ + exports.prototype['sourceCurrency'] = undefined; + /** + * Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf NOTE: This field is supported only for Visa Platform Connect + * @member {String} destinationCurrency + */ + exports.prototype['destinationCurrency'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js b/src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js deleted file mode 100644 index 9812dc83..00000000 --- a/src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js +++ /dev/null @@ -1,82 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferOrderInformationSurcharge model module. - * @module model/Ptsv1pushfundstransferOrderInformationSurcharge - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferOrderInformationSurcharge. - * @alias module:model/Ptsv1pushfundstransferOrderInformationSurcharge - * @class - */ - var exports = function() { - var _this = this; - - - }; - - /** - * Constructs a Ptsv1pushfundstransferOrderInformationSurcharge from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferOrderInformationSurcharge} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferOrderInformationSurcharge} The populated Ptsv1pushfundstransferOrderInformationSurcharge instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('amount')) { - obj['amount'] = ApiClient.convertToType(data['amount'], 'String'); - } - } - return obj; - } - - /** - * The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. NOTE: This field is supported only for Visa Platform Connect - * @member {String} amount - */ - exports.prototype['amount'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferPointOfServiceInformation.js b/src/model/Ptsv1pushfundstransferPointOfServiceInformation.js deleted file mode 100644 index 312d5cdb..00000000 --- a/src/model/Ptsv1pushfundstransferPointOfServiceInformation.js +++ /dev/null @@ -1,118 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferPointOfServiceInformation = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferPointOfServiceInformation model module. - * @module model/Ptsv1pushfundstransferPointOfServiceInformation - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferPointOfServiceInformation. - * @alias module:model/Ptsv1pushfundstransferPointOfServiceInformation - * @class - */ - var exports = function() { - var _this = this; - - - - - - - }; - - /** - * Constructs a Ptsv1pushfundstransferPointOfServiceInformation from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferPointOfServiceInformation} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferPointOfServiceInformation} The populated Ptsv1pushfundstransferPointOfServiceInformation instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('terminalId')) { - obj['terminalId'] = ApiClient.convertToType(data['terminalId'], 'String'); - } - if (data.hasOwnProperty('catLevel')) { - obj['catLevel'] = ApiClient.convertToType(data['catLevel'], 'Number'); - } - if (data.hasOwnProperty('entryMode')) { - obj['entryMode'] = ApiClient.convertToType(data['entryMode'], 'String'); - } - if (data.hasOwnProperty('pinEntryCapability')) { - obj['pinEntryCapability'] = ApiClient.convertToType(data['pinEntryCapability'], 'Number'); - } - if (data.hasOwnProperty('terminalCapability')) { - obj['terminalCapability'] = ApiClient.convertToType(data['terminalCapability'], 'Number'); - } - } - return obj; - } - - /** - * Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. Visa Platform Connect A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. Used by Authorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel. - * @member {String} terminalId - */ - exports.prototype['terminalId'] = undefined; - /** - * Type of cardholder-activated terminal. Possible values: - `1`: Automated dispensing machine - `2`: Self-service terminal - `3`: Limited amount terminal - `4`: In-flight commerce (IFC) terminal - `5`: Radio frequency device - `6`: Mobile acceptance terminal - `7`: Electronic cash register - `8`: E-commerce device at your location - `9`: Terminal or cash register that uses a dialup connection to connect to the transaction processing network Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if pointOfSaleInformation.terminalID is included in the request; otherwise, optional. Visa Platform COnnect Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. Nonnegative integer. - * @member {Number} catLevel - */ - exports.prototype['catLevel'] = undefined; - /** - * Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. - * @member {String} entryMode - */ - exports.prototype['entryMode'] = undefined; - /** - * PIN Entry Capability - 0 Unknown. - 1 Indicates terminal can accept and forward online PINs. - 2 Indicates terminal cannot accept and forward online PINs. - 8 Terminal PIN pad down. - 9 Reserved for future use. - * @member {Number} pinEntryCapability - */ - exports.prototype['pinEntryCapability'] = undefined; - /** - * integer [ 1 .. 5 ] POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be 4 or 5. Used by Authorization Required for the following processors: Chase Paymentech Solutions Optional for the following processors: Visa Platform Connect - * @member {Number} terminalCapability - */ - exports.prototype['terminalCapability'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferProcessingInformation.js b/src/model/Ptsv1pushfundstransferProcessingInformation.js index bf97883f..a476558b 100644 --- a/src/model/Ptsv1pushfundstransferProcessingInformation.js +++ b/src/model/Ptsv1pushfundstransferProcessingInformation.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions', 'model/Ptsv1pushfundstransferProcessingInformationRecurringOptions'], factory); + define(['ApiClient', 'model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferProcessingInformationPayoutsOptions'), require('./Ptsv1pushfundstransferProcessingInformationRecurringOptions')); + module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferProcessingInformationPayoutsOptions')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.Ptsv1pushfundstransferProcessingInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions, root.CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions); + root.CyberSource.Ptsv1pushfundstransferProcessingInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions); } -}(this, function(ApiClient, Ptsv1pushfundstransferProcessingInformationPayoutsOptions, Ptsv1pushfundstransferProcessingInformationRecurringOptions) { +}(this, function(ApiClient, Ptsv1pushfundstransferProcessingInformationPayoutsOptions) { 'use strict'; @@ -43,18 +43,11 @@ * Constructs a new Ptsv1pushfundstransferProcessingInformation. * @alias module:model/Ptsv1pushfundstransferProcessingInformation * @class - * @param commerceIndicator {String} Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. */ - var exports = function(commerceIndicator) { + var exports = function() { var _this = this; - _this['commerceIndicator'] = commerceIndicator; - - - - - }; @@ -72,69 +65,22 @@ if (data.hasOwnProperty('businessApplicationId')) { obj['businessApplicationId'] = ApiClient.convertToType(data['businessApplicationId'], 'String'); } - if (data.hasOwnProperty('commerceIndicator')) { - obj['commerceIndicator'] = ApiClient.convertToType(data['commerceIndicator'], 'String'); - } - if (data.hasOwnProperty('networkRoutingOrder')) { - obj['networkRoutingOrder'] = ApiClient.convertToType(data['networkRoutingOrder'], 'String'); - } if (data.hasOwnProperty('payoutsOptions')) { obj['payoutsOptions'] = Ptsv1pushfundstransferProcessingInformationPayoutsOptions.constructFromObject(data['payoutsOptions']); } - if (data.hasOwnProperty('purposeOfPayment')) { - obj['purposeOfPayment'] = ApiClient.convertToType(data['purposeOfPayment'], 'String'); - } - if (data.hasOwnProperty('reconciliationId')) { - obj['reconciliationId'] = ApiClient.convertToType(data['reconciliationId'], 'String'); - } - if (data.hasOwnProperty('recurringOptions')) { - obj['recurringOptions'] = Ptsv1pushfundstransferProcessingInformationRecurringOptions.constructFromObject(data['recurringOptions']); - } - if (data.hasOwnProperty('transactionReason')) { - obj['transactionReason'] = ApiClient.convertToType(data['transactionReason'], 'String'); - } } return obj; } /** - * Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - `AA`: Account to account. - `CP`: Card bill payment - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. - `TU`: Top-up for enhanced prepaid loads. Mastercard Send: - `BB`: Business to business. - `BD`: Business Disbursement - `CP`: Card bill payment - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `OG`: Online gambling payout. Chase Paymentech Solutions: - `AA`: Account to account. - `FD`: Funds disbursement (general) - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. FDC Compass: - `BB`: Business to business. - `BI`: Bank-initiated money transfer. - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `GP`: Gambling Payment - `LO`: Loyalty Offers - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `MI`: Merchant initated money transfer - `OG`: Online gambling payout. - `PD`: Payroll pension disbursement. - `PP`: Person to person. - `WT`: Wallet transfer. + * Payouts transaction type. Business Application ID: - `PP`: Person to person. - `FD`: Funds disbursement (general) * @member {String} businessApplicationId */ exports.prototype['businessApplicationId'] = undefined; - /** - * Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. - * @member {String} commerceIndicator - */ - exports.prototype['commerceIndicator'] = undefined; - /** - * Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the network_order field description in BIN Lookup Service Using the SCMP API. - * @member {String} networkRoutingOrder - */ - exports.prototype['networkRoutingOrder'] = undefined; /** * @member {module:model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions} payoutsOptions */ exports.prototype['payoutsOptions'] = undefined; - /** - * This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country. Mastercard Send: - `00`: Family Support - `01`: Regular Labor Transfers (expatriates), - `02`: Travel & Tourism - `03`: Education - `04`: Hospitalization & Medical Treatment, - `05`: Emergency Need - `06`: Savings - `07`: Gifts - `08`: Other - `09`: Salary - `10`: Crowd lending - `11`: Crypto currency - `12`: Refund to original card - `13`: Refund to new card - * @member {String} purposeOfPayment - */ - exports.prototype['purposeOfPayment'] = undefined; - /** - * Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. For Payouts: max length for FDCCompass is String (22). - * @member {String} reconciliationId - */ - exports.prototype['reconciliationId'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferProcessingInformationRecurringOptions} recurringOptions - */ - exports.prototype['recurringOptions'] = undefined; - /** - * Transaction reason code. This field applies only to Visa Platform Connect - * @member {String} transactionReason - */ - exports.prototype['transactionReason'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js b/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js index 9bc09572..130d5654 100644 --- a/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js +++ b/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js @@ -62,26 +62,26 @@ if (data) { obj = obj || new exports(); - if (data.hasOwnProperty('accountFundingReferenceId')) { - obj['accountFundingReferenceId'] = ApiClient.convertToType(data['accountFundingReferenceId'], 'String'); + if (data.hasOwnProperty('sourceCurrency')) { + obj['sourceCurrency'] = ApiClient.convertToType(data['sourceCurrency'], 'String'); } - if (data.hasOwnProperty('retrievalReferenceNumber')) { - obj['retrievalReferenceNumber'] = ApiClient.convertToType(data['retrievalReferenceNumber'], 'String'); + if (data.hasOwnProperty('destinationCurrency')) { + obj['destinationCurrency'] = ApiClient.convertToType(data['destinationCurrency'], 'String'); } } return obj; } /** - * Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. Applicable only for Visa Platform Connect - * @member {String} accountFundingReferenceId + * Use a 3-character alpha currency code for source currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf + * @member {String} sourceCurrency */ - exports.prototype['accountFundingReferenceId'] = undefined; + exports.prototype['sourceCurrency'] = undefined; /** - * This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant Applicable only for Visa Platform Connect - * @member {String} retrievalReferenceNumber + * Use a 3-character alpha currency code for destination currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf + * @member {String} destinationCurrency */ - exports.prototype['retrievalReferenceNumber'] = undefined; + exports.prototype['destinationCurrency'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js b/src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js deleted file mode 100644 index 78921c19..00000000 --- a/src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js +++ /dev/null @@ -1,82 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferProcessingInformationRecurringOptions model module. - * @module model/Ptsv1pushfundstransferProcessingInformationRecurringOptions - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferProcessingInformationRecurringOptions. - * @alias module:model/Ptsv1pushfundstransferProcessingInformationRecurringOptions - * @class - */ - var exports = function() { - var _this = this; - - - }; - - /** - * Constructs a Ptsv1pushfundstransferProcessingInformationRecurringOptions from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferProcessingInformationRecurringOptions} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferProcessingInformationRecurringOptions} The populated Ptsv1pushfundstransferProcessingInformationRecurringOptions instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('loanPayment')) { - obj['loanPayment'] = ApiClient.convertToType(data['loanPayment'], 'Boolean'); - } - } - return obj; - } - - /** - * boolean Default: false Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: true: Loan payment false: (default) Not a loan payment This field applies only to FDC Compass - * @member {Boolean} loanPayment - */ - exports.prototype['loanPayment'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferProcessingOptions.js b/src/model/Ptsv1pushfundstransferProcessingOptions.js deleted file mode 100644 index bf6a2118..00000000 --- a/src/model/Ptsv1pushfundstransferProcessingOptions.js +++ /dev/null @@ -1,81 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferProcessingOptionsFundingOptions'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferProcessingOptionsFundingOptions')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferProcessingOptions = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions); - } -}(this, function(ApiClient, Ptsv1pushfundstransferProcessingOptionsFundingOptions) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferProcessingOptions model module. - * @module model/Ptsv1pushfundstransferProcessingOptions - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferProcessingOptions. - * @alias module:model/Ptsv1pushfundstransferProcessingOptions - * @class - */ - var exports = function() { - var _this = this; - - - }; - - /** - * Constructs a Ptsv1pushfundstransferProcessingOptions from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferProcessingOptions} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferProcessingOptions} The populated Ptsv1pushfundstransferProcessingOptions instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('fundingOptions')) { - obj['fundingOptions'] = Ptsv1pushfundstransferProcessingOptionsFundingOptions.constructFromObject(data['fundingOptions']); - } - } - return obj; - } - - /** - * @member {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptions} fundingOptions - */ - exports.prototype['fundingOptions'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js b/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js deleted file mode 100644 index 8b2cdf5c..00000000 --- a/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js +++ /dev/null @@ -1,81 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator); - } -}(this, function(ApiClient, Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferProcessingOptionsFundingOptions model module. - * @module model/Ptsv1pushfundstransferProcessingOptionsFundingOptions - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferProcessingOptionsFundingOptions. - * @alias module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptions - * @class - */ - var exports = function() { - var _this = this; - - - }; - - /** - * Constructs a Ptsv1pushfundstransferProcessingOptionsFundingOptions from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptions} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptions} The populated Ptsv1pushfundstransferProcessingOptionsFundingOptions instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('initiator')) { - obj['initiator'] = Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.constructFromObject(data['initiator']); - } - } - return obj; - } - - /** - * @member {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator} initiator - */ - exports.prototype['initiator'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js b/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js deleted file mode 100644 index 66548f57..00000000 --- a/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js +++ /dev/null @@ -1,82 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. Register as an anonymous module. - define(['ApiClient'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient')); - } else { - // Browser globals (root is window) - if (!root.CyberSource) { - root.CyberSource = {}; - } - root.CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator = factory(root.CyberSource.ApiClient); - } -}(this, function(ApiClient) { - 'use strict'; - - - - - /** - * The Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator model module. - * @module model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - * @version 0.0.1 - */ - - /** - * Constructs a new Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator. - * @alias module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - * @class - */ - var exports = function() { - var _this = this; - - - }; - - /** - * Constructs a Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator} obj Optional instance to populate. - * @return {module:model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator} The populated Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator instance. - */ - exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('type')) { - obj['type'] = ApiClient.convertToType(data['type'], 'String'); - } - } - return obj; - } - - /** - * Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: - `S` (Payer (sender)) - `R` (Payee (recipient)) This field applies only to Visa Platform Connect - * @member {String} type - */ - exports.prototype['type'] = undefined; - - - - return exports; -})); - - diff --git a/src/model/Ptsv1pushfundstransferRecipientInformation.js b/src/model/Ptsv1pushfundstransferRecipientInformation.js index 5cbb2375..34aa8fc1 100644 --- a/src/model/Ptsv1pushfundstransferRecipientInformation.js +++ b/src/model/Ptsv1pushfundstransferRecipientInformation.js @@ -59,8 +59,6 @@ - - }; /** @@ -101,15 +99,9 @@ if (data.hasOwnProperty('middleName')) { obj['middleName'] = ApiClient.convertToType(data['middleName'], 'String'); } - if (data.hasOwnProperty('middleInitial')) { - obj['middleInitial'] = ApiClient.convertToType(data['middleInitial'], 'String'); - } if (data.hasOwnProperty('lastName')) { obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String'); } - if (data.hasOwnProperty('dateOfBirth')) { - obj['dateOfBirth'] = ApiClient.convertToType(data['dateOfBirth'], 'String'); - } if (data.hasOwnProperty('phoneNumber')) { obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String'); } @@ -125,37 +117,37 @@ */ exports.prototype['paymentInformation'] = undefined; /** - * First line of the recipient's address. Required for Mastercard Send. This field is not supported for Visa Platform Connect. + * First line of the recipient's address. Required for card payments * @member {String} address1 */ exports.prototype['address1'] = undefined; /** - * Second line of the recipient's address Optional for Mastercard Send. This field is not supported for Visa Platform Connect. + * Second line of the recipient's address * @member {String} address2 */ exports.prototype['address2'] = undefined; /** - * Recipient city. Required for Mastercard Send. + * Recipient city. * @member {String} locality */ exports.prototype['locality'] = undefined; /** - * Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mastercard Send: Required for recipients in Canada and Canadian issued cards. + * Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mandatory for card payments. * @member {String} postalCode */ exports.prototype['postalCode'] = undefined; /** - * The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. Required only for FDCCompass. This field is not supported for Visa Platform Connect. + * The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Required for card payments. * @member {String} administrativeArea */ exports.prototype['administrativeArea'] = undefined; /** - * Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Required for Mastercard Send. + * Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf * @member {String} country */ exports.prototype['country'] = undefined; /** - * First name of recipient. Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. + * First name of recipient. * @member {String} firstName */ exports.prototype['firstName'] = undefined; @@ -165,20 +157,10 @@ */ exports.prototype['middleName'] = undefined; /** - * Middle Initial of recipient. This field is supported by FDC Compass. - * @member {String} middleInitial - */ - exports.prototype['middleInitial'] = undefined; - /** - * Last name of recipient. Visa Platform Connect (14) Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. + * Last name of recipient. * @member {String} lastName */ exports.prototype['lastName'] = undefined; - /** - * Recipient date of birth in YYYYMMDD format. - * @member {String} dateOfBirth - */ - exports.prototype['dateOfBirth'] = undefined; /** * Recipient phone number. This field is supported by FDC Compass. Mastercard Send: Max length is 15 with no dashes or spaces. * @member {String} phoneNumber diff --git a/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js b/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js index f567d51c..1840c4d8 100644 --- a/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js +++ b/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js @@ -97,7 +97,7 @@ } /** - * Three-digit value that indicates the card type. Mandatory if not present in a token. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. + * Three-digit value that indicates the card type. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Yellow Pepper: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `005`: Diners Club - `033`: Visa Electron - `024`: Intl Maestro * @member {String} type */ exports.prototype['type'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js b/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js index c34eecb2..def42c98 100644 --- a/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js +++ b/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js @@ -49,6 +49,7 @@ + }; /** @@ -68,20 +69,28 @@ if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } + if (data.hasOwnProperty('issuingCountry')) { + obj['issuingCountry'] = ApiClient.convertToType(data['issuingCountry'], 'String'); + } } return obj; } /** - * The ID number/value. Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) + * The ID number/value. Processor(35) * @member {String} id */ exports.prototype['id'] = undefined; /** - * This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) + * This tag will contain the type of sender identification. * @member {String} type */ exports.prototype['type'] = undefined; + /** + * Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. + * @member {String} issuingCountry + */ + exports.prototype['issuingCountry'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferSenderInformation.js b/src/model/Ptsv1pushfundstransferSenderInformation.js index d6b6b8d5..3508902c 100644 --- a/src/model/Ptsv1pushfundstransferSenderInformation.js +++ b/src/model/Ptsv1pushfundstransferSenderInformation.js @@ -63,7 +63,6 @@ - }; /** @@ -107,9 +106,6 @@ if (data.hasOwnProperty('country')) { obj['country'] = ApiClient.convertToType(data['country'], 'String'); } - if (data.hasOwnProperty('vatRegistrationNumber')) { - obj['vatRegistrationNumber'] = ApiClient.convertToType(data['vatRegistrationNumber'], 'String'); - } if (data.hasOwnProperty('dateOfBirth')) { obj['dateOfBirth'] = ApiClient.convertToType(data['dateOfBirth'], 'String'); } @@ -138,17 +134,17 @@ */ exports.prototype['name'] = undefined; /** - * This field contains the first name of the entity funding the transaction. + * This field contains the first name of the entity funding the transaction Mandatory for card payments * @member {String} firstName */ exports.prototype['firstName'] = undefined; /** - * This field contains the last name of the entity funding the transaction. + * This field contains the last name of the entity funding the transaction Mandatory for card payments * @member {String} lastName */ exports.prototype['lastName'] = undefined; /** - * Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction + * This field contains the middle name of the entity funding the transaction * @member {String} middleName */ exports.prototype['middleName'] = undefined; @@ -158,35 +154,30 @@ */ exports.prototype['postalCode'] = undefined; /** - * Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. + * Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Required for card transactions * @member {String} address1 */ exports.prototype['address1'] = undefined; /** - * Used for additional address information. For example: Attention: Accounts Payable Optional field. This field is supported for only Mastercard Send. + * Used for additional address information. For example: Attention: Accounts Payable Optional field. * @member {String} address2 */ exports.prototype['address2'] = undefined; /** - * The sender's city Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. + * The sender's city Mandatory for card payments * @member {String} locality */ exports.prototype['locality'] = undefined; /** - * Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf + * Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Mandatory for card payments * @member {String} administrativeArea */ exports.prototype['administrativeArea'] = undefined; /** - * Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. Required for Mastercard Send + * Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf * @member {String} country */ exports.prototype['country'] = undefined; - /** - * Customer's government-assigned tax identification number. - * @member {String} vatRegistrationNumber - */ - exports.prototype['vatRegistrationNumber'] = undefined; /** * Sender's date of birth in YYYYMMDD format. * @member {String} dateOfBirth diff --git a/src/model/Ptsv1pushfundstransferSenderInformationAccount.js b/src/model/Ptsv1pushfundstransferSenderInformationAccount.js index 15bb2827..e076b191 100644 --- a/src/model/Ptsv1pushfundstransferSenderInformationAccount.js +++ b/src/model/Ptsv1pushfundstransferSenderInformationAccount.js @@ -78,7 +78,7 @@ */ exports.prototype['fundsSource'] = undefined; /** - * The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: FDC Compass (<= 19) Chase Paymentech (<= 16) + * The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: * @member {String} number */ exports.prototype['number'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js b/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js index 96b3c22f..d98b48f0 100644 --- a/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js +++ b/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js @@ -94,27 +94,27 @@ */ exports.prototype['type'] = undefined; /** - * 3-digit value that indicates the card Cvv2Value. Values can be 0-9. This field is supported in Mastercard Send. + * 3-digit value that indicates the card Cvv2Value. Values can be 0-9. * @member {String} securityCode */ exports.prototype['securityCode'] = undefined; /** - * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Valid values for Visa Platform Connect: - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account Valid values for Mastercard Send: - `00`: Other, - `01`: RTN + Bank Account, - `02`: IBAN, - `03`: Card Account, - `04`: Email, - `05`: Phone Number, - `06`: Bank account number (BAN) + Bank Identification Сode (BIC), - `07`: Wallet ID, - `08`: Social Network ID. Numeric, 2 characters. This field is supported in Mastercard Send. + * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. * @member {String} sourceAccountType */ exports.prototype['sourceAccountType'] = undefined; /** - * The customer's payment card number, also known as the Primary Account Number (PAN). This field is supported in Mastercard Send. + * The customer's payment card number, also known as the Primary Account Number (PAN). * @member {String} number */ exports.prototype['number'] = undefined; /** - * Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. This field is supported for Mastercard Send. + * Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. * @member {String} expirationMonth */ exports.prototype['expirationMonth'] = undefined; /** - * Four-digit year in which the payment card expires. This field is supported for Mastercard Send. + * Four-digit year in which the payment card expires. * @member {String} expirationYear */ exports.prototype['expirationYear'] = undefined; diff --git a/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js b/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js index 26823179..7e33a532 100644 --- a/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js +++ b/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js @@ -50,6 +50,7 @@ + }; /** @@ -72,12 +73,15 @@ if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } + if (data.hasOwnProperty('issuingCountry')) { + obj['issuingCountry'] = ApiClient.convertToType(data['issuingCountry'], 'String'); + } } return obj; } /** - * Visa Platform Connect(35) This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) + * Processor(35) * @member {String} id */ exports.prototype['id'] = undefined; @@ -87,10 +91,15 @@ */ exports.prototype['personalIdType'] = undefined; /** - * This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) + * This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `BTHD`: (Date of birth) - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `CPNY`: (Company registration number) - `PRXY`: (Proxy identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `LAWE`: (Law enforcement identification) - `MILI`: (Military identification) - `TRVL`: (Travel identification (non-passport)) - `EMAL`: (Email) - `PHON`: (Phone number) * @member {String} type */ exports.prototype['type'] = undefined; + /** + * Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. + * @member {String} issuingCountry + */ + exports.prototype['issuingCountry'] = undefined; diff --git a/src/model/Ptsv2billingagreementsAggregatorInformation.js b/src/model/Ptsv2billingagreementsAggregatorInformation.js index 41ebd2be..cfe88837 100644 --- a/src/model/Ptsv2billingagreementsAggregatorInformation.js +++ b/src/model/Ptsv2billingagreementsAggregatorInformation.js @@ -73,7 +73,7 @@ } /** - * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. * @member {String} name */ exports.prototype['name'] = undefined; diff --git a/src/model/Ptsv2billingagreementsBuyerInformation.js b/src/model/Ptsv2billingagreementsBuyerInformation.js index b5e0f3e3..017c716d 100644 --- a/src/model/Ptsv2billingagreementsBuyerInformation.js +++ b/src/model/Ptsv2billingagreementsBuyerInformation.js @@ -86,7 +86,7 @@ */ exports.prototype['merchantCustomerId'] = undefined; /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Ptsv2billingagreementsClientReferenceInformation.js b/src/model/Ptsv2billingagreementsClientReferenceInformation.js index a57cbd5e..07de5d4e 100644 --- a/src/model/Ptsv2billingagreementsClientReferenceInformation.js +++ b/src/model/Ptsv2billingagreementsClientReferenceInformation.js @@ -121,7 +121,7 @@ */ exports.prototype['transactionId'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/Ptsv2billingagreementsOrderInformationBillTo.js b/src/model/Ptsv2billingagreementsOrderInformationBillTo.js index 2d72cf1e..4bcd9342 100644 --- a/src/model/Ptsv2billingagreementsOrderInformationBillTo.js +++ b/src/model/Ptsv2billingagreementsOrderInformationBillTo.js @@ -169,7 +169,7 @@ */ exports.prototype['district'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Ptsv2billingagreementsidBuyerInformation.js b/src/model/Ptsv2billingagreementsidBuyerInformation.js index 0f625649..f615f697 100644 --- a/src/model/Ptsv2billingagreementsidBuyerInformation.js +++ b/src/model/Ptsv2billingagreementsidBuyerInformation.js @@ -77,7 +77,7 @@ } /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Ptsv2creditsProcessingInformation.js b/src/model/Ptsv2creditsProcessingInformation.js index 41a81f88..4de3919c 100644 --- a/src/model/Ptsv2creditsProcessingInformation.js +++ b/src/model/Ptsv2creditsProcessingInformation.js @@ -141,7 +141,7 @@ } /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @member {String} commerceIndicator */ exports.prototype['commerceIndicator'] = undefined; @@ -161,12 +161,12 @@ */ exports.prototype['reconciliationId'] = undefined; /** - * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @member {String} linkId */ exports.prototype['linkId'] = undefined; /** - * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @member {String} reportGroup */ exports.prototype['reportGroup'] = undefined; diff --git a/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js b/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js index 3c0eab0a..2cd10ba8 100644 --- a/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js +++ b/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js @@ -98,7 +98,7 @@ */ exports.prototype['customerMemo'] = undefined; /** - * Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry * @member {String} secCode */ exports.prototype['secCode'] = undefined; @@ -118,12 +118,12 @@ */ exports.prototype['effectiveDate'] = undefined; /** - * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. * @member {String} partialPaymentId */ exports.prototype['partialPaymentId'] = undefined; /** - * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @member {String} settlementMethod */ exports.prototype['settlementMethod'] = undefined; diff --git a/src/model/Ptsv2paymentreferencesBuyerInformation.js b/src/model/Ptsv2paymentreferencesBuyerInformation.js index 08c05d70..4c03597e 100644 --- a/src/model/Ptsv2paymentreferencesBuyerInformation.js +++ b/src/model/Ptsv2paymentreferencesBuyerInformation.js @@ -85,7 +85,7 @@ } /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Ptsv2paymentreferencesOrderInformationAmountDetails.js b/src/model/Ptsv2paymentreferencesOrderInformationAmountDetails.js index 3f55741e..79776814 100644 --- a/src/model/Ptsv2paymentreferencesOrderInformationAmountDetails.js +++ b/src/model/Ptsv2paymentreferencesOrderInformationAmountDetails.js @@ -117,12 +117,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; @@ -142,7 +142,7 @@ */ exports.prototype['dutyAmount'] = undefined; /** - * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) + * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @member {String} exchangeRate */ exports.prototype['exchangeRate'] = undefined; diff --git a/src/model/Ptsv2paymentreferencesPaymentInformationBank.js b/src/model/Ptsv2paymentreferencesPaymentInformationBank.js index 0acf7f8b..665bc871 100644 --- a/src/model/Ptsv2paymentreferencesPaymentInformationBank.js +++ b/src/model/Ptsv2paymentreferencesPaymentInformationBank.js @@ -73,7 +73,7 @@ } /** - * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @member {String} swiftCode */ exports.prototype['swiftCode'] = undefined; diff --git a/src/model/Ptsv2paymentreferencesPaymentInformationBankAccount.js b/src/model/Ptsv2paymentreferencesPaymentInformationBankAccount.js index 81a5ce0a..7e1bcd77 100644 --- a/src/model/Ptsv2paymentreferencesPaymentInformationBankAccount.js +++ b/src/model/Ptsv2paymentreferencesPaymentInformationBankAccount.js @@ -78,7 +78,7 @@ */ exports.prototype['number'] = undefined; /** - * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @member {String} iban */ exports.prototype['iban'] = undefined; diff --git a/src/model/Ptsv2paymentsAggregatorInformation.js b/src/model/Ptsv2paymentsAggregatorInformation.js index d4225f73..257c4e90 100644 --- a/src/model/Ptsv2paymentsAggregatorInformation.js +++ b/src/model/Ptsv2paymentsAggregatorInformation.js @@ -77,12 +77,12 @@ } /** - * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. * @member {String} aggregatorId */ exports.prototype['aggregatorId'] = undefined; /** - * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. * @member {String} name */ exports.prototype['name'] = undefined; diff --git a/src/model/Ptsv2paymentsBuyerInformation.js b/src/model/Ptsv2paymentsBuyerInformation.js index ad37d981..62d46e2e 100644 --- a/src/model/Ptsv2paymentsBuyerInformation.js +++ b/src/model/Ptsv2paymentsBuyerInformation.js @@ -109,17 +109,17 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; /** - * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @member {String} vatRegistrationNumber */ exports.prototype['vatRegistrationNumber'] = undefined; @@ -133,7 +133,7 @@ */ exports.prototype['personalIdentification'] = undefined; /** - * The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * The merchant's password that CyberSource hashes and stores as a hashed password. * @member {String} hashedPassword */ exports.prototype['hashedPassword'] = undefined; diff --git a/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js b/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js index e791bfd8..dca4bea2 100644 --- a/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js +++ b/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js @@ -81,17 +81,17 @@ } /** - * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. * @member {String} type */ exports.prototype['type'] = undefined; /** - * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. + * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @member {String} id */ exports.prototype['id'] = undefined; /** - * The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. * @member {String} issuedBy */ exports.prototype['issuedBy'] = undefined; diff --git a/src/model/Ptsv2paymentsClientReferenceInformation.js b/src/model/Ptsv2paymentsClientReferenceInformation.js index d06161be..d0e8ccc3 100644 --- a/src/model/Ptsv2paymentsClientReferenceInformation.js +++ b/src/model/Ptsv2paymentsClientReferenceInformation.js @@ -121,7 +121,7 @@ */ exports.prototype['transactionId'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js b/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js index f0933bfe..9f15f908 100644 --- a/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js +++ b/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js @@ -308,32 +308,32 @@ */ exports.prototype['cavvAlgorithm'] = undefined; /** - * Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Raw electronic commerce indicator (ECI). * @member {String} eciRaw */ exports.prototype['eciRaw'] = undefined; /** - * Payer authentication response status. For details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Payer authentication response status. * @member {String} paresStatus */ exports.prototype['paresStatus'] = undefined; /** - * Verification response enrollment status. For details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Verification response enrollment status. * @member {String} veresEnrolled */ exports.prototype['veresEnrolled'] = undefined; /** - * Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Transaction identifier. * @member {String} xid */ exports.prototype['xid'] = undefined; /** - * Universal cardholder authentication field (UCAF) collection indicator. For details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator + * Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator * @member {String} ucafCollectionIndicator */ exports.prototype['ucafCollectionIndicator'] = undefined; /** - * Universal cardholder authentication field (UCAF) data. For details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Universal cardholder authentication field (UCAF) data. * @member {String} ucafAuthenticationData */ exports.prototype['ucafAuthenticationData'] = undefined; @@ -402,7 +402,7 @@ */ exports.prototype['challengeCancelCode'] = undefined; /** - * Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) + * Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. * @member {String} challengeCode */ exports.prototype['challengeCode'] = undefined; diff --git a/src/model/Ptsv2paymentsMerchantDefinedInformation.js b/src/model/Ptsv2paymentsMerchantDefinedInformation.js index 62b13e04..7ed22bb1 100644 --- a/src/model/Ptsv2paymentsMerchantDefinedInformation.js +++ b/src/model/Ptsv2paymentsMerchantDefinedInformation.js @@ -73,12 +73,12 @@ } /** - * The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. * @member {String} key */ exports.prototype['key'] = undefined; /** - * The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 + * The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 * @member {String} value */ exports.prototype['value'] = undefined; diff --git a/src/model/Ptsv2paymentsOrderInformationAmountDetails.js b/src/model/Ptsv2paymentsOrderInformationAmountDetails.js index 55fc5a9b..852199d4 100644 --- a/src/model/Ptsv2paymentsOrderInformationAmountDetails.js +++ b/src/model/Ptsv2paymentsOrderInformationAmountDetails.js @@ -182,7 +182,7 @@ */ exports.prototype['giftWrapAmount'] = undefined; /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; @@ -192,7 +192,7 @@ */ exports.prototype['subTotalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; @@ -237,12 +237,12 @@ */ exports.prototype['taxTypeCode'] = undefined; /** - * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. * @member {String} freightAmount */ exports.prototype['freightAmount'] = undefined; /** - * Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Set this field to the converted amount that was returned by the DCC provider. * @member {String} foreignAmount */ exports.prototype['foreignAmount'] = undefined; @@ -252,7 +252,7 @@ */ exports.prototype['foreignCurrency'] = undefined; /** - * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) + * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @member {String} exchangeRate */ exports.prototype['exchangeRate'] = undefined; diff --git a/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js b/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js index a0521515..6ab3ee16 100644 --- a/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js +++ b/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js @@ -73,7 +73,7 @@ } /** - * Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type0` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Additional amount type. This field is supported only for **American Express Direct**. * @member {String} code */ exports.prototype['code'] = undefined; diff --git a/src/model/Ptsv2paymentsOrderInformationBillTo.js b/src/model/Ptsv2paymentsOrderInformationBillTo.js index f8864111..ab552849 100644 --- a/src/model/Ptsv2paymentsOrderInformationBillTo.js +++ b/src/model/Ptsv2paymentsOrderInformationBillTo.js @@ -245,7 +245,7 @@ */ exports.prototype['buildingNumber'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Ptsv2paymentsOrderInformationBillToCompany.js b/src/model/Ptsv2paymentsOrderInformationBillToCompany.js index 09946072..65b90ca3 100644 --- a/src/model/Ptsv2paymentsOrderInformationBillToCompany.js +++ b/src/model/Ptsv2paymentsOrderInformationBillToCompany.js @@ -93,7 +93,7 @@ } /** - * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @member {String} name */ exports.prototype['name'] = undefined; diff --git a/src/model/Ptsv2paymentsPaymentInformationBank.js b/src/model/Ptsv2paymentsPaymentInformationBank.js index 16ee2b4b..9e9f8cea 100644 --- a/src/model/Ptsv2paymentsPaymentInformationBank.js +++ b/src/model/Ptsv2paymentsPaymentInformationBank.js @@ -89,17 +89,17 @@ */ exports.prototype['account'] = undefined; /** - * Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Bank routing number. This is also called the _transit number_. * @member {String} routingNumber */ exports.prototype['routingNumber'] = undefined; /** - * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @member {String} iban */ exports.prototype['iban'] = undefined; /** - * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @member {String} swiftCode */ exports.prototype['swiftCode'] = undefined; diff --git a/src/model/Ptsv2paymentsPaymentInformationBankAccount.js b/src/model/Ptsv2paymentsPaymentInformationBankAccount.js index f36eb482..53a1b46c 100644 --- a/src/model/Ptsv2paymentsPaymentInformationBankAccount.js +++ b/src/model/Ptsv2paymentsPaymentInformationBankAccount.js @@ -99,7 +99,7 @@ */ exports.prototype['number'] = undefined; /** - * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @member {String} encoderId */ exports.prototype['encoderId'] = undefined; @@ -114,7 +114,7 @@ */ exports.prototype['checkImageReferenceNumber'] = undefined; /** - * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @member {String} iban */ exports.prototype['iban'] = undefined; diff --git a/src/model/Ptsv2paymentsPaymentInformationCustomer.js b/src/model/Ptsv2paymentsPaymentInformationCustomer.js index cd5ae539..5b4da439 100644 --- a/src/model/Ptsv2paymentsPaymentInformationCustomer.js +++ b/src/model/Ptsv2paymentsPaymentInformationCustomer.js @@ -73,7 +73,7 @@ } /** - * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @member {String} customerId */ exports.prototype['customerId'] = undefined; diff --git a/src/model/Ptsv2paymentsProcessingInformation.js b/src/model/Ptsv2paymentsProcessingInformation.js index 7b80a668..7328e2a7 100644 --- a/src/model/Ptsv2paymentsProcessingInformation.js +++ b/src/model/Ptsv2paymentsProcessingInformation.js @@ -244,17 +244,17 @@ */ exports.prototype['processorId'] = undefined; /** - * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @member {String} businessApplicationId */ exports.prototype['businessApplicationId'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @member {String} commerceIndicator */ exports.prototype['commerceIndicator'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @member {String} commerceIndicatorLabel */ exports.prototype['commerceIndicatorLabel'] = undefined; @@ -269,7 +269,7 @@ */ exports.prototype['reconciliationId'] = undefined; /** - * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @member {String} linkId */ exports.prototype['linkId'] = undefined; @@ -294,7 +294,7 @@ */ exports.prototype['paymentId'] = undefined; /** - * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @member {String} reportGroup */ exports.prototype['reportGroup'] = undefined; diff --git a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js index 030b14d0..97f1db99 100644 --- a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js +++ b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js @@ -153,7 +153,7 @@ } /** - * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. * @member {String} authType */ exports.prototype['authType'] = undefined; @@ -163,7 +163,7 @@ */ exports.prototype['panReturnIndicator'] = undefined; /** - * Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. * @member {String} verbalAuthCode */ exports.prototype['verbalAuthCode'] = undefined; diff --git a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.js b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.js index 50529206..67a3602e 100644 --- a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.js +++ b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.js @@ -86,7 +86,7 @@ */ exports.prototype['type'] = undefined; /** - * Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. + * Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. * @member {Boolean} credentialStoredOnFile */ exports.prototype['credentialStoredOnFile'] = undefined; diff --git a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js index d2e45b5c..82d4dbea 100644 --- a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js +++ b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js @@ -77,7 +77,7 @@ } /** - * Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code * @member {String} reason */ exports.prototype['reason'] = undefined; @@ -87,7 +87,7 @@ */ exports.prototype['previousTransactionId'] = undefined; /** - * Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. * @member {String} originalAuthorizedAmount */ exports.prototype['originalAuthorizedAmount'] = undefined; diff --git a/src/model/Ptsv2paymentsProcessingInformationBankTransferOptions.js b/src/model/Ptsv2paymentsProcessingInformationBankTransferOptions.js index f1cc6e53..c5cbeecb 100644 --- a/src/model/Ptsv2paymentsProcessingInformationBankTransferOptions.js +++ b/src/model/Ptsv2paymentsProcessingInformationBankTransferOptions.js @@ -114,7 +114,7 @@ */ exports.prototype['declineAvsFlags'] = undefined; /** - * Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry * @member {String} secCode */ exports.prototype['secCode'] = undefined; @@ -134,7 +134,7 @@ */ exports.prototype['effectiveDate'] = undefined; /** - * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. * @member {String} partialPaymentId */ exports.prototype['partialPaymentId'] = undefined; @@ -144,17 +144,17 @@ */ exports.prototype['customerMemo'] = undefined; /** - * Flag that indicates whether to process the payment. Use with deferred payments. For details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. + * Flag that indicates whether to process the payment. Use with deferred payments. Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. * @member {String} paymentCategoryCode */ exports.prototype['paymentCategoryCode'] = undefined; /** - * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @member {String} settlementMethod */ exports.prototype['settlementMethod'] = undefined; /** - * Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification * @member {String} fraudScreeningLevel */ exports.prototype['fraudScreeningLevel'] = undefined; diff --git a/src/model/Ptsv2paymentsTokenInformation.js b/src/model/Ptsv2paymentsTokenInformation.js index 9841e197..9efc801b 100644 --- a/src/model/Ptsv2paymentsTokenInformation.js +++ b/src/model/Ptsv2paymentsTokenInformation.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv2paymentsTokenInformationPaymentInstrument', 'model/Ptsv2paymentsTokenInformationShippingAddress'], factory); + define(['ApiClient', 'model/Ptsv2paymentsTokenInformationPaymentInstrument', 'model/Ptsv2paymentsTokenInformationShippingAddress', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationPaymentInstrument'), require('./Ptsv2paymentsTokenInformationShippingAddress')); + module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationPaymentInstrument'), require('./Ptsv2paymentsTokenInformationShippingAddress'), require('./Ptsv2paymentsTokenInformationTokenProvisioningInformation')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.Ptsv2paymentsTokenInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationPaymentInstrument, root.CyberSource.Ptsv2paymentsTokenInformationShippingAddress); + root.CyberSource.Ptsv2paymentsTokenInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationPaymentInstrument, root.CyberSource.Ptsv2paymentsTokenInformationShippingAddress, root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation); } -}(this, function(ApiClient, Ptsv2paymentsTokenInformationPaymentInstrument, Ptsv2paymentsTokenInformationShippingAddress) { +}(this, function(ApiClient, Ptsv2paymentsTokenInformationPaymentInstrument, Ptsv2paymentsTokenInformationShippingAddress, Ptsv2paymentsTokenInformationTokenProvisioningInformation) { 'use strict'; @@ -52,6 +52,7 @@ + }; /** @@ -80,6 +81,9 @@ if (data.hasOwnProperty('networkTokenOption')) { obj['networkTokenOption'] = ApiClient.convertToType(data['networkTokenOption'], 'String'); } + if (data.hasOwnProperty('tokenProvisioningInformation')) { + obj['tokenProvisioningInformation'] = Ptsv2paymentsTokenInformationTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); + } } return obj; } @@ -107,6 +111,10 @@ * @member {String} networkTokenOption */ exports.prototype['networkTokenOption'] = undefined; + /** + * @member {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} tokenProvisioningInformation + */ + exports.prototype['tokenProvisioningInformation'] = undefined; diff --git a/src/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.js b/src/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.js similarity index 74% rename from src/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.js rename to src/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.js index e8740c54..1a6eb1e9 100644 --- a/src/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.js +++ b/src/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.js @@ -25,7 +25,7 @@ if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation = factory(root.CyberSource.ApiClient); + root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation = factory(root.CyberSource.ApiClient); } }(this, function(ApiClient) { 'use strict'; @@ -34,14 +34,14 @@ /** - * The TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation model module. - * @module model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * The Ptsv2paymentsTokenInformationTokenProvisioningInformation model module. + * @module model/Ptsv2paymentsTokenInformationTokenProvisioningInformation * @version 0.0.1 */ /** - * Constructs a new TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation. - * @alias module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * Constructs a new Ptsv2paymentsTokenInformationTokenProvisioningInformation. + * @alias module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation * @class */ var exports = function() { @@ -52,11 +52,11 @@ }; /** - * Constructs a TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation from a plain JavaScript object, optionally creating a new instance. + * Constructs a Ptsv2paymentsTokenInformationTokenProvisioningInformation from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} obj Optional instance to populate. - * @return {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} The populated TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation instance. + * @param {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} obj Optional instance to populate. + * @return {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} The populated Ptsv2paymentsTokenInformationTokenProvisioningInformation instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/model/Ptsv2paymentsidOrderInformationAmountDetails.js b/src/model/Ptsv2paymentsidOrderInformationAmountDetails.js index b1864c53..7e71dbfc 100644 --- a/src/model/Ptsv2paymentsidOrderInformationAmountDetails.js +++ b/src/model/Ptsv2paymentsidOrderInformationAmountDetails.js @@ -78,7 +78,7 @@ */ exports.prototype['additionalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesAggregatorInformation.js b/src/model/Ptsv2paymentsidcapturesAggregatorInformation.js index 6e67ba3b..3516b055 100644 --- a/src/model/Ptsv2paymentsidcapturesAggregatorInformation.js +++ b/src/model/Ptsv2paymentsidcapturesAggregatorInformation.js @@ -77,12 +77,12 @@ } /** - * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. * @member {String} aggregatorId */ exports.prototype['aggregatorId'] = undefined; /** - * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. * @member {String} name */ exports.prototype['name'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesBuyerInformation.js b/src/model/Ptsv2paymentsidcapturesBuyerInformation.js index 2bc8ec49..db2c25c8 100644 --- a/src/model/Ptsv2paymentsidcapturesBuyerInformation.js +++ b/src/model/Ptsv2paymentsidcapturesBuyerInformation.js @@ -89,17 +89,17 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; /** - * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @member {String} vatRegistrationNumber */ exports.prototype['vatRegistrationNumber'] = undefined; /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js b/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js index becc38e4..c125147f 100644 --- a/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js +++ b/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js @@ -69,7 +69,7 @@ } /** - * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. + * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @member {String} id */ exports.prototype['id'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js b/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js index 84f3c5c1..42decb65 100644 --- a/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js +++ b/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js @@ -145,12 +145,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; @@ -195,12 +195,12 @@ */ exports.prototype['taxTypeCode'] = undefined; /** - * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. * @member {String} freightAmount */ exports.prototype['freightAmount'] = undefined; /** - * Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Set this field to the converted amount that was returned by the DCC provider. * @member {String} foreignAmount */ exports.prototype['foreignAmount'] = undefined; @@ -210,7 +210,7 @@ */ exports.prototype['foreignCurrency'] = undefined; /** - * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) + * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @member {String} exchangeRate */ exports.prototype['exchangeRate'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js b/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js index d877b1a8..30189afb 100644 --- a/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js +++ b/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js @@ -189,7 +189,7 @@ */ exports.prototype['country'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesProcessingInformation.js b/src/model/Ptsv2paymentsidcapturesProcessingInformation.js index d6f89695..5db407d9 100644 --- a/src/model/Ptsv2paymentsidcapturesProcessingInformation.js +++ b/src/model/Ptsv2paymentsidcapturesProcessingInformation.js @@ -127,12 +127,12 @@ */ exports.prototype['reconciliationId'] = undefined; /** - * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @member {String} linkId */ exports.prototype['linkId'] = undefined; /** - * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @member {String} reportGroup */ exports.prototype['reportGroup'] = undefined; diff --git a/src/model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.js b/src/model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.js index a3af8c1b..0fb649e3 100644 --- a/src/model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.js +++ b/src/model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.js @@ -77,12 +77,12 @@ } /** - * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. * @member {String} authType */ exports.prototype['authType'] = undefined; /** - * Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. * @member {String} verbalAuthCode */ exports.prototype['verbalAuthCode'] = undefined; diff --git a/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js b/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js index 29400585..278c88f1 100644 --- a/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js +++ b/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js @@ -130,7 +130,7 @@ */ exports.prototype['transactionId'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js b/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js index 08162ead..670d015c 100644 --- a/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js +++ b/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js @@ -85,17 +85,17 @@ */ exports.prototype['account'] = undefined; /** - * Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Bank routing number. This is also called the _transit number_. * @member {String} routingNumber */ exports.prototype['routingNumber'] = undefined; /** - * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @member {String} iban */ exports.prototype['iban'] = undefined; /** - * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @member {String} swiftCode */ exports.prototype['swiftCode'] = undefined; diff --git a/src/model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.js b/src/model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.js index 5fc74068..cfe2683f 100644 --- a/src/model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.js +++ b/src/model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.js @@ -95,7 +95,7 @@ */ exports.prototype['number'] = undefined; /** - * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @member {String} encoderId */ exports.prototype['encoderId'] = undefined; diff --git a/src/model/Ptsv2paymentsidrefundsProcessingInformation.js b/src/model/Ptsv2paymentsidrefundsProcessingInformation.js index 7c9e042c..f1de386f 100644 --- a/src/model/Ptsv2paymentsidrefundsProcessingInformation.js +++ b/src/model/Ptsv2paymentsidrefundsProcessingInformation.js @@ -124,12 +124,12 @@ */ exports.prototype['reconciliationId'] = undefined; /** - * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @member {String} linkId */ exports.prototype['linkId'] = undefined; /** - * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @member {String} reportGroup */ exports.prototype['reportGroup'] = undefined; diff --git a/src/model/Ptsv2paymentsidreversalsClientReferenceInformation.js b/src/model/Ptsv2paymentsidreversalsClientReferenceInformation.js index 55737ecb..8c927a4d 100644 --- a/src/model/Ptsv2paymentsidreversalsClientReferenceInformation.js +++ b/src/model/Ptsv2paymentsidreversalsClientReferenceInformation.js @@ -111,7 +111,7 @@ */ exports.prototype['pausedRequestId'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/Ptsv2paymentsidreversalsProcessingInformation.js b/src/model/Ptsv2paymentsidreversalsProcessingInformation.js index cc70e1ba..e5ec5e82 100644 --- a/src/model/Ptsv2paymentsidreversalsProcessingInformation.js +++ b/src/model/Ptsv2paymentsidreversalsProcessingInformation.js @@ -103,12 +103,12 @@ */ exports.prototype['reconciliationId'] = undefined; /** - * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @member {String} linkId */ exports.prototype['linkId'] = undefined; /** - * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @member {String} reportGroup */ exports.prototype['reportGroup'] = undefined; diff --git a/src/model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.js b/src/model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.js index c3adc128..64b828d4 100644 --- a/src/model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.js +++ b/src/model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.js @@ -73,12 +73,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Ptsv2payoutsOrderInformationAmountDetails.js b/src/model/Ptsv2payoutsOrderInformationAmountDetails.js index fe37e318..a2748bf7 100644 --- a/src/model/Ptsv2payoutsOrderInformationAmountDetails.js +++ b/src/model/Ptsv2payoutsOrderInformationAmountDetails.js @@ -77,12 +77,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Ptsv2payoutsRecipientInformation.js b/src/model/Ptsv2payoutsRecipientInformation.js index e1d057be..c55cd6c2 100644 --- a/src/model/Ptsv2payoutsRecipientInformation.js +++ b/src/model/Ptsv2payoutsRecipientInformation.js @@ -56,8 +56,6 @@ - - }; /** @@ -74,9 +72,6 @@ if (data.hasOwnProperty('firstName')) { obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String'); } - if (data.hasOwnProperty('middleInitial')) { - obj['middleInitial'] = ApiClient.convertToType(data['middleInitial'], 'String'); - } if (data.hasOwnProperty('middleName')) { obj['middleName'] = ApiClient.convertToType(data['middleName'], 'String'); } @@ -101,9 +96,6 @@ if (data.hasOwnProperty('phoneNumber')) { obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String'); } - if (data.hasOwnProperty('dateOfBirth')) { - obj['dateOfBirth'] = ApiClient.convertToType(data['dateOfBirth'], 'String'); - } } return obj; } @@ -113,11 +105,6 @@ * @member {String} firstName */ exports.prototype['firstName'] = undefined; - /** - * Middle Initial of recipient. Required only for FDCCompass. - * @member {String} middleInitial - */ - exports.prototype['middleInitial'] = undefined; /** * Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} middleName @@ -158,11 +145,6 @@ * @member {String} phoneNumber */ exports.prototype['phoneNumber'] = undefined; - /** - * Recipient date of birth in YYYYMMDD format. Required only for FDCCompass. - * @member {String} dateOfBirth - */ - exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js b/src/model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js index ad9232f1..b7dbf50a 100644 --- a/src/model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js +++ b/src/model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js @@ -69,7 +69,7 @@ } /** - * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @member {String} customerId */ exports.prototype['customerId'] = undefined; diff --git a/src/model/PushFunds201ResponseOrderInformationAmountDetails.js b/src/model/PushFunds201ResponseOrderInformationAmountDetails.js index eaec7c76..497d7b61 100644 --- a/src/model/PushFunds201ResponseOrderInformationAmountDetails.js +++ b/src/model/PushFunds201ResponseOrderInformationAmountDetails.js @@ -82,7 +82,7 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.994 Chase Paymentech: .01-9999999999.99 + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; diff --git a/src/model/PushFunds201ResponseProcessorInformation.js b/src/model/PushFunds201ResponseProcessorInformation.js index f09b5c09..bb16fb6a 100644 --- a/src/model/PushFunds201ResponseProcessorInformation.js +++ b/src/model/PushFunds201ResponseProcessorInformation.js @@ -51,8 +51,6 @@ - - }; /** @@ -72,15 +70,9 @@ if (data.hasOwnProperty('responseCode')) { obj['responseCode'] = ApiClient.convertToType(data['responseCode'], 'String'); } - if (data.hasOwnProperty('approvalCode')) { - obj['approvalCode'] = ApiClient.convertToType(data['approvalCode'], 'String'); - } if (data.hasOwnProperty('systemTraceAuditNumber')) { obj['systemTraceAuditNumber'] = ApiClient.convertToType(data['systemTraceAuditNumber'], 'String'); } - if (data.hasOwnProperty('responseCodeSource')) { - obj['responseCodeSource'] = ApiClient.convertToType(data['responseCodeSource'], 'String'); - } if (data.hasOwnProperty('retrievalReferenceNumber')) { obj['retrievalReferenceNumber'] = ApiClient.convertToType(data['retrievalReferenceNumber'], 'String'); } @@ -99,22 +91,12 @@ */ exports.prototype['responseCode'] = undefined; /** - * Issuer-generated approval code for the transaction. - * @member {String} approvalCode - */ - exports.prototype['approvalCode'] = undefined; - /** - * System audit number. Returned by authorization and incremental authorization services. Visa Platform Connect System trace number that must be printed on the customer's receipt. + * System audit number. Returned by authorization and incremental authorization services. * @member {String} systemTraceAuditNumber */ exports.prototype['systemTraceAuditNumber'] = undefined; /** - * Used by Visa only and contains the response source/reason code that identifies the source of the response decision. - * @member {String} responseCodeSource - */ - exports.prototype['responseCodeSource'] = undefined; - /** - * Unique reference number returned by the processor that identifies the transaction at the network. Supported by Mastercard Send + * Unique reference number returned by the processor that identifies the transaction at the network. * @member {String} retrievalReferenceNumber */ exports.prototype['retrievalReferenceNumber'] = undefined; diff --git a/src/model/PushFunds400Response.js b/src/model/PushFunds400Response.js index d79c70cf..f023bdbf 100644 --- a/src/model/PushFunds400Response.js +++ b/src/model/PushFunds400Response.js @@ -109,7 +109,7 @@ */ exports.prototype['reason'] = undefined; /** - * The detail message related to the status and reason listed above. Possible values: - Declined - One or more fields in the request contains invalid data - Declined - The request is missing one or more fields - Declined - There is a problem with your CyberSource merchant configuration. + * The detail message related to the status and reason listed above. Possible values: - One or more fields in the request contains invalid data. - The request is missing one or more required fields. - Declined - There is a problem with your CyberSource merchant configuration. * @member {String} message */ exports.prototype['message'] = undefined; diff --git a/src/model/PushFundsRequest.js b/src/model/PushFundsRequest.js index 11751074..6013faef 100644 --- a/src/model/PushFundsRequest.js +++ b/src/model/PushFundsRequest.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Ptsv1pushfundstransferAggregatorInformation', 'model/Ptsv1pushfundstransferClientReferenceInformation', 'model/Ptsv1pushfundstransferMerchantDefinedInformation', 'model/Ptsv1pushfundstransferMerchantInformation', 'model/Ptsv1pushfundstransferOrderInformation', 'model/Ptsv1pushfundstransferPointOfServiceInformation', 'model/Ptsv1pushfundstransferProcessingInformation', 'model/Ptsv1pushfundstransferProcessingOptions', 'model/Ptsv1pushfundstransferRecipientInformation', 'model/Ptsv1pushfundstransferSenderInformation'], factory); + define(['ApiClient', 'model/Ptsv1pushfundstransferClientReferenceInformation', 'model/Ptsv1pushfundstransferOrderInformation', 'model/Ptsv1pushfundstransferProcessingInformation', 'model/Ptsv1pushfundstransferRecipientInformation', 'model/Ptsv1pushfundstransferSenderInformation'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferAggregatorInformation'), require('./Ptsv1pushfundstransferClientReferenceInformation'), require('./Ptsv1pushfundstransferMerchantDefinedInformation'), require('./Ptsv1pushfundstransferMerchantInformation'), require('./Ptsv1pushfundstransferOrderInformation'), require('./Ptsv1pushfundstransferPointOfServiceInformation'), require('./Ptsv1pushfundstransferProcessingInformation'), require('./Ptsv1pushfundstransferProcessingOptions'), require('./Ptsv1pushfundstransferRecipientInformation'), require('./Ptsv1pushfundstransferSenderInformation')); + module.exports = factory(require('../ApiClient'), require('./Ptsv1pushfundstransferClientReferenceInformation'), require('./Ptsv1pushfundstransferOrderInformation'), require('./Ptsv1pushfundstransferProcessingInformation'), require('./Ptsv1pushfundstransferRecipientInformation'), require('./Ptsv1pushfundstransferSenderInformation')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.PushFundsRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferAggregatorInformation, root.CyberSource.Ptsv1pushfundstransferClientReferenceInformation, root.CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation, root.CyberSource.Ptsv1pushfundstransferMerchantInformation, root.CyberSource.Ptsv1pushfundstransferOrderInformation, root.CyberSource.Ptsv1pushfundstransferPointOfServiceInformation, root.CyberSource.Ptsv1pushfundstransferProcessingInformation, root.CyberSource.Ptsv1pushfundstransferProcessingOptions, root.CyberSource.Ptsv1pushfundstransferRecipientInformation, root.CyberSource.Ptsv1pushfundstransferSenderInformation); + root.CyberSource.PushFundsRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv1pushfundstransferClientReferenceInformation, root.CyberSource.Ptsv1pushfundstransferOrderInformation, root.CyberSource.Ptsv1pushfundstransferProcessingInformation, root.CyberSource.Ptsv1pushfundstransferRecipientInformation, root.CyberSource.Ptsv1pushfundstransferSenderInformation); } -}(this, function(ApiClient, Ptsv1pushfundstransferAggregatorInformation, Ptsv1pushfundstransferClientReferenceInformation, Ptsv1pushfundstransferMerchantDefinedInformation, Ptsv1pushfundstransferMerchantInformation, Ptsv1pushfundstransferOrderInformation, Ptsv1pushfundstransferPointOfServiceInformation, Ptsv1pushfundstransferProcessingInformation, Ptsv1pushfundstransferProcessingOptions, Ptsv1pushfundstransferRecipientInformation, Ptsv1pushfundstransferSenderInformation) { +}(this, function(ApiClient, Ptsv1pushfundstransferClientReferenceInformation, Ptsv1pushfundstransferOrderInformation, Ptsv1pushfundstransferProcessingInformation, Ptsv1pushfundstransferRecipientInformation, Ptsv1pushfundstransferSenderInformation) { 'use strict'; @@ -45,9 +45,8 @@ * @class * @param orderInformation {module:model/Ptsv1pushfundstransferOrderInformation} * @param processingInformation {module:model/Ptsv1pushfundstransferProcessingInformation} - * @param senderInformation {module:model/Ptsv1pushfundstransferSenderInformation} */ - var exports = function(orderInformation, processingInformation, senderInformation) { + var exports = function(orderInformation, processingInformation) { var _this = this; @@ -55,11 +54,6 @@ _this['processingInformation'] = processingInformation; - _this['senderInformation'] = senderInformation; - - - - }; /** @@ -82,27 +76,12 @@ if (data.hasOwnProperty('processingInformation')) { obj['processingInformation'] = Ptsv1pushfundstransferProcessingInformation.constructFromObject(data['processingInformation']); } - if (data.hasOwnProperty('processingOptions')) { - obj['processingOptions'] = Ptsv1pushfundstransferProcessingOptions.constructFromObject(data['processingOptions']); - } if (data.hasOwnProperty('recipientInformation')) { obj['recipientInformation'] = Ptsv1pushfundstransferRecipientInformation.constructFromObject(data['recipientInformation']); } if (data.hasOwnProperty('senderInformation')) { obj['senderInformation'] = Ptsv1pushfundstransferSenderInformation.constructFromObject(data['senderInformation']); } - if (data.hasOwnProperty('aggregatorInformation')) { - obj['aggregatorInformation'] = Ptsv1pushfundstransferAggregatorInformation.constructFromObject(data['aggregatorInformation']); - } - if (data.hasOwnProperty('merchantDefinedInformation')) { - obj['merchantDefinedInformation'] = Ptsv1pushfundstransferMerchantDefinedInformation.constructFromObject(data['merchantDefinedInformation']); - } - if (data.hasOwnProperty('merchantInformation')) { - obj['merchantInformation'] = Ptsv1pushfundstransferMerchantInformation.constructFromObject(data['merchantInformation']); - } - if (data.hasOwnProperty('pointOfServiceInformation')) { - obj['pointOfServiceInformation'] = Ptsv1pushfundstransferPointOfServiceInformation.constructFromObject(data['pointOfServiceInformation']); - } } return obj; } @@ -119,10 +98,6 @@ * @member {module:model/Ptsv1pushfundstransferProcessingInformation} processingInformation */ exports.prototype['processingInformation'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferProcessingOptions} processingOptions - */ - exports.prototype['processingOptions'] = undefined; /** * @member {module:model/Ptsv1pushfundstransferRecipientInformation} recipientInformation */ @@ -131,22 +106,6 @@ * @member {module:model/Ptsv1pushfundstransferSenderInformation} senderInformation */ exports.prototype['senderInformation'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferAggregatorInformation} aggregatorInformation - */ - exports.prototype['aggregatorInformation'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferMerchantDefinedInformation} merchantDefinedInformation - */ - exports.prototype['merchantDefinedInformation'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferMerchantInformation} merchantInformation - */ - exports.prototype['merchantInformation'] = undefined; - /** - * @member {module:model/Ptsv1pushfundstransferPointOfServiceInformation} pointOfServiceInformation - */ - exports.prototype['pointOfServiceInformation'] = undefined; diff --git a/src/model/Rbsv1plansOrderInformationAmountDetails.js b/src/model/Rbsv1plansOrderInformationAmountDetails.js index 88901d44..b7e51fd4 100644 --- a/src/model/Rbsv1plansOrderInformationAmountDetails.js +++ b/src/model/Rbsv1plansOrderInformationAmountDetails.js @@ -43,7 +43,7 @@ * Constructs a new Rbsv1plansOrderInformationAmountDetails. * @alias module:model/Rbsv1plansOrderInformationAmountDetails * @class - * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @param billingAmount {String} Billing amount for the billing period. */ var exports = function(currency, billingAmount) { @@ -79,7 +79,7 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.js b/src/model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.js index b8a81912..1ab9ff2f 100644 --- a/src/model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.js +++ b/src/model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.js @@ -97,7 +97,7 @@ } /** - * Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/) #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. + * Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. * @member {String} addressType */ exports.prototype['addressType'] = undefined; diff --git a/src/model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.js b/src/model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.js index dc807e2f..06c9718a 100644 --- a/src/model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.js +++ b/src/model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.js @@ -269,7 +269,7 @@ */ exports.prototype['acsUrl'] = undefined; /** - * Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. * @member {String} authenticationPath */ exports.prototype['authenticationPath'] = undefined; @@ -383,7 +383,7 @@ */ exports.prototype['paresStatus'] = undefined; /** - * Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. + * Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. * @member {String} proofXml */ exports.prototype['proofXml'] = undefined; @@ -428,7 +428,7 @@ */ exports.prototype['ucafCollectionIndicator'] = undefined; /** - * Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. * @member {String} veresEnrolled */ exports.prototype['veresEnrolled'] = undefined; diff --git a/src/model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.js b/src/model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.js index cc3dfdc9..d27be7ca 100644 --- a/src/model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.js +++ b/src/model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.js @@ -69,7 +69,7 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/RiskV1DecisionsPost201ResponsePaymentInformation.js b/src/model/RiskV1DecisionsPost201ResponsePaymentInformation.js index 75a98c9e..2696c5f9 100644 --- a/src/model/RiskV1DecisionsPost201ResponsePaymentInformation.js +++ b/src/model/RiskV1DecisionsPost201ResponsePaymentInformation.js @@ -86,27 +86,27 @@ } /** - * Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. * @member {String} binCountry */ exports.prototype['binCountry'] = undefined; /** - * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. * @member {String} accountType */ exports.prototype['accountType'] = undefined; /** - * Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Name of the bank or entity that issued the card account. * @member {String} issuer */ exports.prototype['issuer'] = undefined; /** - * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. * @member {String} scheme */ exports.prototype['scheme'] = undefined; /** - * Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. * @member {String} bin */ exports.prototype['bin'] = undefined; diff --git a/src/model/Riskv1authenticationresultsOrderInformationAmountDetails.js b/src/model/Riskv1authenticationresultsOrderInformationAmountDetails.js index c67364f5..68bca00a 100644 --- a/src/model/Riskv1authenticationresultsOrderInformationAmountDetails.js +++ b/src/model/Riskv1authenticationresultsOrderInformationAmountDetails.js @@ -74,12 +74,12 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; diff --git a/src/model/Riskv1authenticationsBuyerInformation.js b/src/model/Riskv1authenticationsBuyerInformation.js index 98350341..0ae19931 100644 --- a/src/model/Riskv1authenticationsBuyerInformation.js +++ b/src/model/Riskv1authenticationsBuyerInformation.js @@ -82,7 +82,7 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; diff --git a/src/model/Riskv1authenticationsOrderInformationAmountDetails.js b/src/model/Riskv1authenticationsOrderInformationAmountDetails.js index a9a7e0e5..7dadfce2 100644 --- a/src/model/Riskv1authenticationsOrderInformationAmountDetails.js +++ b/src/model/Riskv1authenticationsOrderInformationAmountDetails.js @@ -44,8 +44,8 @@ * Contains `currency` and `totalAmount` for this order. * @alias module:model/Riskv1authenticationsOrderInformationAmountDetails * @class - * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. - * @param totalAmount {String} Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param totalAmount {String} Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. */ var exports = function(currency, totalAmount) { var _this = this; @@ -76,12 +76,12 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; diff --git a/src/model/Riskv1authenticationsOrderInformationBillTo.js b/src/model/Riskv1authenticationsOrderInformationBillTo.js index 6b992bf3..7229fd47 100644 --- a/src/model/Riskv1authenticationsOrderInformationBillTo.js +++ b/src/model/Riskv1authenticationsOrderInformationBillTo.js @@ -48,7 +48,7 @@ * @param country {String} Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @param firstName {String} Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @param lastName {String} Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. - * @param email {String} Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param email {String} Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @param 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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. */ var exports = function(address1, administrativeArea, country, firstName, lastName, email, postalCode) { @@ -161,7 +161,7 @@ */ exports.prototype['phoneNumber'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Riskv1decisionsBuyerInformation.js b/src/model/Riskv1decisionsBuyerInformation.js index 68f2b901..62c63a9f 100644 --- a/src/model/Riskv1decisionsBuyerInformation.js +++ b/src/model/Riskv1decisionsBuyerInformation.js @@ -86,7 +86,7 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; @@ -96,12 +96,12 @@ */ exports.prototype['username'] = undefined; /** - * The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * The merchant's password that CyberSource hashes and stores as a hashed password. * @member {String} hashedPassword */ exports.prototype['hashedPassword'] = undefined; /** - * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. * @member {String} dateOfBirth */ exports.prototype['dateOfBirth'] = undefined; diff --git a/src/model/Riskv1decisionsConsumerAuthenticationInformation.js b/src/model/Riskv1decisionsConsumerAuthenticationInformation.js index 6f45f7f1..c6bd492b 100644 --- a/src/model/Riskv1decisionsConsumerAuthenticationInformation.js +++ b/src/model/Riskv1decisionsConsumerAuthenticationInformation.js @@ -282,7 +282,7 @@ */ exports.prototype['challengeCancelCode'] = undefined; /** - * Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) + * Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. * @member {String} challengeCode */ exports.prototype['challengeCode'] = undefined; diff --git a/src/model/Riskv1decisionsOrderInformationAmountDetails.js b/src/model/Riskv1decisionsOrderInformationAmountDetails.js index 9b9a1f66..0a31e2b8 100644 --- a/src/model/Riskv1decisionsOrderInformationAmountDetails.js +++ b/src/model/Riskv1decisionsOrderInformationAmountDetails.js @@ -44,7 +44,7 @@ * Contains `currency` and `totalAmount` for this order. * @alias module:model/Riskv1decisionsOrderInformationAmountDetails * @class - * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param currency {String} Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. */ var exports = function(currency) { var _this = this; @@ -75,7 +75,7 @@ } /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Riskv1decisionsOrderInformationBillTo.js b/src/model/Riskv1decisionsOrderInformationBillTo.js index a607694e..70749223 100644 --- a/src/model/Riskv1decisionsOrderInformationBillTo.js +++ b/src/model/Riskv1decisionsOrderInformationBillTo.js @@ -145,7 +145,7 @@ */ exports.prototype['phoneNumber'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Riskv1decisionsProcessorInformationCardVerification.js b/src/model/Riskv1decisionsProcessorInformationCardVerification.js index dc9fb936..79b6e266 100644 --- a/src/model/Riskv1decisionsProcessorInformationCardVerification.js +++ b/src/model/Riskv1decisionsProcessorInformationCardVerification.js @@ -69,7 +69,7 @@ } /** - * CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * CVN result code. * @member {String} resultCode */ exports.prototype['resultCode'] = undefined; diff --git a/src/model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.js b/src/model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.js index 9a4d6da3..79b7dad4 100644 --- a/src/model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.js +++ b/src/model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.js @@ -47,7 +47,7 @@ * @param country {String} Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @param locality {String} Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @param 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` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. - * @param email {String} Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param email {String} Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. */ var exports = function(address1, country, locality, postalCode, email) { var _this = this; @@ -172,7 +172,7 @@ */ exports.prototype['lastName'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/Riskv1liststypeentriesOrderInformationBillTo.js b/src/model/Riskv1liststypeentriesOrderInformationBillTo.js index 01149080..b0615e40 100644 --- a/src/model/Riskv1liststypeentriesOrderInformationBillTo.js +++ b/src/model/Riskv1liststypeentriesOrderInformationBillTo.js @@ -154,7 +154,7 @@ */ exports.prototype['phoneNumber'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/TmsEmbeddedInstrumentIdentifier.js b/src/model/TmsEmbeddedInstrumentIdentifier.js index a0af6025..e8bd0ac5 100644 --- a/src/model/TmsEmbeddedInstrumentIdentifier.js +++ b/src/model/TmsEmbeddedInstrumentIdentifier.js @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); + define(['ApiClient', 'model/Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'model/TmsEmbeddedInstrumentIdentifierBankAccount', 'model/TmsEmbeddedInstrumentIdentifierBillTo', 'model/TmsEmbeddedInstrumentIdentifierCard', 'model/TmsEmbeddedInstrumentIdentifierIssuer', 'model/TmsEmbeddedInstrumentIdentifierLinks', 'model/TmsEmbeddedInstrumentIdentifierMetadata', 'model/TmsEmbeddedInstrumentIdentifierProcessingInformation', 'model/TmsEmbeddedInstrumentIdentifierTokenizedCard'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); + module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsTokenInformationTokenProvisioningInformation'), require('./TmsEmbeddedInstrumentIdentifierBankAccount'), require('./TmsEmbeddedInstrumentIdentifierBillTo'), require('./TmsEmbeddedInstrumentIdentifierCard'), require('./TmsEmbeddedInstrumentIdentifierIssuer'), require('./TmsEmbeddedInstrumentIdentifierLinks'), require('./TmsEmbeddedInstrumentIdentifierMetadata'), require('./TmsEmbeddedInstrumentIdentifierProcessingInformation'), require('./TmsEmbeddedInstrumentIdentifierTokenizedCard')); } else { // Browser globals (root is window) if (!root.CyberSource) { root.CyberSource = {}; } - root.CyberSource.TmsEmbeddedInstrumentIdentifier = factory(root.CyberSource.ApiClient, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); + root.CyberSource.TmsEmbeddedInstrumentIdentifier = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierBankAccount, root.CyberSource.TmsEmbeddedInstrumentIdentifierBillTo, root.CyberSource.TmsEmbeddedInstrumentIdentifierCard, root.CyberSource.TmsEmbeddedInstrumentIdentifierIssuer, root.CyberSource.TmsEmbeddedInstrumentIdentifierLinks, root.CyberSource.TmsEmbeddedInstrumentIdentifierMetadata, root.CyberSource.TmsEmbeddedInstrumentIdentifierProcessingInformation, root.CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard); } -}(this, function(ApiClient, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { +}(this, function(ApiClient, Ptsv2paymentsTokenInformationTokenProvisioningInformation, TmsEmbeddedInstrumentIdentifierBankAccount, TmsEmbeddedInstrumentIdentifierBillTo, TmsEmbeddedInstrumentIdentifierCard, TmsEmbeddedInstrumentIdentifierIssuer, TmsEmbeddedInstrumentIdentifierLinks, TmsEmbeddedInstrumentIdentifierMetadata, TmsEmbeddedInstrumentIdentifierProcessingInformation, TmsEmbeddedInstrumentIdentifierTokenizedCard) { 'use strict'; @@ -89,7 +89,7 @@ obj['type'] = ApiClient.convertToType(data['type'], 'String'); } if (data.hasOwnProperty('tokenProvisioningInformation')) { - obj['tokenProvisioningInformation'] = TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); + obj['tokenProvisioningInformation'] = Ptsv2paymentsTokenInformationTokenProvisioningInformation.constructFromObject(data['tokenProvisioningInformation']); } if (data.hasOwnProperty('card')) { obj['card'] = TmsEmbeddedInstrumentIdentifierCard.constructFromObject(data['card']); @@ -136,12 +136,12 @@ */ exports.prototype['state'] = undefined; /** - * The type of Instrument Identifier. Possible Values: - enrollable card + * The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @member {String} type */ exports.prototype['type'] = undefined; /** - * @member {module:model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation} tokenProvisioningInformation + * @member {module:model/Ptsv2paymentsTokenInformationTokenProvisioningInformation} tokenProvisioningInformation */ exports.prototype['tokenProvisioningInformation'] = undefined; /** diff --git a/src/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.js b/src/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.js index 40ca8fb4..b3d1eb98 100644 --- a/src/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.js +++ b/src/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.js @@ -57,6 +57,7 @@ + }; /** @@ -73,6 +74,9 @@ if (data.hasOwnProperty('type')) { obj['type'] = ApiClient.convertToType(data['type'], 'String'); } + if (data.hasOwnProperty('source')) { + obj['source'] = ApiClient.convertToType(data['source'], 'String'); + } if (data.hasOwnProperty('state')) { obj['state'] = ApiClient.convertToType(data['state'], 'String'); } @@ -109,6 +113,11 @@ * @member {String} type */ exports.prototype['type'] = undefined; + /** + * This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data. Possible Values: - TOKEN - ISSUER - ONFILE + * @member {String} source + */ + exports.prototype['source'] = undefined; /** * 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 provision was unsuccessful. * @member {String} state diff --git a/src/model/TssV2TransactionsGet200ResponseBuyerInformation.js b/src/model/TssV2TransactionsGet200ResponseBuyerInformation.js index d5512fb9..443388b0 100644 --- a/src/model/TssV2TransactionsGet200ResponseBuyerInformation.js +++ b/src/model/TssV2TransactionsGet200ResponseBuyerInformation.js @@ -73,12 +73,12 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; /** - * The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * The merchant's password that CyberSource hashes and stores as a hashed password. * @member {String} hashedPassword */ exports.prototype['hashedPassword'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.js b/src/model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.js index 865d89d2..69634a69 100644 --- a/src/model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.js +++ b/src/model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.js @@ -85,7 +85,7 @@ } /** - * Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Raw electronic commerce indicator (ECI). * @member {String} eciRaw */ exports.prototype['eciRaw'] = undefined; @@ -95,7 +95,7 @@ */ exports.prototype['cavv'] = undefined; /** - * Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Transaction identifier. * @member {String} xid */ exports.prototype['xid'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js b/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js index f18fedbb..d500462e 100644 --- a/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js +++ b/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js @@ -93,12 +93,12 @@ } /** - * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @member {String} totalAmount */ exports.prototype['totalAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; @@ -108,7 +108,7 @@ */ exports.prototype['taxAmount'] = undefined; /** - * Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. + * Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. * @member {String} authorizedAmount */ exports.prototype['authorizedAmount'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseOrderInformationBillTo.js b/src/model/TssV2TransactionsGet200ResponseOrderInformationBillTo.js index e84b713c..f9303ca9 100644 --- a/src/model/TssV2TransactionsGet200ResponseOrderInformationBillTo.js +++ b/src/model/TssV2TransactionsGet200ResponseOrderInformationBillTo.js @@ -166,12 +166,12 @@ */ exports.prototype['postalCode'] = undefined; /** - * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @member {String} company */ exports.prototype['company'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponsePaymentInformationBank.js b/src/model/TssV2TransactionsGet200ResponsePaymentInformationBank.js index 654db474..142de6c5 100644 --- a/src/model/TssV2TransactionsGet200ResponsePaymentInformationBank.js +++ b/src/model/TssV2TransactionsGet200ResponsePaymentInformationBank.js @@ -93,27 +93,27 @@ } /** - * Bank routing number. This is also called the transit number. For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * Bank routing number. This is also called the transit number. * @member {String} routingNumber */ exports.prototype['routingNumber'] = undefined; /** - * Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. For all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. * @member {String} branchCode */ exports.prototype['branchCode'] = undefined; /** - * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @member {String} swiftCode */ exports.prototype['swiftCode'] = undefined; /** - * Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. * @member {String} bankCode */ exports.prototype['bankCode'] = undefined; /** - * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @member {String} iban */ exports.prototype['iban'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.js b/src/model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.js index 4b06d0e1..f25adf45 100644 --- a/src/model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.js +++ b/src/model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.js @@ -118,12 +118,12 @@ */ exports.prototype['name'] = undefined; /** - * Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. For all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. * @member {String} checkDigit */ exports.prototype['checkDigit'] = undefined; /** - * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @member {String} encoderId */ exports.prototype['encoderId'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.js b/src/model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.js index a4a1247f..95fad895 100644 --- a/src/model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.js +++ b/src/model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.js @@ -73,7 +73,7 @@ } /** - * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @member {String} customerId */ exports.prototype['customerId'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js b/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js index 9515ffb3..5e2dbf91 100644 --- a/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +++ b/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js @@ -124,17 +124,17 @@ */ exports.prototype['paymentSolution'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @member {String} commerceIndicator */ exports.prototype['commerceIndicator'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @member {String} commerceIndicatorLabel */ exports.prototype['commerceIndicatorLabel'] = undefined; /** - * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @member {String} businessApplicationId */ exports.prototype['businessApplicationId'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js b/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js index d1efd6fb..018c8ca7 100644 --- a/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js +++ b/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js @@ -85,7 +85,7 @@ } /** - * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. * @member {String} authType */ exports.prototype['authType'] = undefined; diff --git a/src/model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.js b/src/model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.js index 149879f1..9579d708 100644 --- a/src/model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.js +++ b/src/model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.js @@ -105,7 +105,7 @@ } /** - * Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's email address. * @member {String} email */ exports.prototype['email'] = undefined; @@ -125,7 +125,7 @@ */ exports.prototype['nameRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's phone number. * @member {String} phoneNumber */ exports.prototype['phoneNumber'] = undefined; @@ -135,7 +135,7 @@ */ exports.prototype['phoneNumberRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's street address. * @member {String} street */ exports.prototype['street'] = undefined; @@ -145,7 +145,7 @@ */ exports.prototype['streetRaw'] = undefined; /** - * Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Mapped Electronic Verification response code for the customer's postal code. * @member {String} postalCode */ exports.prototype['postalCode'] = undefined; diff --git a/src/model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.js b/src/model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.js index 79a0dcf9..c79abc12 100644 --- a/src/model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.js +++ b/src/model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.js @@ -69,7 +69,7 @@ } /** - * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @member {String} merchantCustomerId */ exports.prototype['merchantCustomerId'] = undefined; diff --git a/src/model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.js b/src/model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.js index 86b43b0f..9705e786 100644 --- a/src/model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.js +++ b/src/model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.js @@ -77,7 +77,7 @@ } /** - * Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Transaction identifier. * @member {String} xid */ exports.prototype['xid'] = undefined; @@ -87,7 +87,7 @@ */ exports.prototype['transactionId'] = undefined; /** - * Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * Raw electronic commerce indicator (ECI). * @member {String} eciRaw */ exports.prototype['eciRaw'] = undefined; diff --git a/src/model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.js b/src/model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.js index 733b2e3a..e1c0dbaf 100644 --- a/src/model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.js +++ b/src/model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.js @@ -104,7 +104,7 @@ */ exports.prototype['address1'] = undefined; /** - * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @member {String} email */ exports.prototype['email'] = undefined; diff --git a/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js b/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js index 60734d3f..9a50b24c 100644 --- a/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js +++ b/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js @@ -86,17 +86,17 @@ */ exports.prototype['paymentSolution'] = undefined; /** - * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @member {String} businessApplicationId */ exports.prototype['businessApplicationId'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @member {String} commerceIndicator */ exports.prototype['commerceIndicator'] = undefined; /** - * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @member {String} commerceIndicatorLabel */ exports.prototype['commerceIndicatorLabel'] = undefined; diff --git a/src/model/VasV2TaxVoid200ResponseVoidAmountDetails.js b/src/model/VasV2TaxVoid200ResponseVoidAmountDetails.js index 33f4ee43..a685c6bf 100644 --- a/src/model/VasV2TaxVoid200ResponseVoidAmountDetails.js +++ b/src/model/VasV2TaxVoid200ResponseVoidAmountDetails.js @@ -78,7 +78,7 @@ */ exports.prototype['voidAmount'] = undefined; /** - * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @member {String} currency */ exports.prototype['currency'] = undefined; diff --git a/src/model/Vasv2taxBuyerInformation.js b/src/model/Vasv2taxBuyerInformation.js index f45dfff5..87893afb 100644 --- a/src/model/Vasv2taxBuyerInformation.js +++ b/src/model/Vasv2taxBuyerInformation.js @@ -69,7 +69,7 @@ } /** - * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @member {String} vatRegistrationNumber */ exports.prototype['vatRegistrationNumber'] = undefined; diff --git a/src/model/Vasv2taxClientReferenceInformation.js b/src/model/Vasv2taxClientReferenceInformation.js index 572b79b5..d5274c41 100644 --- a/src/model/Vasv2taxClientReferenceInformation.js +++ b/src/model/Vasv2taxClientReferenceInformation.js @@ -86,7 +86,7 @@ */ exports.prototype['partner'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/src/model/Vasv2taxidClientReferenceInformation.js b/src/model/Vasv2taxidClientReferenceInformation.js index 7697b8f7..a33d572c 100644 --- a/src/model/Vasv2taxidClientReferenceInformation.js +++ b/src/model/Vasv2taxidClientReferenceInformation.js @@ -82,7 +82,7 @@ */ exports.prototype['code'] = undefined; /** - * Comments + * Brief description of the order or any comment you wish to add to the order. * @member {String} comments */ exports.prototype['comments'] = undefined; diff --git a/test/model/Ptsv1pushfundstransferAggregatorInformation.spec.js b/test/model/Ptsv1pushfundstransferAggregatorInformation.spec.js deleted file mode 100644 index 4b6959b0..00000000 --- a/test/model/Ptsv1pushfundstransferAggregatorInformation.spec.js +++ /dev/null @@ -1,79 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferAggregatorInformation(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferAggregatorInformation', function() { - it('should create an instance of Ptsv1pushfundstransferAggregatorInformation', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferAggregatorInformation - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformation(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferAggregatorInformation); - }); - - it('should have the property aggregatorId (base name: "aggregatorId")', function() { - // uncomment below and update the code to test the property aggregatorId - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformation(); - //expect(instance).to.be(); - }); - - it('should have the property name (base name: "name")', function() { - // uncomment below and update the code to test the property name - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformation(); - //expect(instance).to.be(); - }); - - it('should have the property subMerchant (base name: "subMerchant")', function() { - // uncomment below and update the code to test the property subMerchant - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformation(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.spec.js b/test/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.spec.js deleted file mode 100644 index 545ff316..00000000 --- a/test/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.spec.js +++ /dev/null @@ -1,115 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferAggregatorInformationSubMerchant', function() { - it('should create an instance of Ptsv1pushfundstransferAggregatorInformationSubMerchant', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferAggregatorInformationSubMerchant - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant); - }); - - it('should have the property id (base name: "id")', function() { - // uncomment below and update the code to test the property id - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property name (base name: "name")', function() { - // uncomment below and update the code to test the property name - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property address1 (base name: "address1")', function() { - // uncomment below and update the code to test the property address1 - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property locality (base name: "locality")', function() { - // uncomment below and update the code to test the property locality - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property administrativeArea (base name: "administrativeArea")', function() { - // uncomment below and update the code to test the property administrativeArea - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property postalCode (base name: "postalCode")', function() { - // uncomment below and update the code to test the property postalCode - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property country (base name: "country")', function() { - // uncomment below and update the code to test the property country - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property email (base name: "email")', function() { - // uncomment below and update the code to test the property email - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - it('should have the property phoneNumber (base name: "phoneNumber")', function() { - // uncomment below and update the code to test the property phoneNumber - //var instane = new CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferMerchantDefinedInformation.spec.js b/test/model/Ptsv1pushfundstransferMerchantDefinedInformation.spec.js deleted file mode 100644 index ff125555..00000000 --- a/test/model/Ptsv1pushfundstransferMerchantDefinedInformation.spec.js +++ /dev/null @@ -1,73 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferMerchantDefinedInformation', function() { - it('should create an instance of Ptsv1pushfundstransferMerchantDefinedInformation', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferMerchantDefinedInformation - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation); - }); - - it('should have the property key (base name: "key")', function() { - // uncomment below and update the code to test the property key - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation(); - //expect(instance).to.be(); - }); - - it('should have the property value (base name: "value")', function() { - // uncomment below and update the code to test the property value - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferMerchantInformation.spec.js b/test/model/Ptsv1pushfundstransferMerchantInformation.spec.js deleted file mode 100644 index 164ee7a5..00000000 --- a/test/model/Ptsv1pushfundstransferMerchantInformation.spec.js +++ /dev/null @@ -1,85 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferMerchantInformation', function() { - it('should create an instance of Ptsv1pushfundstransferMerchantInformation', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferMerchantInformation - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferMerchantInformation); - }); - - it('should have the property categoryCode (base name: "categoryCode")', function() { - // uncomment below and update the code to test the property categoryCode - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - //expect(instance).to.be(); - }); - - it('should have the property submitLocalDateTime (base name: "submitLocalDateTime")', function() { - // uncomment below and update the code to test the property submitLocalDateTime - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - //expect(instance).to.be(); - }); - - it('should have the property vatRegistrationNumber (base name: "vatRegistrationNumber")', function() { - // uncomment below and update the code to test the property vatRegistrationNumber - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - //expect(instance).to.be(); - }); - - it('should have the property merchantDescriptor (base name: "merchantDescriptor")', function() { - // uncomment below and update the code to test the property merchantDescriptor - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformation(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.spec.js b/test/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.spec.js deleted file mode 100644 index 23ae427b..00000000 --- a/test/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.spec.js +++ /dev/null @@ -1,103 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferMerchantInformationMerchantDescriptor', function() { - it('should create an instance of Ptsv1pushfundstransferMerchantInformationMerchantDescriptor', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor); - }); - - it('should have the property administrativeArea (base name: "administrativeArea")', function() { - // uncomment below and update the code to test the property administrativeArea - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property contact (base name: "contact")', function() { - // uncomment below and update the code to test the property contact - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property country (base name: "country")', function() { - // uncomment below and update the code to test the property country - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property locality (base name: "locality")', function() { - // uncomment below and update the code to test the property locality - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property name (base name: "name")', function() { - // uncomment below and update the code to test the property name - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property storeId (base name: "storeId")', function() { - // uncomment below and update the code to test the property storeId - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - it('should have the property postalCode (base name: "postalCode")', function() { - // uncomment below and update the code to test the property postalCode - //var instane = new CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferOrderInformation.spec.js b/test/model/Ptsv1pushfundstransferOrderInformation.spec.js index 18b557f0..0745356a 100644 --- a/test/model/Ptsv1pushfundstransferOrderInformation.spec.js +++ b/test/model/Ptsv1pushfundstransferOrderInformation.spec.js @@ -62,18 +62,6 @@ //expect(instance).to.be(); }); - it('should have the property isCryptocurrencyPurchase (base name: "isCryptocurrencyPurchase")', function() { - // uncomment below and update the code to test the property isCryptocurrencyPurchase - //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformation(); - //expect(instance).to.be(); - }); - - it('should have the property surcharge (base name: "surcharge")', function() { - // uncomment below and update the code to test the property surcharge - //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformation(); - //expect(instance).to.be(); - }); - }); })); diff --git a/test/model/Ptsv1pushfundstransferOrderInformationAmountDetails.spec.js b/test/model/Ptsv1pushfundstransferOrderInformationAmountDetails.spec.js index 1dd404d9..35cd7f3e 100644 --- a/test/model/Ptsv1pushfundstransferOrderInformationAmountDetails.spec.js +++ b/test/model/Ptsv1pushfundstransferOrderInformationAmountDetails.spec.js @@ -68,6 +68,18 @@ //expect(instance).to.be(); }); + it('should have the property sourceCurrency (base name: "sourceCurrency")', function() { + // uncomment below and update the code to test the property sourceCurrency + //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformationAmountDetails(); + //expect(instance).to.be(); + }); + + it('should have the property destinationCurrency (base name: "destinationCurrency")', function() { + // uncomment below and update the code to test the property destinationCurrency + //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformationAmountDetails(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Ptsv1pushfundstransferOrderInformationSurcharge.spec.js b/test/model/Ptsv1pushfundstransferOrderInformationSurcharge.spec.js deleted file mode 100644 index 1ddb703c..00000000 --- a/test/model/Ptsv1pushfundstransferOrderInformationSurcharge.spec.js +++ /dev/null @@ -1,67 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferOrderInformationSurcharge', function() { - it('should create an instance of Ptsv1pushfundstransferOrderInformationSurcharge', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferOrderInformationSurcharge - //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge); - }); - - it('should have the property amount (base name: "amount")', function() { - // uncomment below and update the code to test the property amount - //var instane = new CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferPointOfServiceInformation.spec.js b/test/model/Ptsv1pushfundstransferPointOfServiceInformation.spec.js deleted file mode 100644 index 25e247fa..00000000 --- a/test/model/Ptsv1pushfundstransferPointOfServiceInformation.spec.js +++ /dev/null @@ -1,91 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferPointOfServiceInformation', function() { - it('should create an instance of Ptsv1pushfundstransferPointOfServiceInformation', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferPointOfServiceInformation - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferPointOfServiceInformation); - }); - - it('should have the property terminalId (base name: "terminalId")', function() { - // uncomment below and update the code to test the property terminalId - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be(); - }); - - it('should have the property catLevel (base name: "catLevel")', function() { - // uncomment below and update the code to test the property catLevel - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be(); - }); - - it('should have the property entryMode (base name: "entryMode")', function() { - // uncomment below and update the code to test the property entryMode - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be(); - }); - - it('should have the property pinEntryCapability (base name: "pinEntryCapability")', function() { - // uncomment below and update the code to test the property pinEntryCapability - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be(); - }); - - it('should have the property terminalCapability (base name: "terminalCapability")', function() { - // uncomment below and update the code to test the property terminalCapability - //var instane = new CyberSource.Ptsv1pushfundstransferPointOfServiceInformation(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferProcessingInformation.spec.js b/test/model/Ptsv1pushfundstransferProcessingInformation.spec.js index d1ef67a1..9bf23708 100644 --- a/test/model/Ptsv1pushfundstransferProcessingInformation.spec.js +++ b/test/model/Ptsv1pushfundstransferProcessingInformation.spec.js @@ -62,48 +62,12 @@ //expect(instance).to.be(); }); - it('should have the property commerceIndicator (base name: "commerceIndicator")', function() { - // uncomment below and update the code to test the property commerceIndicator - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - - it('should have the property networkRoutingOrder (base name: "networkRoutingOrder")', function() { - // uncomment below and update the code to test the property networkRoutingOrder - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - it('should have the property payoutsOptions (base name: "payoutsOptions")', function() { // uncomment below and update the code to test the property payoutsOptions //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); //expect(instance).to.be(); }); - it('should have the property purposeOfPayment (base name: "purposeOfPayment")', function() { - // uncomment below and update the code to test the property purposeOfPayment - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - - it('should have the property reconciliationId (base name: "reconciliationId")', function() { - // uncomment below and update the code to test the property reconciliationId - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - - it('should have the property recurringOptions (base name: "recurringOptions")', function() { - // uncomment below and update the code to test the property recurringOptions - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - - it('should have the property transactionReason (base name: "transactionReason")', function() { - // uncomment below and update the code to test the property transactionReason - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformation(); - //expect(instance).to.be(); - }); - }); })); diff --git a/test/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.spec.js b/test/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.spec.js index c91205ab..970a283b 100644 --- a/test/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.spec.js +++ b/test/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.spec.js @@ -56,14 +56,14 @@ //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions); }); - it('should have the property accountFundingReferenceId (base name: "accountFundingReferenceId")', function() { - // uncomment below and update the code to test the property accountFundingReferenceId + it('should have the property sourceCurrency (base name: "sourceCurrency")', function() { + // uncomment below and update the code to test the property sourceCurrency //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions(); //expect(instance).to.be(); }); - it('should have the property retrievalReferenceNumber (base name: "retrievalReferenceNumber")', function() { - // uncomment below and update the code to test the property retrievalReferenceNumber + it('should have the property destinationCurrency (base name: "destinationCurrency")', function() { + // uncomment below and update the code to test the property destinationCurrency //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions(); //expect(instance).to.be(); }); diff --git a/test/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.spec.js b/test/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.spec.js deleted file mode 100644 index 79f7d0f1..00000000 --- a/test/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.spec.js +++ /dev/null @@ -1,67 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferProcessingInformationRecurringOptions', function() { - it('should create an instance of Ptsv1pushfundstransferProcessingInformationRecurringOptions', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferProcessingInformationRecurringOptions - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions); - }); - - it('should have the property loanPayment (base name: "loanPayment")', function() { - // uncomment below and update the code to test the property loanPayment - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferProcessingOptions.spec.js b/test/model/Ptsv1pushfundstransferProcessingOptions.spec.js deleted file mode 100644 index d4482e1b..00000000 --- a/test/model/Ptsv1pushfundstransferProcessingOptions.spec.js +++ /dev/null @@ -1,67 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferProcessingOptions(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferProcessingOptions', function() { - it('should create an instance of Ptsv1pushfundstransferProcessingOptions', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferProcessingOptions - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptions(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferProcessingOptions); - }); - - it('should have the property fundingOptions (base name: "fundingOptions")', function() { - // uncomment below and update the code to test the property fundingOptions - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptions(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.spec.js b/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.spec.js deleted file mode 100644 index 75ba6471..00000000 --- a/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.spec.js +++ /dev/null @@ -1,67 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferProcessingOptionsFundingOptions', function() { - it('should create an instance of Ptsv1pushfundstransferProcessingOptionsFundingOptions', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferProcessingOptionsFundingOptions - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions); - }); - - it('should have the property initiator (base name: "initiator")', function() { - // uncomment below and update the code to test the property initiator - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.spec.js b/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.spec.js deleted file mode 100644 index 79d97215..00000000 --- a/test/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.spec.js +++ /dev/null @@ -1,67 +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 - * - * Swagger Codegen version: 2.4.38 - * - * Do not edit the class manually. - * - */ - -(function(root, factory) { - if (typeof define === 'function' && define.amd) { - // AMD. - define(['expect.js', '../../src/index'], factory); - } else if (typeof module === 'object' && module.exports) { - // CommonJS-like environments that support module.exports, like Node. - factory(require('expect.js'), require('../../src/index')); - } else { - // Browser globals (root is window) - factory(root.expect, root.CyberSource); - } -}(this, function(expect, CyberSource) { - 'use strict'; - - var instance; - - beforeEach(function() { - instance = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator(); - }); - - var getProperty = function(object, getter, property) { - // Use getter method if present; otherwise, get the property directly. - if (typeof object[getter] === 'function') - return object[getter](); - else - return object[property]; - } - - var setProperty = function(object, setter, property, value) { - // Use setter method if present; otherwise, set the property directly. - if (typeof object[setter] === 'function') - object[setter](value); - else - object[property] = value; - } - - describe('Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator', function() { - it('should create an instance of Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator', function() { - // uncomment below and update the code to test Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator(); - //expect(instance).to.be.a(CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator); - }); - - it('should have the property type (base name: "type")', function() { - // uncomment below and update the code to test the property type - //var instane = new CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator(); - //expect(instance).to.be(); - }); - - }); - -})); diff --git a/test/model/Ptsv1pushfundstransferRecipientInformation.spec.js b/test/model/Ptsv1pushfundstransferRecipientInformation.spec.js index c579899f..bf096564 100644 --- a/test/model/Ptsv1pushfundstransferRecipientInformation.spec.js +++ b/test/model/Ptsv1pushfundstransferRecipientInformation.spec.js @@ -110,24 +110,12 @@ //expect(instance).to.be(); }); - it('should have the property middleInitial (base name: "middleInitial")', function() { - // uncomment below and update the code to test the property middleInitial - //var instane = new CyberSource.Ptsv1pushfundstransferRecipientInformation(); - //expect(instance).to.be(); - }); - it('should have the property lastName (base name: "lastName")', function() { // uncomment below and update the code to test the property lastName //var instane = new CyberSource.Ptsv1pushfundstransferRecipientInformation(); //expect(instance).to.be(); }); - it('should have the property dateOfBirth (base name: "dateOfBirth")', function() { - // uncomment below and update the code to test the property dateOfBirth - //var instane = new CyberSource.Ptsv1pushfundstransferRecipientInformation(); - //expect(instance).to.be(); - }); - it('should have the property phoneNumber (base name: "phoneNumber")', function() { // uncomment below and update the code to test the property phoneNumber //var instane = new CyberSource.Ptsv1pushfundstransferRecipientInformation(); diff --git a/test/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.spec.js b/test/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.spec.js index 4e2d0bd2..2a6b45f6 100644 --- a/test/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.spec.js +++ b/test/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.spec.js @@ -68,6 +68,12 @@ //expect(instance).to.be(); }); + it('should have the property issuingCountry (base name: "issuingCountry")', function() { + // uncomment below and update the code to test the property issuingCountry + //var instane = new CyberSource.Ptsv1pushfundstransferRecipientInformationPersonalIdentification(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Ptsv1pushfundstransferSenderInformation.spec.js b/test/model/Ptsv1pushfundstransferSenderInformation.spec.js index c9e5f810..20e2642e 100644 --- a/test/model/Ptsv1pushfundstransferSenderInformation.spec.js +++ b/test/model/Ptsv1pushfundstransferSenderInformation.spec.js @@ -116,12 +116,6 @@ //expect(instance).to.be(); }); - it('should have the property vatRegistrationNumber (base name: "vatRegistrationNumber")', function() { - // uncomment below and update the code to test the property vatRegistrationNumber - //var instane = new CyberSource.Ptsv1pushfundstransferSenderInformation(); - //expect(instance).to.be(); - }); - it('should have the property dateOfBirth (base name: "dateOfBirth")', function() { // uncomment below and update the code to test the property dateOfBirth //var instane = new CyberSource.Ptsv1pushfundstransferSenderInformation(); diff --git a/test/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.spec.js b/test/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.spec.js index 79af9890..4d7d62ee 100644 --- a/test/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.spec.js +++ b/test/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.spec.js @@ -74,6 +74,12 @@ //expect(instance).to.be(); }); + it('should have the property issuingCountry (base name: "issuingCountry")', function() { + // uncomment below and update the code to test the property issuingCountry + //var instane = new CyberSource.Ptsv1pushfundstransferSenderInformationPersonalIdentification(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Ptsv2paymentsTokenInformation.spec.js b/test/model/Ptsv2paymentsTokenInformation.spec.js index 9ad8d26a..3423bc15 100644 --- a/test/model/Ptsv2paymentsTokenInformation.spec.js +++ b/test/model/Ptsv2paymentsTokenInformation.spec.js @@ -86,6 +86,12 @@ //expect(instance).to.be(); }); + it('should have the property tokenProvisioningInformation (base name: "tokenProvisioningInformation")', function() { + // uncomment below and update the code to test the property tokenProvisioningInformation + //var instane = new CyberSource.Ptsv2paymentsTokenInformation(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.spec.js b/test/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.spec.js similarity index 70% rename from test/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.spec.js rename to test/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.spec.js index 0b4505e5..51b48d89 100644 --- a/test/model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.spec.js +++ b/test/model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.spec.js @@ -30,7 +30,7 @@ var instance; beforeEach(function() { - instance = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation(); + instance = new CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation(); }); var getProperty = function(object, getter, property) { @@ -49,22 +49,22 @@ object[property] = value; } - describe('TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', function() { - it('should create an instance of TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', function() { - // uncomment below and update the code to test TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation - //var instane = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation(); - //expect(instance).to.be.a(CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation); + describe('Ptsv2paymentsTokenInformationTokenProvisioningInformation', function() { + it('should create an instance of Ptsv2paymentsTokenInformationTokenProvisioningInformation', function() { + // uncomment below and update the code to test Ptsv2paymentsTokenInformationTokenProvisioningInformation + //var instane = new CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation(); + //expect(instance).to.be.a(CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation); }); it('should have the property consumerConsentObtained (base name: "consumerConsentObtained")', function() { // uncomment below and update the code to test the property consumerConsentObtained - //var instane = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation(); + //var instane = new CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation(); //expect(instance).to.be(); }); it('should have the property multiFactorAuthenticated (base name: "multiFactorAuthenticated")', function() { // uncomment below and update the code to test the property multiFactorAuthenticated - //var instane = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation(); + //var instane = new CyberSource.Ptsv2paymentsTokenInformationTokenProvisioningInformation(); //expect(instance).to.be(); }); diff --git a/test/model/Ptsv2payoutsRecipientInformation.spec.js b/test/model/Ptsv2payoutsRecipientInformation.spec.js index 81e533f8..1a0db875 100644 --- a/test/model/Ptsv2payoutsRecipientInformation.spec.js +++ b/test/model/Ptsv2payoutsRecipientInformation.spec.js @@ -62,12 +62,6 @@ //expect(instance).to.be(); }); - it('should have the property middleInitial (base name: "middleInitial")', function() { - // uncomment below and update the code to test the property middleInitial - //var instane = new CyberSource.Ptsv2payoutsRecipientInformation(); - //expect(instance).to.be(); - }); - it('should have the property middleName (base name: "middleName")', function() { // uncomment below and update the code to test the property middleName //var instane = new CyberSource.Ptsv2payoutsRecipientInformation(); @@ -116,12 +110,6 @@ //expect(instance).to.be(); }); - it('should have the property dateOfBirth (base name: "dateOfBirth")', function() { - // uncomment below and update the code to test the property dateOfBirth - //var instane = new CyberSource.Ptsv2payoutsRecipientInformation(); - //expect(instance).to.be(); - }); - }); })); diff --git a/test/model/PushFunds201ResponseProcessorInformation.spec.js b/test/model/PushFunds201ResponseProcessorInformation.spec.js index f621f2b7..2aeb5fe4 100644 --- a/test/model/PushFunds201ResponseProcessorInformation.spec.js +++ b/test/model/PushFunds201ResponseProcessorInformation.spec.js @@ -68,24 +68,12 @@ //expect(instance).to.be(); }); - it('should have the property approvalCode (base name: "approvalCode")', function() { - // uncomment below and update the code to test the property approvalCode - //var instane = new CyberSource.PushFunds201ResponseProcessorInformation(); - //expect(instance).to.be(); - }); - it('should have the property systemTraceAuditNumber (base name: "systemTraceAuditNumber")', function() { // uncomment below and update the code to test the property systemTraceAuditNumber //var instane = new CyberSource.PushFunds201ResponseProcessorInformation(); //expect(instance).to.be(); }); - it('should have the property responseCodeSource (base name: "responseCodeSource")', function() { - // uncomment below and update the code to test the property responseCodeSource - //var instane = new CyberSource.PushFunds201ResponseProcessorInformation(); - //expect(instance).to.be(); - }); - it('should have the property retrievalReferenceNumber (base name: "retrievalReferenceNumber")', function() { // uncomment below and update the code to test the property retrievalReferenceNumber //var instane = new CyberSource.PushFunds201ResponseProcessorInformation(); diff --git a/test/model/PushFundsRequest.spec.js b/test/model/PushFundsRequest.spec.js index 7a2d3d51..5857b832 100644 --- a/test/model/PushFundsRequest.spec.js +++ b/test/model/PushFundsRequest.spec.js @@ -74,12 +74,6 @@ //expect(instance).to.be(); }); - it('should have the property processingOptions (base name: "processingOptions")', function() { - // uncomment below and update the code to test the property processingOptions - //var instane = new CyberSource.PushFundsRequest(); - //expect(instance).to.be(); - }); - it('should have the property recipientInformation (base name: "recipientInformation")', function() { // uncomment below and update the code to test the property recipientInformation //var instane = new CyberSource.PushFundsRequest(); @@ -92,30 +86,6 @@ //expect(instance).to.be(); }); - it('should have the property aggregatorInformation (base name: "aggregatorInformation")', function() { - // uncomment below and update the code to test the property aggregatorInformation - //var instane = new CyberSource.PushFundsRequest(); - //expect(instance).to.be(); - }); - - it('should have the property merchantDefinedInformation (base name: "merchantDefinedInformation")', function() { - // uncomment below and update the code to test the property merchantDefinedInformation - //var instane = new CyberSource.PushFundsRequest(); - //expect(instance).to.be(); - }); - - it('should have the property merchantInformation (base name: "merchantInformation")', function() { - // uncomment below and update the code to test the property merchantInformation - //var instane = new CyberSource.PushFundsRequest(); - //expect(instance).to.be(); - }); - - it('should have the property pointOfServiceInformation (base name: "pointOfServiceInformation")', function() { - // uncomment below and update the code to test the property pointOfServiceInformation - //var instane = new CyberSource.PushFundsRequest(); - //expect(instance).to.be(); - }); - }); })); diff --git a/test/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.spec.js b/test/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.spec.js index 0917f7a9..91fb8b4e 100644 --- a/test/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.spec.js +++ b/test/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.spec.js @@ -62,6 +62,12 @@ //expect(instance).to.be(); }); + it('should have the property source (base name: "source")', function() { + // uncomment below and update the code to test the property source + //var instane = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard(); + //expect(instance).to.be(); + }); + it('should have the property state (base name: "state")', function() { // uncomment below and update the code to test the property state //var instane = new CyberSource.TmsEmbeddedInstrumentIdentifierTokenizedCard(); From 5bd4a26c3748b042602b79a00b62e21ef6dfd5b7 Mon Sep 17 00:00:00 2001 From: monkumar Date: Mon, 1 Jul 2024 18:01:35 +0530 Subject: [PATCH 2/2] version update --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index de5d90b1..793775bc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cybersource-rest-client", - "version": "0.0.57", + "version": "0.0.58", "description": "Node.js SDK for the CyberSource REST API", "author": "developer@cybersource.com", "license": "CyberSource",