cybersource-rest-client 0.0.56 → 0.0.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/GetAllPlansResponseOrderInformationAmountDetails.md +1 -1
- package/docs/InvoicesApi.md +2 -2
- package/docs/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md +1 -1
- package/docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md +1 -1
- package/docs/InvoicingV2InvoicesAllGet200ResponseInvoices.md +1 -1
- package/docs/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md +2 -2
- package/docs/InvoicingV2InvoicesGet200Response.md +1 -1
- package/docs/InvoicingV2InvoicesGet200ResponseTransactionDetails.md +1 -1
- package/docs/InvoicingV2InvoicesPost201Response.md +1 -1
- package/docs/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md +2 -2
- package/docs/InvoicingV2InvoicesPost202Response.md +1 -1
- package/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md +1 -1
- package/docs/Invoicingv2invoicesCustomerInformation.md +2 -2
- package/docs/Invoicingv2invoicesCustomerInformationCompany.md +1 -1
- package/docs/Invoicingv2invoicesOrderInformationAmountDetails.md +2 -2
- package/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md +1 -1
- package/docs/Kmsv2keyssymClientReferenceInformation.md +1 -1
- package/docs/PatchInstrumentIdentifierRequest.md +2 -2
- package/docs/PostInstrumentIdentifierEnrollmentRequest.md +2 -2
- package/docs/PostInstrumentIdentifierRequest.md +2 -2
- package/docs/PtsV2CreditsPost201ResponseCreditAmountDetails.md +1 -1
- package/docs/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md +1 -1
- package/docs/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md +1 -1
- package/docs/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md +2 -2
- package/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md +1 -1
- package/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md +1 -1
- package/docs/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md +1 -1
- package/docs/PtsV2PaymentsPost201ResponseBuyerInformation.md +3 -3
- package/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +3 -3
- package/docs/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md +2 -2
- package/docs/PtsV2PaymentsPost201ResponsePaymentInformation.md +5 -5
- package/docs/PtsV2PaymentsPost201ResponsePaymentInformationBank.md +1 -1
- package/docs/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md +1 -1
- package/docs/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md +2 -2
- package/docs/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md +2 -2
- package/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md +1 -1
- package/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md +5 -5
- package/docs/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md +2 -2
- package/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md +1 -1
- package/docs/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md +1 -1
- package/docs/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md +1 -1
- package/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md +2 -2
- package/docs/Ptsv1pushfundstransferOrderInformation.md +0 -2
- package/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md +4 -2
- package/docs/Ptsv1pushfundstransferProcessingInformation.md +1 -7
- package/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md +2 -2
- package/docs/Ptsv1pushfundstransferRecipientInformation.md +8 -10
- package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md +1 -1
- package/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md +3 -2
- package/docs/Ptsv1pushfundstransferSenderInformation.md +8 -9
- package/docs/Ptsv1pushfundstransferSenderInformationAccount.md +1 -1
- package/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md +5 -5
- package/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md +3 -2
- package/docs/Ptsv2billingagreementsAggregatorInformation.md +1 -1
- package/docs/Ptsv2billingagreementsBuyerInformation.md +1 -1
- package/docs/Ptsv2billingagreementsClientReferenceInformation.md +1 -1
- package/docs/Ptsv2billingagreementsOrderInformationBillTo.md +1 -1
- package/docs/Ptsv2billingagreementsidBuyerInformation.md +1 -1
- package/docs/Ptsv2creditsProcessingInformation.md +3 -3
- package/docs/Ptsv2creditsProcessingInformationBankTransferOptions.md +3 -3
- package/docs/Ptsv2paymentreferencesBuyerInformation.md +1 -1
- package/docs/Ptsv2paymentreferencesOrderInformationAmountDetails.md +3 -3
- package/docs/Ptsv2paymentreferencesPaymentInformationBank.md +1 -1
- package/docs/Ptsv2paymentreferencesPaymentInformationBankAccount.md +1 -1
- package/docs/Ptsv2paymentreferencesPaymentInformationCard.md +1 -1
- package/docs/Ptsv2paymentsAggregatorInformation.md +2 -2
- package/docs/Ptsv2paymentsBuyerInformation.md +4 -4
- package/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md +3 -3
- package/docs/Ptsv2paymentsClientReferenceInformation.md +1 -1
- package/docs/Ptsv2paymentsConsumerAuthenticationInformation.md +7 -7
- package/docs/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication.md +1 -0
- package/docs/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation.md +8 -0
- package/docs/Ptsv2paymentsMerchantDefinedInformation.md +2 -2
- package/docs/Ptsv2paymentsOrderInformationAmountDetails.md +5 -5
- package/docs/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md +1 -1
- package/docs/Ptsv2paymentsOrderInformationBillTo.md +1 -1
- package/docs/Ptsv2paymentsOrderInformationBillToCompany.md +1 -1
- package/docs/Ptsv2paymentsPaymentInformationBank.md +3 -3
- package/docs/Ptsv2paymentsPaymentInformationBankAccount.md +2 -2
- package/docs/Ptsv2paymentsPaymentInformationCard.md +1 -1
- package/docs/Ptsv2paymentsPaymentInformationCustomer.md +1 -1
- package/docs/Ptsv2paymentsPointOfSaleInformationEmv.md +1 -1
- package/docs/Ptsv2paymentsProcessingInformation.md +5 -5
- package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +2 -2
- package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md +1 -1
- package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +2 -2
- package/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md +5 -5
- package/docs/Ptsv2paymentsTokenInformation.md +1 -0
- package/docs/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md → Ptsv2paymentsTokenInformationTokenProvisioningInformation.md} +1 -1
- package/docs/Ptsv2paymentsidOrderInformationAmountDetails.md +1 -1
- package/docs/Ptsv2paymentsidcapturesAggregatorInformation.md +2 -2
- package/docs/Ptsv2paymentsidcapturesBuyerInformation.md +3 -3
- package/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md +1 -1
- package/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md +5 -5
- package/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md +1 -1
- package/docs/Ptsv2paymentsidcapturesProcessingInformation.md +2 -2
- package/docs/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md +2 -2
- package/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md +1 -1
- package/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md +3 -3
- package/docs/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md +1 -1
- package/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md +1 -1
- package/docs/Ptsv2paymentsidrefundsProcessingInformation.md +2 -2
- package/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md +1 -1
- package/docs/Ptsv2paymentsidreversalsProcessingInformation.md +2 -2
- package/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md +2 -2
- package/docs/Ptsv2payoutsOrderInformationAmountDetails.md +2 -2
- package/docs/Ptsv2payoutsRecipientInformation.md +0 -2
- package/docs/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md +1 -1
- package/docs/PushFunds201ResponseOrderInformationAmountDetails.md +1 -1
- package/docs/PushFunds201ResponseProcessorInformation.md +2 -4
- package/docs/PushFunds400Response.md +1 -1
- package/docs/PushFundsRequest.md +1 -6
- package/docs/Rbsv1plansOrderInformationAmountDetails.md +1 -1
- package/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md +1 -1
- package/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md +4 -3
- package/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md +1 -1
- package/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md +5 -5
- package/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md +2 -2
- package/docs/Riskv1authenticationsBuyerInformation.md +1 -1
- package/docs/Riskv1authenticationsOrderInformationAmountDetails.md +2 -2
- package/docs/Riskv1authenticationsOrderInformationBillTo.md +1 -1
- package/docs/Riskv1decisionsBuyerInformation.md +3 -3
- package/docs/Riskv1decisionsConsumerAuthenticationInformation.md +1 -1
- package/docs/Riskv1decisionsOrderInformationAmountDetails.md +1 -1
- package/docs/Riskv1decisionsOrderInformationBillTo.md +1 -1
- package/docs/Riskv1decisionsProcessorInformationCardVerification.md +1 -1
- package/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md +1 -1
- package/docs/Riskv1liststypeentriesOrderInformationBillTo.md +1 -1
- package/docs/TmsEmbeddedInstrumentIdentifier.md +2 -2
- package/docs/TmsEmbeddedInstrumentIdentifierTokenizedCard.md +1 -0
- package/docs/TransactionBatchesApi.md +2 -2
- package/docs/TransientTokenDataApi.md +5 -5
- package/docs/TssV2TransactionsGet200ResponseBuyerInformation.md +2 -2
- package/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md +2 -2
- package/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +3 -3
- package/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +2 -2
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md +5 -5
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md +2 -2
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +1 -1
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md +1 -1
- package/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +3 -3
- package/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +1 -1
- package/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md +4 -4
- package/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md +1 -1
- package/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md +2 -2
- package/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +1 -1
- package/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +3 -3
- package/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md +1 -1
- package/docs/Vasv2taxBuyerInformation.md +1 -1
- package/docs/Vasv2taxClientReferenceInformation.md +1 -1
- package/docs/Vasv2taxidClientReferenceInformation.md +1 -1
- package/package.json +1 -1
- package/src/ApiClient.js +0 -3
- package/src/api/InvoicesApi.js +1 -1
- package/src/api/TransactionBatchesApi.js +2 -2
- package/src/api/TransientTokenDataApi.js +7 -7
- package/src/index.js +13 -63
- package/src/model/GetAllPlansResponseOrderInformationAmountDetails.js +1 -1
- package/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js +1 -1
- package/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js +1 -1
- package/src/model/InvoicingV2InvoicesAllGet200ResponseInvoices.js +1 -1
- package/src/model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.js +2 -2
- package/src/model/InvoicingV2InvoicesGet200Response.js +1 -1
- package/src/model/InvoicingV2InvoicesGet200ResponseTransactionDetails.js +1 -1
- package/src/model/InvoicingV2InvoicesPost201Response.js +1 -1
- package/src/model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.js +2 -2
- package/src/model/InvoicingV2InvoicesPost202Response.js +1 -1
- package/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js +1 -1
- package/src/model/Invoicingv2invoicesCustomerInformation.js +2 -2
- package/src/model/Invoicingv2invoicesCustomerInformationCompany.js +1 -1
- package/src/model/Invoicingv2invoicesOrderInformationAmountDetails.js +2 -2
- package/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js +1 -1
- package/src/model/Kmsv2keyssymClientReferenceInformation.js +1 -1
- package/src/model/PatchInstrumentIdentifierRequest.js +7 -7
- package/src/model/PostInstrumentIdentifierEnrollmentRequest.js +7 -7
- package/src/model/PostInstrumentIdentifierRequest.js +7 -7
- package/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js +1 -1
- package/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js +1 -1
- package/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js +1 -1
- package/src/model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.js +2 -2
- package/src/model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.js +1 -1
- package/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js +1 -1
- package/src/model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.js +1 -1
- package/src/model/PtsV2PaymentsPost201ResponseBuyerInformation.js +3 -3
- package/src/model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.js +3 -3
- package/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js +2 -2
- package/src/model/PtsV2PaymentsPost201ResponsePaymentInformation.js +5 -5
- package/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBank.js +1 -1
- package/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js +1 -1
- package/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js +2 -2
- package/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js +2 -2
- package/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js +1 -1
- package/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js +5 -5
- package/src/model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.js +2 -2
- package/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js +1 -1
- package/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js +1 -1
- package/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js +1 -1
- package/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js +2 -2
- package/src/model/Ptsv1pushfundstransferOrderInformation.js +4 -21
- package/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js +22 -4
- package/src/model/Ptsv1pushfundstransferProcessingInformation.js +6 -60
- package/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js +10 -10
- package/src/model/Ptsv1pushfundstransferRecipientInformation.js +8 -26
- package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js +1 -1
- package/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js +11 -2
- package/src/model/Ptsv1pushfundstransferSenderInformation.js +8 -17
- package/src/model/Ptsv1pushfundstransferSenderInformationAccount.js +1 -1
- package/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js +5 -5
- package/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js +11 -2
- package/src/model/Ptsv2billingagreementsAggregatorInformation.js +1 -1
- package/src/model/Ptsv2billingagreementsBuyerInformation.js +1 -1
- package/src/model/Ptsv2billingagreementsClientReferenceInformation.js +1 -1
- package/src/model/Ptsv2billingagreementsOrderInformationBillTo.js +1 -1
- package/src/model/Ptsv2billingagreementsidBuyerInformation.js +1 -1
- package/src/model/Ptsv2creditsProcessingInformation.js +3 -3
- package/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js +3 -3
- package/src/model/Ptsv2paymentreferencesBuyerInformation.js +1 -1
- package/src/model/Ptsv2paymentreferencesOrderInformationAmountDetails.js +3 -3
- package/src/model/Ptsv2paymentreferencesPaymentInformationBank.js +1 -1
- package/src/model/Ptsv2paymentreferencesPaymentInformationBankAccount.js +1 -1
- package/src/model/Ptsv2paymentreferencesPaymentInformationCard.js +1 -1
- package/src/model/Ptsv2paymentsAggregatorInformation.js +2 -2
- package/src/model/Ptsv2paymentsBuyerInformation.js +4 -4
- package/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js +3 -3
- package/src/model/Ptsv2paymentsClientReferenceInformation.js +1 -1
- package/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js +7 -7
- package/src/model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication.js +12 -4
- package/src/model/Ptsv2paymentsConsumerAuthenticationInformationStrongAuthenticationIssuerInformation.js +82 -0
- package/src/model/Ptsv2paymentsMerchantDefinedInformation.js +2 -2
- package/src/model/Ptsv2paymentsOrderInformationAmountDetails.js +5 -5
- package/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js +1 -1
- package/src/model/Ptsv2paymentsOrderInformationBillTo.js +1 -1
- package/src/model/Ptsv2paymentsOrderInformationBillToCompany.js +1 -1
- package/src/model/Ptsv2paymentsPaymentInformationBank.js +3 -3
- package/src/model/Ptsv2paymentsPaymentInformationBankAccount.js +2 -2
- package/src/model/Ptsv2paymentsPaymentInformationCard.js +1 -1
- package/src/model/Ptsv2paymentsPaymentInformationCustomer.js +1 -1
- package/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js +1 -1
- package/src/model/Ptsv2paymentsProcessingInformation.js +5 -5
- package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js +2 -2
- package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.js +1 -1
- package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.js +2 -2
- package/src/model/Ptsv2paymentsProcessingInformationBankTransferOptions.js +5 -5
- package/src/model/Ptsv2paymentsTokenInformation.js +12 -4
- package/src/model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.js → Ptsv2paymentsTokenInformationTokenProvisioningInformation.js} +8 -8
- package/src/model/Ptsv2paymentsidOrderInformationAmountDetails.js +1 -1
- package/src/model/Ptsv2paymentsidcapturesAggregatorInformation.js +2 -2
- package/src/model/Ptsv2paymentsidcapturesBuyerInformation.js +3 -3
- package/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js +1 -1
- package/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js +5 -5
- package/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js +1 -1
- package/src/model/Ptsv2paymentsidcapturesProcessingInformation.js +2 -2
- package/src/model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.js +2 -2
- package/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js +1 -1
- package/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js +3 -3
- package/src/model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.js +1 -1
- package/src/model/Ptsv2paymentsidrefundsPaymentInformationCard.js +1 -1
- package/src/model/Ptsv2paymentsidrefundsProcessingInformation.js +2 -2
- package/src/model/Ptsv2paymentsidreversalsClientReferenceInformation.js +1 -1
- package/src/model/Ptsv2paymentsidreversalsProcessingInformation.js +2 -2
- package/src/model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.js +2 -2
- package/src/model/Ptsv2payoutsOrderInformationAmountDetails.js +2 -2
- package/src/model/Ptsv2payoutsRecipientInformation.js +0 -18
- package/src/model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js +1 -1
- package/src/model/PushFunds201ResponseOrderInformationAmountDetails.js +1 -1
- package/src/model/PushFunds201ResponseProcessorInformation.js +2 -20
- package/src/model/PushFunds400Response.js +1 -1
- package/src/model/PushFundsRequest.js +5 -46
- package/src/model/Rbsv1plansOrderInformationAmountDetails.js +2 -2
- package/src/model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.js +1 -1
- package/src/model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.js +12 -3
- package/src/model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.js +1 -1
- package/src/model/RiskV1DecisionsPost201ResponsePaymentInformation.js +5 -5
- package/src/model/Riskv1authenticationresultsOrderInformationAmountDetails.js +2 -2
- package/src/model/Riskv1authenticationsBuyerInformation.js +1 -1
- package/src/model/Riskv1authenticationsOrderInformationAmountDetails.js +4 -4
- package/src/model/Riskv1authenticationsOrderInformationBillTo.js +2 -2
- package/src/model/Riskv1decisionsBuyerInformation.js +3 -3
- package/src/model/Riskv1decisionsConsumerAuthenticationInformation.js +1 -1
- package/src/model/Riskv1decisionsOrderInformationAmountDetails.js +2 -2
- package/src/model/Riskv1decisionsOrderInformationBillTo.js +1 -1
- package/src/model/Riskv1decisionsProcessorInformationCardVerification.js +1 -1
- package/src/model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.js +2 -2
- package/src/model/Riskv1liststypeentriesOrderInformationBillTo.js +1 -1
- package/src/model/TmsEmbeddedInstrumentIdentifier.js +7 -7
- package/src/model/TmsEmbeddedInstrumentIdentifierTokenizedCard.js +9 -0
- package/src/model/TssV2TransactionsGet200ResponseBuyerInformation.js +2 -2
- package/src/model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.js +2 -2
- package/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js +3 -3
- package/src/model/TssV2TransactionsGet200ResponseOrderInformationBillTo.js +2 -2
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationBank.js +5 -5
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.js +2 -2
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationCard.js +1 -1
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.js +1 -1
- package/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +3 -3
- package/src/model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.js +1 -1
- package/src/model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.js +4 -4
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.js +1 -1
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.js +2 -2
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.js +1 -1
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js +3 -3
- package/src/model/VasV2TaxVoid200ResponseVoidAmountDetails.js +1 -1
- package/src/model/Vasv2taxBuyerInformation.js +1 -1
- package/src/model/Vasv2taxClientReferenceInformation.js +1 -1
- package/src/model/Vasv2taxidClientReferenceInformation.js +1 -1
- package/docs/Ptsv1pushfundstransferAggregatorInformation.md +0 -10
- package/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md +0 -16
- package/docs/Ptsv1pushfundstransferMerchantDefinedInformation.md +0 -9
- package/docs/Ptsv1pushfundstransferMerchantInformation.md +0 -11
- package/docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md +0 -14
- package/docs/Ptsv1pushfundstransferOrderInformationSurcharge.md +0 -8
- package/docs/Ptsv1pushfundstransferPointOfServiceInformation.md +0 -12
- package/docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md +0 -8
- package/docs/Ptsv1pushfundstransferProcessingOptions.md +0 -8
- package/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md +0 -8
- package/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md +0 -8
- package/src/model/Ptsv1pushfundstransferAggregatorInformation.js +0 -99
- package/src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js +0 -154
- package/src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js +0 -91
- package/src/model/Ptsv1pushfundstransferMerchantInformation.js +0 -108
- package/src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js +0 -136
- package/src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js +0 -82
- package/src/model/Ptsv1pushfundstransferPointOfServiceInformation.js +0 -118
- package/src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js +0 -82
- package/src/model/Ptsv1pushfundstransferProcessingOptions.js +0 -81
- package/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js +0 -81
- package/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js +0 -82
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
6
|
+
**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]
|
|
7
7
|
**billingAmount** | **String** | Billing amount for the billing period. | [optional]
|
|
8
8
|
**setupFee** | **String** | Subscription setup fee | [optional]
|
|
9
9
|
|
package/docs/InvoicesApi.md
CHANGED
|
@@ -77,7 +77,7 @@ var offset = 56; // Number | Page offset number.
|
|
|
77
77
|
var limit = 56; // Number | Maximum number of items you would like returned.
|
|
78
78
|
|
|
79
79
|
var opts = {
|
|
80
|
-
'status': "status_example" // String | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED
|
|
80
|
+
'status': "status_example" // String | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING
|
|
81
81
|
};
|
|
82
82
|
|
|
83
83
|
var callback = function(error, data, response) {
|
|
@@ -96,7 +96,7 @@ Name | Type | Description | Notes
|
|
|
96
96
|
------------- | ------------- | ------------- | -------------
|
|
97
97
|
**offset** | **Number**| Page offset number. |
|
|
98
98
|
**limit** | **Number**| Maximum number of items you would like returned. |
|
|
99
|
-
**status** | **String**| The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED | [optional]
|
|
99
|
+
**status** | **String**| The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING | [optional]
|
|
100
100
|
|
|
101
101
|
### Return type
|
|
102
102
|
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**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]
|
|
10
10
|
**headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional]
|
|
11
11
|
**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]
|
|
12
|
-
**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.
|
|
12
|
+
**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]
|
|
13
13
|
**payerAuthentication3DSVersion** | **Boolean** | The 3D Secure payer authentication status for a merchant's invoice payments. | [optional] [default to false]
|
|
14
14
|
**showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false]
|
|
15
15
|
**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]
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | Payer name for the invoice. | [optional]
|
|
7
|
-
**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.
|
|
7
|
+
**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]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**links** | [**InvoicingV2InvoicesAllGet200ResponseLinks**](InvoicingV2InvoicesAllGet200ResponseLinks.md) | | [optional]
|
|
7
7
|
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
|
|
8
|
-
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED | [optional]
|
|
8
|
+
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING | [optional]
|
|
9
9
|
**customerInformation** | [**InvoicingV2InvoicesAllGet200ResponseCustomerInformation**](InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md) | | [optional]
|
|
10
10
|
**invoiceInformation** | [**InvoicingV2InvoicesAllGet200ResponseInvoiceInformation**](InvoicingV2InvoicesAllGet200ResponseInvoiceInformation.md) | | [optional]
|
|
11
11
|
**orderInformation** | [**InvoicingV2InvoicesAllGet200ResponseOrderInformation**](InvoicingV2InvoicesAllGet200ResponseOrderInformation.md) | | [optional]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
7
|
-
**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.
|
|
6
|
+
**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]
|
|
7
|
+
**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]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**links** | [**InvoicingV2InvoicesAllGet200ResponseLinks**](InvoicingV2InvoicesAllGet200ResponseLinks.md) | | [optional]
|
|
7
7
|
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
|
|
8
8
|
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
|
|
9
|
-
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED | [optional]
|
|
9
|
+
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING | [optional]
|
|
10
10
|
**customerInformation** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional]
|
|
11
11
|
**invoiceInformation** | [**InvoicingV2InvoicesPost201ResponseInvoiceInformation**](InvoicingV2InvoicesPost201ResponseInvoiceInformation.md) | | [optional]
|
|
12
12
|
**orderInformation** | [**InvoicingV2InvoicesPost201ResponseOrderInformation**](InvoicingV2InvoicesPost201ResponseOrderInformation.md) | | [optional]
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**transactionId** | **String** | Payer auth Transaction identifier. | [optional]
|
|
7
|
-
**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.
|
|
7
|
+
**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]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**links** | [**InvoicingV2InvoicesAllGet200ResponseLinks**](InvoicingV2InvoicesAllGet200ResponseLinks.md) | | [optional]
|
|
7
7
|
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
|
|
8
8
|
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
|
|
9
|
-
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED | [optional]
|
|
9
|
+
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING | [optional]
|
|
10
10
|
**customerInformation** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional]
|
|
11
11
|
**invoiceInformation** | [**InvoicingV2InvoicesPost201ResponseInvoiceInformation**](InvoicingV2InvoicesPost201ResponseInvoiceInformation.md) | | [optional]
|
|
12
12
|
**orderInformation** | [**InvoicingV2InvoicesPost201ResponseOrderInformation**](InvoicingV2InvoicesPost201ResponseOrderInformation.md) | | [optional]
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
7
|
-
**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.
|
|
6
|
+
**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]
|
|
7
|
+
**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]
|
|
8
8
|
**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]
|
|
9
9
|
**discountAmount** | **String** | Total discount amount applied to the order. | [optional]
|
|
10
10
|
**discountPercent** | **Number** | The total discount percentage applied to the invoice. | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
|
|
7
|
-
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED | [optional]
|
|
7
|
+
**status** | **String** | The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING | [optional]
|
|
8
8
|
**reason** | **String** | The reason of the status. Possible values: - ACCEPTED | [optional]
|
|
9
9
|
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
|
|
10
10
|
**details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional]
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**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]
|
|
10
10
|
**headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional]
|
|
11
11
|
**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]
|
|
12
|
-
**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.
|
|
12
|
+
**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]
|
|
13
13
|
**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]
|
|
14
14
|
**showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false]
|
|
15
15
|
**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]
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | Payer name for the invoice. | [optional]
|
|
7
|
-
**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.
|
|
8
|
-
**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.
|
|
7
|
+
**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]
|
|
8
|
+
**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]
|
|
9
9
|
**company** | [**Invoicingv2invoicesCustomerInformationCompany**](Invoicingv2invoicesCustomerInformationCompany.md) | | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
6
|
+
**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]
|
|
7
7
|
|
|
8
8
|
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
7
|
-
**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.
|
|
6
|
+
**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]
|
|
7
|
+
**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]
|
|
8
8
|
**discountAmount** | **String** | Total discount amount applied to the order. | [optional]
|
|
9
9
|
**discountPercent** | **Number** | The total discount percentage applied to the invoice. | [optional]
|
|
10
10
|
**subAmount** | **Number** | Sub-amount of the invoice. | [optional]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
6
|
+
**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]
|
|
7
7
|
**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]
|
|
8
8
|
**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]
|
|
9
9
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value. | [optional]
|
|
7
|
-
**comments** | **String** |
|
|
7
|
+
**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional]
|
|
8
8
|
**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | The Id of the Instrument Identifier Token. | [optional]
|
|
8
8
|
**_object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional]
|
|
9
9
|
**state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional]
|
|
10
|
-
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional]
|
|
11
|
-
**tokenProvisioningInformation** | [**
|
|
10
|
+
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional]
|
|
11
|
+
**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional]
|
|
12
12
|
**card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional]
|
|
13
13
|
**bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional]
|
|
14
14
|
**tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional]
|
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | The Id of the Instrument Identifier Token. | [optional]
|
|
8
8
|
**_object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional]
|
|
9
9
|
**state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional]
|
|
10
|
-
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional]
|
|
11
|
-
**tokenProvisioningInformation** | [**
|
|
10
|
+
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional]
|
|
11
|
+
**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional]
|
|
12
12
|
**card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional]
|
|
13
13
|
**bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional]
|
|
14
14
|
**tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional]
|
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | The Id of the Instrument Identifier Token. | [optional]
|
|
8
8
|
**_object** | **String** | The type. Possible Values: - instrumentIdentifier | [optional]
|
|
9
9
|
**state** | **String** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional]
|
|
10
|
-
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional]
|
|
11
|
-
**tokenProvisioningInformation** | [**
|
|
10
|
+
**type** | **String** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional]
|
|
11
|
+
**tokenProvisioningInformation** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional]
|
|
12
12
|
**card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional]
|
|
13
13
|
**bankAccount** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional]
|
|
14
14
|
**tokenizedCard** | [**TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional]
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**creditAmount** | **String** | Amount that was credited to the cardholder's account. Returned by PIN debit credit. | [optional]
|
|
7
|
-
**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.
|
|
7
|
+
**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]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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)
|
|
6
|
+
**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]
|
|
7
7
|
|
|
8
8
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**totalAmount** | **String** | Amount you requested for the capture. | [optional]
|
|
7
|
-
**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.
|
|
7
|
+
**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]
|
|
8
8
|
**processorTransactionFee** | **String** | The fee decided by the PSP/Processor per transaction. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
7
|
-
**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.
|
|
6
|
+
**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]
|
|
7
|
+
**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]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
6
|
+
**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]
|
|
7
7
|
**currency** | **String** | Currency used for the order | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**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]
|
|
13
13
|
**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]
|
|
14
14
|
**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]
|
|
15
|
-
**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.
|
|
15
|
+
**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]
|
|
16
16
|
**verificationStatus** | **String** | Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED | [optional]
|
|
17
17
|
|
|
18
18
|
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
6
|
+
**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]
|
|
7
7
|
|
|
8
8
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**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.
|
|
7
|
-
**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.
|
|
8
|
-
**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.
|
|
6
|
+
**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]
|
|
7
|
+
**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]
|
|
8
|
+
**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]
|
|
9
9
|
**personalIdentification** | [**[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional]
|
|
10
10
|
**taxId** | **String** | The description for this field is not available. | [optional]
|
|
11
11
|
**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]
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**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]
|
|
8
8
|
**acsTransactionId** | **String** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional]
|
|
9
9
|
**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]
|
|
10
|
-
**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_.
|
|
10
|
+
**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]
|
|
11
11
|
**authorizationPayload** | **String** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional]
|
|
12
12
|
**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]
|
|
13
13
|
**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
|
|
|
27
27
|
**networkScore** | **String** | The global score calculated by the CB scoring platform and returned to merchants. | [optional]
|
|
28
28
|
**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]
|
|
29
29
|
**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]
|
|
30
|
-
**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.
|
|
30
|
+
**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]
|
|
31
31
|
**proxyPan** | **String** | Encrypted version of the card number used in the payer authentication request message. | [optional]
|
|
32
32
|
**sdkTransactionId** | **String** | SDK unique transaction identifier that is generated on each new transaction. | [optional]
|
|
33
33
|
**signedParesStatusReason** | **String** | Provides additional information as to why the PAResStatus has a specific value. | [optional]
|
|
@@ -36,7 +36,7 @@ Name | Type | Description | Notes
|
|
|
36
36
|
**threeDSServerTransactionId** | **String** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional]
|
|
37
37
|
**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]
|
|
38
38
|
**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]
|
|
39
|
-
**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.
|
|
39
|
+
**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]
|
|
40
40
|
**whiteListStatusSource** | **String** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional]
|
|
41
41
|
**xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional]
|
|
42
42
|
**directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional]
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**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]
|
|
7
|
-
**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase.
|
|
8
|
-
**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.
|
|
7
|
+
**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional]
|
|
8
|
+
**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]
|
|
9
9
|
**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]
|
|
10
10
|
**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]
|
|
11
11
|
**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]
|
|
@@ -11,11 +11,11 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**paymentInstrument** | [**Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional]
|
|
12
12
|
**instrumentIdentifier** | [**PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier**](PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier.md) | | [optional]
|
|
13
13
|
**shippingAddress** | [**Ptsv2paymentsPaymentInformationShippingAddress**](Ptsv2paymentsPaymentInformationShippingAddress.md) | | [optional]
|
|
14
|
-
**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.
|
|
15
|
-
**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.
|
|
16
|
-
**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type.
|
|
17
|
-
**issuer** | **String** | Name of the bank or entity that issued the card account.
|
|
18
|
-
**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.
|
|
14
|
+
**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]
|
|
15
|
+
**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]
|
|
16
|
+
**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional]
|
|
17
|
+
**issuer** | **String** | Name of the bank or entity that issued the card account. | [optional]
|
|
18
|
+
**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]
|
|
19
19
|
**eWallet** | [**PtsV2PaymentsPost201ResponsePaymentInformationEWallet**](PtsV2PaymentsPost201ResponsePaymentInformationEWallet.md) | | [optional]
|
|
20
20
|
|
|
21
21
|
|